Class GSplatParams

constructor

• new GSplatParams(device: GraphicsDevice): GSplatParams

  Creates a new GSplatParams instance.

  Parameters

  • device: GraphicsDevice

    The graphics device.

  Returns GSplatParams

colorRampIntensity

colorUpdateAngle

cooldownTicks

lodUpdateAngle

lodUpdateDistance

radialSorting

useFog

alphaClip

• get alphaClip(): number

  Gets the alpha threshold for shadow, pick, and prepass rendering.

  Returns number

• set alphaClip(value: number): void

  Sets the alpha threshold for shadow, pick, and prepass rendering (not the main forward splat pass). Higher values create more aggressive clipping, while lower values preserve more translucent splats. Defaults to 0.3.

  Parameters

  • value: number

  Returns void

alphaClipForward

• get alphaClipForward(): number

  Gets the forward-pass alpha threshold.

  Returns number

• set alphaClipForward(value: number): void

  Sets the alpha threshold below which splats are culled or clipped in the forward splat rendering pass. Does not apply to shadow, pick, or prepass — use GSplatParams#alphaClip for those. Higher values improve performance by culling more low-opacity splats; lower values preserve more translucent splats. Defaults to 1 / 255.

  Parameters

  • value: number

  Returns void

antiAlias

• get antiAlias(): boolean

  Gets whether anti-aliasing compensation is enabled.

  Returns boolean

• set antiAlias(value: boolean): void

  Enables anti-aliasing compensation for Gaussian splats. Defaults to false.

  This option is intended for splat data that was generated with anti-aliasing enabled during training/export. It improves visual stability and reduces flickering for very small or distant splats.

  If the source splats were generated without anti-aliasing, enabling this option may slightly soften the image or alter opacity.

  Parameters

  • value: boolean

  Returns void

colorizeColorUpdate

• get colorizeColorUpdate(): boolean

  Returns boolean

  Whether SH update colorization is enabled.

  Deprecated

  Use debug with GSPLAT_DEBUG_SH_UPDATE instead.

• set colorizeColorUpdate(value: boolean): void

  Parameters

  • value: boolean

  Returns void

  Deprecated

  Use debug with GSPLAT_DEBUG_SH_UPDATE instead.

colorRamp

• get colorRamp(): Texture | null

  Gets the color ramp texture for overdraw visualization.

  Returns Texture | null

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

  • value: Texture | null

  Returns void

currentRenderer

• get currentRenderer(): number

  The current rendering pipeline in effect after platform-based fallback resolution. When renderer is set to a mode requiring WebGPU on a WebGL device, this returns the fallback mode actually being used.

  Returns number

dataFormat

• get dataFormat(): string

  Gets the work buffer data format.

  Returns string

• set dataFormat(value: string): void

  Work buffer data format. Controls the precision and bandwidth of the intermediate work buffer used during unified GSplat rendering. Can be set to GSPLATDATA_COMPACT (20 bytes/splat) or GSPLATDATA_LARGE (32 bytes/splat). Defaults to GSPLATDATA_COMPACT.

  Parameters

  • value: string

  Returns void

debug

• get debug(): number

  Gets the debug rendering mode for Gaussian splats.

  Returns number

• set debug(value: number): void

  Sets the debug rendering mode for Gaussian splats. Can be:

  • GSPLAT_DEBUG_NONE: Normal rendering (default).
  • GSPLAT_DEBUG_LOD: Colorize splats by their selected LOD level.
  • GSPLAT_DEBUG_SH_UPDATE: Random color per SH update pass to visualize update frequency.
  • GSPLAT_DEBUG_HEATMAP: Heatmap visualization of average splats processed per pixel in each tile. Only supported with GSPLAT_RENDERER_COMPUTE.
  • GSPLAT_DEBUG_AABBS: Draw world-space AABBs for each GSplat, colorized by LOD.
  • GSPLAT_DEBUG_NODE_AABBS: Draw world-space AABBs for each octree node of streamed GSplats, colorized by the currently selected LOD.

  Only one debug mode can be active at a time. Defaults to GSPLAT_DEBUG_NONE.

  Parameters

  • value: number

  Returns void

enableIds

• get enableIds(): boolean

  Gets the ID storage enabled state.

  Returns boolean

• set enableIds(value: boolean): void

  Enables or disables per-component ID storage in the work buffer. When enabled, each GSplat component gets a unique ID written to the work buffer. This ID is used by the picking system to identify which component was picked, but is also available to custom shaders for effects like highlighting, animation, or any per-component differentiation.

  Parameters

  • value: boolean

  Returns void

fisheye

• get fisheye(): number

  Gets the fisheye projection strength.

  Returns number

