Hilo3d API - v2.0.0-alpha.3
    Preparing search index...

    Class MaterialInstance

    Mutable material data bound to one immutable MaterialDefinition.

    Ordinary parameter and texture changes advance revision but never alter the definition, resource layout, supported pass roles or shader topology. A topology change requires a new instance created with another definition.

    Hierarchy (View Summary)

    Index
    attributes: MaterialBindingMap = {}
    className: string = 'MaterialInstance'
    compositing: MaterialCompositing
    definition: MaterialDefinition
    id: string
    isMaterialInstance: true
    materialId: number
    name: string | null
    uniformBlocks: Record<string, UniformBuffer> = {}
    uniforms: MaterialBindingMap = {}
    userData: unknown
    • get forwardQueue(): "transparent" | "opaque"

      Forward renderer queue selected from compositing and pass resource dependencies.

      An unblended transmission surface remains compositionally opaque, but it must execute after the opaque scene copy exists and therefore belongs to the transparent/after-opaque queue.

      Returns "transparent" | "opaque"

    • get isTransparent(): boolean

      Whether the forward pass composites this surface with an existing color attachment.

      Returns boolean

    • get requiresOpaqueSceneTexture(): boolean

      Whether the forward shader samples the opaque scene-color copy.

      Returns boolean

    • Advance the data revision after mutating a referenced vector, color, matrix, or custom binding value. Texture-slot and built-in scalar accessors call this automatically.

      Returns void