@pixi/3d
    Preparing search index...

    Interface MaterialDataAdvanced

    A material's GPU-side values, as material.data, with a property per field its bits declare

    • Scalars read and write as numbers.
    • Vectors read as live Float32Array views and are set by copying from any array-like no longer than the field; a longer one throws. Writing into a view queues no upload, so call material.update() afterwards.
    • Assigning a field queues an upload; repeat writes in one frame upload once.

    A material with fixed fields narrows the type, as Material3DData does.

    interface MaterialData {
        alphaCutoff?: number;
        baseColor?: Float32Array<ArrayBufferLike>;
        displayBaseColor?: Float32Array<ArrayBufferLike>;
        uvOffset?: Float32Array<ArrayBufferLike>;
        uvTransformRow0?: Float32Array<ArrayBufferLike>;
        [field: string]: number | ArrayLike<number> | undefined;
    }

    Hierarchy (View Summary)

    Indexable

    • [field: string]: number | ArrayLike<number> | undefined

      Any other field the struct declares

    Index
    alphaCutoff? baseColor? displayBaseColor? uvOffset? uvTransformRow0?
    alphaCutoff?: number

    Cutoff for alphaMode: 'mask'; absent when the struct doesn't declare it

    baseColor?: Float32Array<ArrayBufferLike>

    Base colour in linear light, alpha in the last lane; absent when the struct doesn't declare it

    Set material.baseColor and material.alpha instead, which keep displayBaseColor in step.

    displayBaseColor?: Float32Array<ArrayBufferLike>

    Base colour in display space, alpha in the last lane, for unlit bits; absent when not declared

    uvOffset?: Float32Array<ArrayBufferLike>

    The UV transform's offset; absent when the struct doesn't declare it

    uvTransformRow0?: Float32Array<ArrayBufferLike>

    The UV transform's 2x2 part, row-major as [m00, m01, m10, m11]; absent when the struct doesn't declare it

    Settings
    Member Visibility

    On This Page
    Properties