• set fisheye(value: number): void

  Controls the fisheye projection strength for Gaussian splats. The value is in the range [0, 1]:

  • 0: Standard rectilinear (perspective) projection.
  • (0, 1]: Increasing barrel distortion, producing a wider field of view with a "little planet" effect at higher values.

  Enabling fisheye for the first time has a small one-off cost as new shaders are compiled. Subsequent switches between 0 and non-zero are instantaneous.

  Only supported with perspective cameras. Has no effect with orthographic projection.

  Note: This only affects Gaussian splat rendering. Other objects in the scene (meshes, sprites, etc.) continue to use the standard camera projection and are not distorted.

  For best results, enable radialSorting when using fisheye projection to avoid sorting artifacts caused by the wide field of view.

  Defaults to 0.

  Parameters

  • value: number

  Returns void

format

• get format(): GSplatFormat

  Format descriptor for work buffer streams. Describes the textures used by the work buffer for intermediate storage during unified rendering. Users can add extra streams via GSplatFormat#addExtraStreams for custom per-splat data.

  Returns GSplatFormat

  Example

  // Add a custom stream to store per-splat component IDs
  app.scene.gsplat.format.addExtraStreams([{
      name: 'splatId',
      format: pc.PIXELFORMAT_R32U
  }]);
  Copy

lodBehindPenalty

• 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 lodUpdateAngle so LOD is re-evaluated on camera rotation, not just translation.

  Parameters

  • value: number

  Returns void

lodRangeMax

• get lodRangeMax(): number

  Gets maximum allowed LOD index (inclusive).

  Returns number

• set lodRangeMax(value: number): void

  Maximum allowed LOD index (inclusive). Defaults to 10.

  Parameters

  • value: number

  Returns void

lodRangeMin

• get lodRangeMin(): number

  Gets minimum allowed LOD index (inclusive).

  Returns number

• set lodRangeMin(value: number): void

  Minimum allowed LOD index (inclusive). Defaults to 0.

  Parameters

  • value: number

  Returns void

lodUnderfillLimit

• 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

material

• get material(): ShaderMaterial

  A material template that can be customized by the user. Any defines, parameters, or shader chunks set on this material will be automatically applied to all GSplat components rendered in unified mode. After making changes, call Material#update to for the changes to be applied on the next frame.

  Returns ShaderMaterial

  Example

  // Set a custom parameter on all GSplat materials
  app.scene.gsplat.material.setParameter('myCustomParam', 1.0);
  app.scene.gsplat.material.update();
  Copy

minContribution

• get minContribution(): number

  Gets the minimum contribution threshold.

  Returns number

• set minContribution(value: number): void

  Sets the minimum visual contribution threshold for the GSPLAT_RENDERER_COMPUTE renderer. Splats whose total screen contribution (opacity * projected area) falls below this value are discarded. Higher values cull more aggressively, improving performance at the cost of quality. Set to 0 to disable contribution culling. Defaults to 3.

  Parameters

  • value: number

  Returns void

minPixelSize

• get minPixelSize(): number

  Gets the minimum pixel size threshold.

  Returns number

• set minPixelSize(value: number): void

  Sets the minimum screen-space pixel size below which splats are discarded. Defaults to 2.

  Parameters

  • value: number

  Returns void

renderer

• get renderer(): number

  Gets the requested rendering pipeline for gaussian splatting. This may differ from currentRenderer when a WebGPU mode falls back on a WebGL device.

  Returns number

• set renderer(value: number): void

  Sets the rendering pipeline used for gaussian splatting. Can be:

  • GSPLAT_RENDERER_AUTO: Automatically selects the best pipeline for the platform.
  • GSPLAT_RENDERER_RASTER_CPU_SORT: Rasterization with CPU-side sorting.
  • GSPLAT_RENDERER_COMPUTE: Full compute pipeline (WebGPU only, experimental).
  • GSPLAT_RENDERER_RASTER_GPU_SORT: Rasterization with GPU-side sorting (WebGPU only, experimental).

  Defaults to GSPLAT_RENDERER_AUTO. Modes requiring WebGPU fall back to GSPLAT_RENDERER_RASTER_CPU_SORT on WebGL devices. The resolved mode actually used can be queried via currentRenderer.

  Parameters

  • value: number

  Returns void

splatBudget

• get splatBudget(): number

  Gets the target number of splats across all GSplats in the scene.

  Returns number

• set splatBudget(value: number): void

  Target number of splats across all GSplats in the scene. When set > 0, the system adjusts LOD levels globally to stay within this budget. Set to 0 to disable budget enforcement and use LOD distances only (default).

  Parameters

  • value: number

  Returns void

twoDimensional

• get twoDimensional(): boolean

  Gets whether 2D Gaussian Splatting mode is enabled.

  Returns boolean

• set twoDimensional(value: boolean): void

  Enables 2D Gaussian Splatting mode. Defaults to false.

  Renders splats as oriented 2D surface elements instead of volumetric 3D Gaussians. This provides a more surface-accurate appearance but requires splat data that was generated for 2D Gaussian Splatting.

  Enabling this with standard 3D splat data may produce incorrect results.

  Parameters

  • value: boolean

  Returns void