Skip to main content

Class: SplatsOptions

Defined in: src/splats/SplatsOptions.ts:11

Configuration options for 3D Gaussian Splatting (@sparkjsdev/radix) on THREE.WebGPURenderer (covering both native WebGPU and its WebGL2 fallback).

Constructors​

Constructor​

new SplatsOptions(options?): SplatsOptions

Defined in: src/splats/SplatsOptions.ts:63

Parameters​

options?​
enable?​

(options?) => this

enabled?​

boolean = false

Whether the Radix splats configuration was explicitly enabled.

maxPixelRadius?​

number

Optional maximum screen-space Gaussian radius in pixels.

maxShDegree?​

number

Optional maximum Spherical Harmonics degree (0–4).

maxStdDev?​

number = ...

Gaussian cutoff in standard deviations (defaults to Math.sqrt(4) = 2.0 to bound stereo alpha-blending overdraw on mobile XR GPUs; Radix's upstream desktop default is Math.sqrt(8)).

method?​

RadixProjectionMethod = 'ewa'

Splat projection method used by Radix's SplatRenderer.

minAlpha?​

number = ...

Minimum splat/fragment alpha threshold (0–1). Culls near-invisible splats before sorting and tightens per-splat screen-space quad bounds (sqrt(2 * ln(alpha / minAlpha))). Defaults to 5 / 255 (~0.02).

minContribution?​

number

Optional minimum integrated 2D screen contribution (opacity * 2π * sqrt(det(cov2D)) in pixel²·alpha) required to sort and draw a splat.

minPixelRadius?​

number

Optional minimum screen-space Gaussian radius in pixels.

renderOrder?​

number = -1

Render order assigned to the shared SplatRenderer mesh in the scene.

sortBits?​

RadixSortBits = 16

Sort key width in bits (16, 24, or 32). Defaults to 16 (65,536 depth buckets, executing 2 GPU radix-sort passes instead of 3–4 to keep stereo XR command encoding and compute time within a single 72/90 Hz vsync).

sortWorkers?​

number

Number of background workers in Radix's shared CPU sort pool when WebGPURenderer runs on its WebGL2 fallback backend (forceWebGL: true).

Returns​

SplatsOptions

Properties​

enabled​

enabled: boolean = false

Defined in: src/splats/SplatsOptions.ts:13

Whether the Radix splats configuration was explicitly enabled.


maxPixelRadius?​

optional maxPixelRadius: number

Defined in: src/splats/SplatsOptions.ts:49

Optional maximum screen-space Gaussian radius in pixels.


maxShDegree?​

optional maxShDegree: number

Defined in: src/splats/SplatsOptions.ts:52

Optional maximum Spherical Harmonics degree (0–4).


maxStdDev?​

optional maxStdDev: number

Defined in: src/splats/SplatsOptions.ts:30

Gaussian cutoff in standard deviations (defaults to Math.sqrt(4) = 2.0 to bound stereo alpha-blending overdraw on mobile XR GPUs; Radix's upstream desktop default is Math.sqrt(8)).


method​

method: RadixProjectionMethod = 'ewa'

Defined in: src/splats/SplatsOptions.ts:16

Splat projection method used by Radix's SplatRenderer.


minAlpha?​

optional minAlpha: number

Defined in: src/splats/SplatsOptions.ts:37

Minimum splat/fragment alpha threshold (0–1). Culls near-invisible splats before sorting and tightens per-splat screen-space quad bounds (sqrt(2 * ln(alpha / minAlpha))). Defaults to 5 / 255 (~0.02).


minContribution?​

optional minContribution: number

Defined in: src/splats/SplatsOptions.ts:43

Optional minimum integrated 2D screen contribution (opacity * 2π * sqrt(det(cov2D)) in pixel²·alpha) required to sort and draw a splat.


minPixelRadius?​

optional minPixelRadius: number

Defined in: src/splats/SplatsOptions.ts:46

Optional minimum screen-space Gaussian radius in pixels.


renderOrder​

renderOrder: number = -1

Defined in: src/splats/SplatsOptions.ts:55

Render order assigned to the shared SplatRenderer mesh in the scene.


sortBits​

sortBits: RadixSortBits = 16

Defined in: src/splats/SplatsOptions.ts:23

Sort key width in bits (16, 24, or 32). Defaults to 16 (65,536 depth buckets, executing 2 GPU radix-sort passes instead of 3–4 to keep stereo XR command encoding and compute time within a single 72/90 Hz vsync).


sortWorkers?​

optional sortWorkers: number

Defined in: src/splats/SplatsOptions.ts:61

Number of background workers in Radix's shared CPU sort pool when WebGPURenderer runs on its WebGL2 fallback backend (forceWebGL: true).

Methods​

enable()​

enable(options?): this

Defined in: src/splats/SplatsOptions.ts:70

Enables Radix splat configuration and merges optional overrides.

Parameters​

options?​
enable?​

(options?) => this

enabled?​

boolean = false

Whether the Radix splats configuration was explicitly enabled.

maxPixelRadius?​

number

Optional maximum screen-space Gaussian radius in pixels.

maxShDegree?​

number

Optional maximum Spherical Harmonics degree (0–4).

maxStdDev?​

number = ...

Gaussian cutoff in standard deviations (defaults to Math.sqrt(4) = 2.0 to bound stereo alpha-blending overdraw on mobile XR GPUs; Radix's upstream desktop default is Math.sqrt(8)).

method?​

RadixProjectionMethod = 'ewa'

Splat projection method used by Radix's SplatRenderer.

minAlpha?​

number = ...

Minimum splat/fragment alpha threshold (0–1). Culls near-invisible splats before sorting and tightens per-splat screen-space quad bounds (sqrt(2 * ln(alpha / minAlpha))). Defaults to 5 / 255 (~0.02).

minContribution?​

number

Optional minimum integrated 2D screen contribution (opacity * 2π * sqrt(det(cov2D)) in pixel²·alpha) required to sort and draw a splat.

minPixelRadius?​

number

Optional minimum screen-space Gaussian radius in pixels.

renderOrder?​

number = -1

Render order assigned to the shared SplatRenderer mesh in the scene.

sortBits?​

RadixSortBits = 16

Sort key width in bits (16, 24, or 32). Defaults to 16 (65,536 depth buckets, executing 2 GPU radix-sort passes instead of 3–4 to keep stereo XR command encoding and compute time within a single 72/90 Hz vsync).

sortWorkers?​

number

Number of background workers in Radix's shared CPU sort pool when WebGPURenderer runs on its WebGL2 fallback backend (forceWebGL: true).

Returns​

this