@pmndrs/bvh
    Preparing search index...

    Interface TraceSceneInstance

    One placed copy of one of the meshes passed to assembleTraceScene.

    interface TraceSceneInstance {
        contributesToGi?: boolean;
        instanceIndex: number;
        mask?: number;
        material?: number;
        meshIndex: number;
        objectToWorld: Mat4;
        static?: boolean;
        visible?: boolean;
    }
    Index
    contributesToGi? instanceIndex mask? material? meshIndex objectToWorld static? visible?
    contributesToGi?: boolean
    instanceIndex: number

    The platform instance index, returned in BvhHit.instance.

    mask?: number

    The instance mask, 0-255; defaults to 0xff, visible to every ray (see TraceInstance.mask).

    material?: number

    The material index (0-65534), reported as BvhHit.material; omit for none (NO_MATERIAL). Not a merge-grouping key: a merged instance's material travels in its triangles' flags (see TraceInstance.material).

    meshIndex: number

    Position in the meshes array.

    objectToWorld: Mat4
    static?: boolean

    The instance never moves. With mergeStaticInstances on (the default in buildTraceScene), a static instance whose mesh no other instance uses is merged into a world-space mesh with others of the same flags and mask (static-merge.ts). Ignored otherwise. Default false.

    visible?: boolean

    Settings
    Member Visibility

    On This Page
    Properties