SDK JS
    Preparing search index...

    Interface SplatOptions

    Tunable render options for SplatRenderer. Pass a partial set to the constructor or SplatRenderer.setOptions; omitted fields keep their defaults.

    interface SplatOptions {
        colorMode: SplatColorMode;
        heightMax?: number;
        heightMin?: number;
        lowpass: number;
        maxScale: number;
        nSigma: number;
        resortThresholdDeg: number;
        shEnabled: boolean;
    }
    Index

    Properties

    colorMode heightMax? heightMin? lowpass maxScale nSigma resortThresholdDeg shEnabled

    Properties

    colorMode: SplatColorMode

    Color source (default 'original').

    heightMax?: number

    height color-mode ramp maximum (local metres). Omit to auto-fit to the scene's z-range.

    heightMin?: number

    height color-mode ramp minimum (local metres). Omit to auto-fit to the scene's z-range.

    lowpass: number

    Screen-space low-pass dilation, px² (default 0.3).

    maxScale: number

    Floater cull: drop splats whose largest 3D std-dev exceeds this many LOCAL units — the huge near-camera "fog blob" gaussians close-up views suffer from (the tiles3d renderer uses 8 in its metre-native frame). Default Infinity (off): local units vary per capture, so an absolute cutoff is opt-in — set it once you know the asset's scale.

    nSigma: number

    Quad extent in standard deviations (default 3).

    resortThresholdDeg: number

    Re-sort when the view direction turns more than this many degrees.

    shEnabled: boolean

    Enable SH view-dependent color (requires SH data in the tiles).

    Settings

    Member Visibility

    On This Page

    Properties