@pmndrs/bvh
    Preparing search index...

    Interface GpuTopLevelInstance

    One instance in the GPU top level.

    interface GpuTopLevelInstance {
        contributesToGi?: boolean;
        instanceIndex: number;
        mask?: number;
        material?: number;
        merged?: boolean;
        meshSlot: number;
        objectToWorld: Mat4;
        visible?: boolean;
    }
    Index
    contributesToGi? instanceIndex mask? material? merged? meshSlot objectToWorld visible?
    contributesToGi?: boolean

    Default true.

    instanceIndex: number

    Returned in BvhHit.instance. Ignored (0xffffffff) for a merged record.

    mask?: number

    Instance mask, 0-255; default 0xff (every ray).

    material?: number

    Material index, 0-65534 (MAX_MATERIAL), stored as materialCode (material + 1) in flags bits 16-31. Default none. A merged record can't have one.

    merged?: boolean

    A merged static group's record: identity transform, never moves.

    meshSlot: number

    The mesh slot its tree is placed under (GpuTopLevel.setMeshTree).

    objectToWorld: Mat4

    Object-to-world, column-major 4x4.

    visible?: boolean

    Default true.

    Settings
    Member Visibility

    On This Page
    Properties