Documentation
    Preparing search index...

    Interface LitMaterialOptions

    Construction arguments of LitMaterial — its own colour, plus §57's shared render state from MaterialOptions.

    interface LitMaterialOptions {
        blendMode?: BlendMode;
        color?: readonly [number, number, number, number];
        colorWrite?: boolean;
        depthTest?: boolean;
        depthWrite?: boolean;
        map?: MaterialTexture | null;
        opacity?: number;
        stencil?: StencilState;
        transparent?: boolean;
    }

    Hierarchy (View Summary)

    Index
    blendMode? color? colorWrite? depthTest? depthWrite? map? opacity? stencil? transparent?
    blendMode?: BlendMode

    Initial Material.blendMode; defaults to "normal".

    color?: readonly [number, number, number, number]

    Initial color, copied into the material's own array. Defaults to opaque white [1, 1, 1, 1], so an untinted material shows the lighting alone.

    colorWrite?: boolean

    Initial Material.colorWrite; defaults to true.

    depthTest?: boolean

    Initial Material.depthTest; defaults to true.

    depthWrite?: boolean

    Initial Material.depthWrite; defaults to true.

    map?: MaterialTexture | null

    Initial LitMaterial.map — the albedo texture sampled with the geometry's uvs (§53, §77). Defaults to null.

    opacity?: number

    Initial Material.opacity; defaults to 1 (fully opaque).

    stencil?: StencilState

    Initial Material.stencil; defaults to undefined (no stencil test). A StencilState, which validates itself at construction.

    transparent?: boolean

    Initial Material.transparent; defaults to false.

    Settings
    Member Visibility

    On This Page
    Properties