Strata - v1.4.10
    Preparing search index...

    Interface InstancingOptions

    Options for creating an instanced mesh.

    interface InstancingOptions {
        castShadow?: boolean;
        count: number;
        enableWind?: boolean;
        frustumCulled?: boolean;
        geometry: BufferGeometry;
        instances: InstanceData[];
        lodDistance?: number;
        material: Material;
        receiveShadow?: boolean;
        windStrength?: number;
    }
    Index

    Properties

    castShadow? count enableWind? frustumCulled? geometry instances lodDistance? material receiveShadow? windStrength?

    Properties

    castShadow?: boolean

    Whether instances cast shadows. Default: true.

    count: number

    Maximum number of instances to render.

    enableWind?: boolean

    Whether to enable GPU wind animation (requires compatible shader). Default: true.

    frustumCulled?: boolean

    Whether to enable frustum culling. Default: true.

    geometry: BufferGeometry

    The base geometry to instance.

    instances: InstanceData[]

    Array of instance transform data.

    lodDistance?: number

    Distance at which LOD transitions occur in world units.

    material: Material

    The material to use for all instances.

    receiveShadow?: boolean

    Whether instances receive shadows. Default: true.

    windStrength?: number

    Strength of wind animation. Default: 0.5.

    Settings

    Member Visibility

    On This Page

    Properties