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

    Class GSplatParams

    Parameters for GSplat unified system.

    Index

    Properties

    colorizeColorUpdate: boolean = false

    Enables debug colorization to visualize when spherical harmonics are evaluated. When true, each update pass renders with a random color to visualize the behavior of colorUpdateDistance and colorUpdateAngle thresholds. Defaults to false.

    colorRampIntensity: number = 1

    Intensity multiplier for overdraw visualization mode. Value of 1 uses alpha of 1/32, allowing approximately 32 overdraws to reach full brightness with additive blending. Higher values increase brightness per splat. Defaults to 1.

    colorUpdateAngle: number = 2

    Angle threshold in degrees for triggering spherical harmonics color updates. Used to control how often SH evaluation occurs based on camera rotation. Only affects resources with spherical harmonics data. Set to 0 to update on every frame where camera rotates. Defaults to 2.

    colorUpdateAngleLodScale: number = 2

    Scale factor applied to colorUpdateAngle for each LOD level. Each LOD level multiplies the threshold by this value raised to the power of lodIndex. For example, with scale=2: LOD 0 uses 1x threshold, LOD 1 uses 2x, LOD 2 uses 4x. Higher values relax thresholds more aggressively for distant geometry. Defaults to 2.

    colorUpdateDistance: number = 0.2

    Distance threshold in world units for triggering spherical harmonics color updates. Used to control how often SH evaluation occurs based on camera translation. Only affects resources with spherical harmonics data. Set to 0 to update on every frame where camera moves. Defaults to 0.2.

    colorUpdateDistanceLodScale: number = 2

    Scale factor applied to colorUpdateDistance for each LOD level. Each LOD level multiplies the threshold by this value raised to the power of lodIndex. For example, with scale=2: LOD 0 uses 1x threshold, LOD 1 uses 2x, LOD 2 uses 4x. Higher values relax thresholds more aggressively for distant geometry. Defaults to 2.

    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 colorRamp(): null | Texture

      Gets the color ramp texture for overdraw visualization.

      Returns null | Texture

    • set colorRamp(value: null | Texture): void

      Gradient texture for elevation-based coloring in overdraw visualization mode. When set, enables overdraw mode with additive blending. When null, uses normal rendering. Texture should be (width x 1) size. World Y coordinate (0-20 range) maps to texture U coordinate. Defaults to null.

      Parameters

      Returns void

    • 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