gaussian-splat-lite 1.3.2 → 1.4.1

package/docs/StochasticRendering.md

@@ -2,9 +2,9 @@
 
 [Back to documentation](../README.md#documentation)
 
-Stochastic rendering is an optional way for `GaussianSplatRenderer` to draw transparency. It produces visible noise, so pair it with temporal anti-aliasing (TAA) or the experimental neural denoiser to get a smooth image. Sorted alpha blending remains the default.
+Stochastic rendering is an optional way for `GaussianSplatRenderer` to draw transparency. It produces visible noise, so pair it with the experimental neural denoiser to get a smooth image. Sorted alpha blending remains the default.
 
-Stochastic rendering works on WebGPU, WebGL2, and `WebGPURenderer`'s WebGL2 fallback, including WebXR. The smoothing options below do not support WebXR.
+Stochastic rendering works on WebGPU, WebGL2, and `WebGPURenderer`'s WebGL2 fallback, including WebXR. For immersive rendering, use [NeuralDenoiseXR](NeuralDenoiseNode.md#webxr).
 
 ## Turn it on
 
@@ -24,21 +24,21 @@ Both can be changed at any time. While stochastic rendering is active, Splats ar
 
 ## Smooth the noise
 
-Use [`TAANode`](TAAPass.md#taanode-webgpurenderer) with `WebGPURenderer`, or [`TAAPass`](TAAPass.md#taapass-webglrenderer) with `WebGLRenderer`. The [experimental neural denoiser](NeuralDenoiseNode.md) is an alternative for scenes with moving objects on all three backends. The library does not turn any of them on for you. The examples assume an existing `renderer`, `scene`, `camera`, and `splatRenderer`, with one camera outside WebXR.
+Use [`NeuralDenoiseNode`](NeuralDenoiseNode.md#webgpurenderer-neuraldenoisenode) with `WebGPURenderer`, or [`NeuralDenoisePass`](NeuralDenoiseNode.md#webglrenderer-neuraldenoisepass) with `WebGLRenderer`. The library does not turn denoising on for you. The examples assume an existing `renderer`, `scene`, `camera`, and `splatRenderer`, with one camera outside WebXR.
 
-### WebGPURenderer: TAANode
+### WebGPURenderer: NeuralDenoiseNode
 
 Use this on both WebGPU and the WebGL2 fallback, after `await renderer.init()`:
 
 ```js
-import { TAANode } from "gaussian-splat-lite";
+import { NeuralDenoiseNode } from "gaussian-splat-lite";
 import { RenderPipeline } from "three/webgpu";
 
 splatRenderer.stochastic = true;
 
-const taa = new TAANode(scene, camera);
-// Chain Bloom or other effects from taa here.
-const pipeline = new RenderPipeline(renderer, taa);
+const denoise = new NeuralDenoiseNode(scene, camera);
+// Chain Bloom or other effects from denoise here.
+const pipeline = new RenderPipeline(renderer, denoise);
 
 renderer.setAnimationLoop(() => {
   // Update controls / animation here.
@@ -46,31 +46,20 @@ renderer.setAnimationLoop(() => {
 });
 ```
 
-### WebGPURenderer: NeuralDenoiseNode
-
-To help reduce trails behind moving objects, replace `TAANode` in the setup above with `NeuralDenoiseNode`:
-
-```js
-import { NeuralDenoiseNode } from "gaussian-splat-lite";
-
-const denoise = new NeuralDenoiseNode(scene, camera);
-const pipeline = new RenderPipeline(renderer, denoise);
-```
-
-It also supports the WebGL2 fallback. See [Neural denoising](NeuralDenoiseNode.md) for modes, MSAA and WebGL2 requirements.
+See [Neural denoising](NeuralDenoiseNode.md) for modes, MSAA and WebGL2 requirements.
 
-### WebGLRenderer: TAAPass
+### WebGLRenderer: NeuralDenoisePass
 
 ```js
-import { TAAPass } from "gaussian-splat-lite";
+import { NeuralDenoisePass } from "gaussian-splat-lite";
 import { EffectComposer } from "three/addons/postprocessing/EffectComposer.js";
 import { OutputPass } from "three/addons/postprocessing/OutputPass.js";
 
 splatRenderer.stochastic = true;
 
-const taa = new TAAPass(scene, camera);
+const denoise = new NeuralDenoisePass(scene, camera);
 const composer = new EffectComposer(renderer);
-composer.addPass(taa);
+composer.addPass(denoise);
 // Insert Bloom or other effects here.
 composer.addPass(new OutputPass());
 
@@ -80,31 +69,20 @@ renderer.setAnimationLoop(() => {
 });
 ```
 
-`TAAPass` takes the place of `RenderPass`. On resize, call `composer.setSize(width, height)` along with the renderer.
-
-### WebGLRenderer: NeuralDenoisePass
-
-Replace `TAAPass` in the composer setup above with `NeuralDenoisePass`, keeping `OutputPass` after it:
-
-```js
-import { NeuralDenoisePass } from "gaussian-splat-lite";
-
-const denoise = new NeuralDenoisePass(scene, camera);
-composer.addPass(denoise);
-```
+`NeuralDenoisePass` takes the place of `RenderPass`. On resize, call `composer.setSize(width, height)` along with the renderer.
 
 It has the same options and requirements as `NeuralDenoiseNode` on WebGL2.
 
-### With any of these
+### History and on-demand rendering
 
-- Call `reset()` after a camera cut or a scene replacement. With TAA, also call it after an abrupt change to an object: TAA follows camera movement, not moving objects.
+- Call `reset()` after a camera cut or a scene replacement.
 - With on-demand rendering, keep rendering for several frames after the camera, a model, or streamed content changes, and after the Splat renderer's `onDirty` callback, so the noise can settle.
 
-See [TAAPass and TAANode](TAAPass.md) and [Neural denoising](NeuralDenoiseNode.md) for effects, depth, color, and cleanup.
+See [Neural denoising](NeuralDenoiseNode.md) for effects, depth, color, and cleanup.
 
 ## Control the noise pattern
 
-The noise pattern changes on every render so TAA or neural denoising can smooth it over time. To keep it fixed, or to control it from your own render loop:
+The noise pattern changes on every render so neural denoising can smooth it over time. To keep it fixed, or to control it from your own render loop:
 
 ```js
 splatRenderer.autoAdvanceStochasticSample = false;
@@ -119,11 +97,11 @@ When you advance it yourself, increase it by one for each render of the scene. T
 splatRenderer.stochastic = false;
 ```
 
-The switch, in either direction, takes effect on a later frame rather than immediately. `stochasticActive` tells you which mode is being drawn; keep your TAA or neural denoiser running until it is `false`. With `autoUpdate = false`, update before drawing:
+The switch, in either direction, takes effect on a later frame rather than immediately. `stochasticActive` tells you which mode is being drawn; keep your neural denoiser running until it is `false`. With `autoUpdate = false`, update before drawing:
 
 ```js
 await splatRenderer.update({ scene, camera });
 renderer.render(scene, camera);
 ```
 
-If you keep TAA or neural denoising running with sorted rendering, set `splatRenderer.depthWrite = true` so it can use the Splats' depth.
+If you keep neural denoising running with sorted rendering, set `splatRenderer.depthWrite = true` so it can use the Splats' depth.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gaussian-splat-lite",
-  "version": "1.3.2",
+  "version": "1.4.1",
   "description": "Three.js Gaussian Splatting renderer with WebGPU/WebGL2, GPU sorting, streaming LOD, and high-precision GIS/ECEF support. Supports PLY, SPZ, SOG and RAD.",
   "author": "William Liu <lyz15972107087@gmail.com>",
   "type": "module",
@@ -8,6 +8,9 @@
   "main": "./dist/gaussian-splat-lite.cjs",
   "module": "./dist/gaussian-splat-lite.module.js",
   "types": "./dist/types/index.d.mts",
+  "bin": {
+    "gsl-build-lod": "./bin/build-lod.js"
+  },
   "exports": {
     ".": {
       "import": {
@@ -27,9 +30,11 @@
     "build:site": "vite build --config vite.site.config.js",
     "build:types": "node scripts/check-declarations.js && node scripts/build-types.js",
     "build:wasm": "node rust/build_wasm.js",
+    "build:wasm:lod": "node rust/build_wasm.js --lod",
+    "build-lod": "node bin/build-lod.js",
     "check": "node scripts/check-js.js && tsc --noEmit && node scripts/check-declarations.js",
     "check:rust": "cargo fmt --manifest-path rust/Cargo.toml --all -- --check",
-    "clean": "rm -rf dist/ node_modules/ rust/target/ rust/gaussian-splat-rs/pkg/",
+    "clean": "rm -rf dist/ bin/decoder/ node_modules/ rust/target/ rust/gaussian-splat-rs/pkg/",
     "dev": "vite --config vite.site.config.js --host",
     "format": "biome format .",
     "format:fix": "biome format . --fix",
@@ -44,6 +49,7 @@
     "test:rust": "cargo test --manifest-path rust/Cargo.toml --workspace --locked"
   },
   "files": [
+    "bin",
     "dist",
     "docs",
     "CHANGELOG.md",
@@ -76,7 +82,7 @@
     "publint": "0.3.24",
     "three": "0.186.0",
     "typescript": "^5.7.3",
-    "vite": "^6.0.11",
+    "vite": "^6.4.4",
     "vite-plugin-arraybuffer": "^0.1.4",
     "vite-plugin-glsl": "^1.3.1"
   },

package/dist/types/addons/TAANode.d.cts

@@ -1,49 +0,0 @@
-import type {
-  DepthTexture,
-  Matrix4,
-  OrthographicCamera,
-  PerspectiveCamera,
-  Scene,
-} from "three";
-import { Node, type NodeBuilder, type NodeFrame } from "three/webgpu";
-/** Camera/depth TAA for WebGPURenderer, including its WebGL2 fallback. */
-export declare class TAANode extends Node<"vec4"> {
-  scene: Scene;
-  camera: PerspectiveCamera | OrthographicCamera;
-  readonly msaa: boolean;
-  private readonly coverage;
-  static get type(): string;
-  depthThreshold: number;
-  edgeDepthDiff: number;
-  maxMotionLength: number;
-  useSubpixelCorrection: boolean;
-  private readonly source;
-  private readonly history;
-  private readonly historyColor;
-  private readonly historyDepth;
-  private readonly textureNode;
-  private readonly material;
-  private readonly quad;
-  private readonly state;
-  private readonly zeroToOne;
-  private readonly drawingSize;
-  private workingColorSpace;
-  private readonly pipelineStates;
-  private pipelineRendering;
-  private capturePending;
-  /** @param msaa Enable 4× MSAA (default false). Fixed for the node's lifetime. */
-  constructor(
-    scene: Scene,
-    camera: PerspectiveCamera | OrthographicCamera,
-    msaa?: boolean,
-  );
-  private makeTarget;
-  get depthTexture(): DepthTexture;
-  get projectionMatrix(): Matrix4;
-  getTextureNode(): import("three/webgpu").TextureNode;
-  setSize(width: number, height: number): void;
-  reset(): void;
-  updateBefore(frame: NodeFrame): undefined;
-  setup(builder: NodeBuilder): import("three/webgpu").TextureNode;
-  dispose(): void;
-}

package/dist/types/addons/TAANode.d.ts

@@ -1,49 +0,0 @@
-import type {
-  DepthTexture,
-  Matrix4,
-  OrthographicCamera,
-  PerspectiveCamera,
-  Scene,
-} from "three";
-import { Node, type NodeBuilder, type NodeFrame } from "three/webgpu";
-/** Camera/depth TAA for WebGPURenderer, including its WebGL2 fallback. */
-export declare class TAANode extends Node<"vec4"> {
-  scene: Scene;
-  camera: PerspectiveCamera | OrthographicCamera;
-  readonly msaa: boolean;
-  private readonly coverage;
-  static get type(): string;
-  depthThreshold: number;
-  edgeDepthDiff: number;
-  maxMotionLength: number;
-  useSubpixelCorrection: boolean;
-  private readonly source;
-  private readonly history;
-  private readonly historyColor;
-  private readonly historyDepth;
-  private readonly textureNode;
-  private readonly material;
-  private readonly quad;
-  private readonly state;
-  private readonly zeroToOne;
-  private readonly drawingSize;
-  private workingColorSpace;
-  private readonly pipelineStates;
-  private pipelineRendering;
-  private capturePending;
-  /** @param msaa Enable 4× MSAA (default false). Fixed for the node's lifetime. */
-  constructor(
-    scene: Scene,
-    camera: PerspectiveCamera | OrthographicCamera,
-    msaa?: boolean,
-  );
-  private makeTarget;
-  get depthTexture(): DepthTexture;
-  get projectionMatrix(): Matrix4;
-  getTextureNode(): import("three/webgpu").TextureNode;
-  setSize(width: number, height: number): void;
-  reset(): void;
-  updateBefore(frame: NodeFrame): undefined;
-  setup(builder: NodeBuilder): import("three/webgpu").TextureNode;
-  dispose(): void;
-}

package/dist/types/addons/TAAPass.d.cts

@@ -1,57 +0,0 @@
-import type {
-  DepthTexture,
-  Matrix4,
-  OrthographicCamera,
-  PerspectiveCamera,
-  Scene,
-  WebGLRenderTarget,
-  WebGLRenderer,
-} from "three";
-import { Pass } from "three/addons/postprocessing/Pass.js";
-/**
- * Temporal reprojection for WebGLRenderer, using depth and camera motion.
- * Object motion is not tracked; no velocity texture is required.
- * Owns scene capture, camera jitter, and history. It blends and accumulates
- * in the output color space, like direct canvas rendering, then hands the
- * composer a working-space result. Use EffectComposer with OutputPass for
- * output.
- */
-export declare class TAAPass extends Pass {
-  scene: Scene;
-  camera: PerspectiveCamera | OrthographicCamera;
-  readonly msaa: boolean;
-  private readonly _coverage;
-  /** Depth difference above which non-edge history is rejected. */
-  depthThreshold: number;
-  /** Depth range within the 3x3 neighborhood that identifies an edge. */
-  edgeDepthDiff: number;
-  /** Camera motion in pixels at which history loses all weight. */
-  maxMotionLength: number;
-  /** Increase current-frame weight for subpixel camera motion. */
-  useSubpixelCorrection: boolean;
-  private readonly _source;
-  private readonly _history;
-  private readonly _clearColor;
-  private readonly _state;
-  private readonly _uniforms;
-  private readonly _resolveMaterial;
-  private readonly _copyMaterial;
-  private readonly _quad;
-  /** @param msaa Enable 4× MSAA (default false). Fixed for the pass's lifetime. */
-  constructor(
-    scene: Scene,
-    camera: PerspectiveCamera | OrthographicCamera,
-    msaa?: boolean,
-  );
-  /** Current scene depth, before temporal accumulation. Owned by this pass. */
-  get depthTexture(): DepthTexture;
-  /** Jittered projection used to capture depthTexture. Treat as read-only. */
-  get projectionMatrix(): Matrix4;
-  /** Resize all internal targets in physical pixels; a size change clears history. */
-  setSize(width: number, height: number): void;
-  /** Discard history after a camera cut, scene replacement, or color-space change. */
-  reset(): void;
-  /** Render the scene and resolve TAA into the composer's working-space buffer. */
-  render(renderer: WebGLRenderer, writeBuffer: WebGLRenderTarget): void;
-  dispose(): void;
-}

package/dist/types/addons/TAAPass.d.ts

@@ -1,57 +0,0 @@
-import type {
-  DepthTexture,
-  Matrix4,
-  OrthographicCamera,
-  PerspectiveCamera,
-  Scene,
-  WebGLRenderTarget,
-  WebGLRenderer,
-} from "three";
-import { Pass } from "three/addons/postprocessing/Pass.js";
-/**
- * Temporal reprojection for WebGLRenderer, using depth and camera motion.
- * Object motion is not tracked; no velocity texture is required.
- * Owns scene capture, camera jitter, and history. It blends and accumulates
- * in the output color space, like direct canvas rendering, then hands the
- * composer a working-space result. Use EffectComposer with OutputPass for
- * output.
- */
-export declare class TAAPass extends Pass {
-  scene: Scene;
-  camera: PerspectiveCamera | OrthographicCamera;
-  readonly msaa: boolean;
-  private readonly _coverage;
-  /** Depth difference above which non-edge history is rejected. */
-  depthThreshold: number;
-  /** Depth range within the 3x3 neighborhood that identifies an edge. */
-  edgeDepthDiff: number;
-  /** Camera motion in pixels at which history loses all weight. */
-  maxMotionLength: number;
-  /** Increase current-frame weight for subpixel camera motion. */
-  useSubpixelCorrection: boolean;
-  private readonly _source;
-  private readonly _history;
-  private readonly _clearColor;
-  private readonly _state;
-  private readonly _uniforms;
-  private readonly _resolveMaterial;
-  private readonly _copyMaterial;
-  private readonly _quad;
-  /** @param msaa Enable 4× MSAA (default false). Fixed for the pass's lifetime. */
-  constructor(
-    scene: Scene,
-    camera: PerspectiveCamera | OrthographicCamera,
-    msaa?: boolean,
-  );
-  /** Current scene depth, before temporal accumulation. Owned by this pass. */
-  get depthTexture(): DepthTexture;
-  /** Jittered projection used to capture depthTexture. Treat as read-only. */
-  get projectionMatrix(): Matrix4;
-  /** Resize all internal targets in physical pixels; a size change clears history. */
-  setSize(width: number, height: number): void;
-  /** Discard history after a camera cut, scene replacement, or color-space change. */
-  reset(): void;
-  /** Render the scene and resolve TAA into the composer's working-space buffer. */
-  render(renderer: WebGLRenderer, writeBuffer: WebGLRenderTarget): void;
-  dispose(): void;
-}

package/dist/types/addons/taaShared.d.cts

@@ -1,74 +0,0 @@
-import type {
-  Camera,
-  Matrix4,
-  OrthographicCamera,
-  PerspectiveCamera,
-  RenderTarget,
-  Vector2,
-  Vector3,
-} from "three";
-type TAACamera = PerspectiveCamera | OrthographicCamera;
-type TAAParameters = {
-  depthThreshold: number;
-  edgeDepthDiff: number;
-  maxMotionLength: number;
-  useSubpixelCorrection: boolean;
-};
-export declare function createTAAState<
-  FloatUniform extends {
-    value: number;
-  },
-  BoolUniform extends {
-    value: boolean;
-  },
-  Vec2Uniform extends {
-    value: Vector2;
-  },
-  Vec3Uniform extends {
-    value: Vector3;
-  },
-  Mat4Uniform extends {
-    value: Matrix4;
-  },
->(
-  makeUniform: {
-    (value: number): FloatUniform;
-    (value: boolean): BoolUniform;
-    (value: Vector2): Vec2Uniform;
-    (value: Vector3): Vec3Uniform;
-    (value: Matrix4): Mat4Uniform;
-  },
-  targets: RenderTarget[],
-  nodeLogDepth?: boolean,
-  margin?: number,
-): {
-  uniforms: {
-    renderSize: Vec2Uniform;
-    projection: Mat4Uniform;
-    unjitteredProjection: Mat4Uniform;
-    previousProjection: Mat4Uniform;
-    viewToPreviousClip: Mat4Uniform;
-    previousViewToView: Mat4Uniform;
-    valid: BoolUniform;
-    reversed: BoolUniform;
-    logarithmic: BoolUniform;
-    logFar: Vec2Uniform;
-    logNear: Vec2Uniform;
-    depthThreshold: FloatUniform;
-    edgeDepthDiff: FloatUniform;
-    maxMotionLength: FloatUniform;
-    useSubpixelCorrection: BoolUniform;
-    luminanceCoefficients: Vec3Uniform;
-  };
-  historyIndex: number;
-  jitterIndex: number;
-  reset(): void;
-  setSize(width: number, height: number): void;
-  setStencil(stencil: boolean): void;
-  beginCapture(camera: TAACamera): void;
-  endCapture(camera: TAACamera): void;
-  prepareResolve(camera: TAACamera, parameters: TAAParameters): 0 | 1;
-  advance(camera: TAACamera): void;
-};
-export declare const getTAAProjection: (camera: Camera) => Matrix4 | undefined;
-export {};

package/dist/types/addons/taaShared.d.ts

@@ -1,74 +0,0 @@
-import type {
-  Camera,
-  Matrix4,
-  OrthographicCamera,
-  PerspectiveCamera,
-  RenderTarget,
-  Vector2,
-  Vector3,
-} from "three";
-type TAACamera = PerspectiveCamera | OrthographicCamera;
-type TAAParameters = {
-  depthThreshold: number;
-  edgeDepthDiff: number;
-  maxMotionLength: number;
-  useSubpixelCorrection: boolean;
-};
-export declare function createTAAState<
-  FloatUniform extends {
-    value: number;
-  },
-  BoolUniform extends {
-    value: boolean;
-  },
-  Vec2Uniform extends {
-    value: Vector2;
-  },
-  Vec3Uniform extends {
-    value: Vector3;
-  },
-  Mat4Uniform extends {
-    value: Matrix4;
-  },
->(
-  makeUniform: {
-    (value: number): FloatUniform;
-    (value: boolean): BoolUniform;
-    (value: Vector2): Vec2Uniform;
-    (value: Vector3): Vec3Uniform;
-    (value: Matrix4): Mat4Uniform;
-  },
-  targets: RenderTarget[],
-  nodeLogDepth?: boolean,
-  margin?: number,
-): {
-  uniforms: {
-    renderSize: Vec2Uniform;
-    projection: Mat4Uniform;
-    unjitteredProjection: Mat4Uniform;
-    previousProjection: Mat4Uniform;
-    viewToPreviousClip: Mat4Uniform;
-    previousViewToView: Mat4Uniform;
-    valid: BoolUniform;
-    reversed: BoolUniform;
-    logarithmic: BoolUniform;
-    logFar: Vec2Uniform;
-    logNear: Vec2Uniform;
-    depthThreshold: FloatUniform;
-    edgeDepthDiff: FloatUniform;
-    maxMotionLength: FloatUniform;
-    useSubpixelCorrection: BoolUniform;
-    luminanceCoefficients: Vec3Uniform;
-  };
-  historyIndex: number;
-  jitterIndex: number;
-  reset(): void;
-  setSize(width: number, height: number): void;
-  setStencil(stencil: boolean): void;
-  beginCapture(camera: TAACamera): void;
-  endCapture(camera: TAACamera): void;
-  prepareResolve(camera: TAACamera, parameters: TAAParameters): 0 | 1;
-  advance(camera: TAACamera): void;
-};
-export declare const getTAAProjection: (camera: Camera) => Matrix4 | undefined;
-export {};