Engine API Reference - v2.12.2
    Preparing search index...

    Class GSplatParams

    Parameters for GSplat unified system.

    Index

    Properties

    debugAabbs: boolean = false

    Enables debug rendering of AABBs for GSplat objects. Defaults to false.

    debugNodeAabbs: boolean = false

    Enables debug rendering of AABBs for GSplat octree nodes. Defaults to false.

    lodUpdateAngle: number = 0

    Angle threshold in degrees to trigger LOD updates based on camera rotation. Set to 0 to disable rotation-based updates. Defaults to 0.

    lodUpdateDistance: number = 1

    Distance threshold in world units to trigger LOD updates for camera and gsplat instances. Defaults to 1.

    radialSorting: boolean = false

    Enables radial sorting based on distance from camera (for cubemap rendering). When false, uses directional sorting along camera forward vector. Defaults to false.

    Note: Radial sorting helps reduce sorting artifacts when the camera rotates (looks around), while linear sorting is better at minimizing artifacts when the camera translates (moves).

    Accessors

    • get lodBehindPenalty(): number

      Gets behind-camera LOD penalty multiplier.

      Returns number

    • set lodBehindPenalty(value: number): void

      Multiplier applied to effective distance for nodes behind the camera when determining LOD. Value 1 means no penalty; higher values drop LOD faster for nodes behind the camera.

      Note: when using a penalty > 1, it often makes sense to set a positive GSplatParams#lodUpdateAngle so LOD is re-evaluated on camera rotation, not just translation.

      Parameters

      • value: number

      Returns void

    • get lodUnderfillLimit(): number

      Gets the maximum allowed underfill LOD range.

      Returns number

    • set lodUnderfillLimit(value: number): void

      Maximum number of LOD levels allowed below the optimal level when the optimal data is not resident in memory. The system may temporarily use a coarser LOD within this limit until the optimal LOD is available. Defaults to 0, which disables fallback (always load optimal). Higher values allow faster loading by using lower-quality data.

      Parameters

      • value: number

      Returns void