Taos API Reference
    Preparing search index...

    Interface ClusterCullParams

    Per-frame cull parameters for ClusterCullPass.updateParams.

    interface ClusterCullParams {
        model: Mat4;
        viewProj: Mat4;
        camWorldPos: Vec3;
        cull?: boolean;
        occlusion?: boolean;
        hizWidth?: number;
        hizHeight?: number;
        mipCount?: number;
        reversedZ?: boolean;
        coneCull?: boolean;
        shadowFrustum?: boolean;
        lod?: boolean;
        lodProjScale?: number;
        lodThreshold?: number;
        lodNear?: number;
    }
    Index

    Properties

    model viewProj camWorldPos cull? occlusion? hizWidth? hizHeight? mipCount? reversedZ? coneCull? shadowFrustum? lod? lodProjScale? lodThreshold? lodNear?

    Properties

    model: Mat4

    Model matrix of the clustered mesh.

    viewProj: Mat4

    Un-jittered camera view-projection.

    camWorldPos: Vec3

    Camera world position (transformed to model space for the cone test).

    cull?: boolean

    Master enable for frustum + cone culling (default true).

    occlusion?: boolean

    Enable Hi-Z occlusion (requires a hiz dep + valid mip info; default false).

    hizWidth?: number

    Hi-Z mip-0 size and mip count (from HiZPass); mipCount 0 disables occlusion.

    hizHeight?: number
    mipCount?: number
    reversedZ?: boolean

    Defaults to the context's reversed-Z setting.

    coneCull?: boolean

    Normal-cone backface culling (default true). Turn OFF for shadow views — back-facing clusters still cast shadows.

    shadowFrustum?: boolean

    Skip the frustum near plane (default false). Enable for directional-shadow ortho views so casters in front of the cascade box aren't wrongly dropped.

    lod?: boolean

    Enable continuous-LOD cut selection (requires a DAG mesh with a lodBuffer).

    lodProjScale?: number

    Projection scale = viewportHeight / (2·tan(fovY/2)); converts world error → pixels.

    lodThreshold?: number

    Screen-space error threshold in pixels (smaller = more detail). Default 1.

    lodNear?: number

    Near distance clamp for the projection (default 0.05).

    Settings

    Member Visibility

    On This Page

    Properties