gaussian-splat-lite 1.3.1 → 1.3.2

package/dist/types/data/IndexedSplats.d.cts

@@ -19,7 +19,7 @@ type DecodedSplatWithSh = DecodedSplat & {
  * Fades affect display only: records returned to picking retain their source opacity. */
 export declare abstract class IndexedSplats extends Splats {
   readonly layerSize: number;
-  readonly numSh: 0 | 1 | 2 | 3;
+  readonly numSh: 0 | 1 | 2 | 3 | 4;
   protected readonly opacities: SplatOpacityTable;
   protected sourceIndices: Uint32Array<ArrayBuffer>;
   protected visibleIndices: Uint32Array;
@@ -55,7 +55,7 @@ export declare abstract class IndexedSplats extends Splats {
   private getStorageIndex;
   getSourceIndex(index: number): number;
   private checkVisibleRange;
-  getNumSh(): 0 | 3 | 2 | 1;
+  getNumSh(): 0 | 1 | 2 | 3 | 4;
   /** Estimated GPU storage for packed records, render indices and opacity tables. */
   get textureByteLength(): number;
   getByteLength(): number;

package/dist/types/data/IndexedSplats.d.ts

@@ -19,7 +19,7 @@ type DecodedSplatWithSh = DecodedSplat & {
  * Fades affect display only: records returned to picking retain their source opacity. */
 export declare abstract class IndexedSplats extends Splats {
   readonly layerSize: number;
-  readonly numSh: 0 | 1 | 2 | 3;
+  readonly numSh: 0 | 1 | 2 | 3 | 4;
   protected readonly opacities: SplatOpacityTable;
   protected sourceIndices: Uint32Array<ArrayBuffer>;
   protected visibleIndices: Uint32Array;
@@ -55,7 +55,7 @@ export declare abstract class IndexedSplats extends Splats {
   private getStorageIndex;
   getSourceIndex(index: number): number;
   private checkVisibleRange;
-  getNumSh(): 0 | 3 | 2 | 1;
+  getNumSh(): 0 | 1 | 2 | 3 | 4;
   /** Estimated GPU storage for packed records, render indices and opacity tables. */
   get textureByteLength(): number;
   getByteLength(): number;

package/dist/types/data/Splats.d.cts

@@ -55,7 +55,7 @@ export declare class Splats {
   getNumSplats(): number;
   /** @internal Copy cached local bounds into the target box. */
   getBoundingBox(centersOnly?: boolean, target?: THREE.Box3): THREE.Box3;
-  getNumSh(): 1 | 2 | 0 | 3;
+  getNumSh(): 0 | 1 | 2 | 3 | 4;
   /** Current retained bytes for encoded Splat, sort-center, and SH arrays. */
   getByteLength(): number;
   /** @internal Consume owned arrays for transfer to a streaming worker. */

package/dist/types/data/Splats.d.ts

@@ -55,7 +55,7 @@ export declare class Splats {
   getNumSplats(): number;
   /** @internal Copy cached local bounds into the target box. */
   getBoundingBox(centersOnly?: boolean, target?: THREE.Box3): THREE.Box3;
-  getNumSh(): 1 | 2 | 0 | 3;
+  getNumSh(): 0 | 1 | 2 | 3 | 4;
   /** Current retained bytes for encoded Splat, sort-center, and SH arrays. */
   getByteLength(): number;
   /** @internal Consume owned arrays for transfer to a streaming worker. */

package/dist/types/data/defines.d.cts

@@ -12,10 +12,12 @@ export declare enum SplatFileType {
   RAD = "rad",
 }
 export type SplatExtra = {
-  sh1?: Uint32Array;
-  sh2?: Uint32Array;
-  sh3a?: Uint32Array;
-  sh3b?: Uint32Array;
+  shBlock0?: Uint32Array;
+  shBlock1?: Uint32Array;
+  shBlock2?: Uint32Array;
+  shBlock3?: Uint32Array;
+  shBlock4?: Uint32Array;
+  shBlock5?: Uint32Array;
 };
 /** Morton storage records per cached spatial bounds block. */
 export declare const SPLAT_BOUNDS_BLOCK_SIZE = 256;

package/dist/types/data/defines.d.ts

@@ -12,10 +12,12 @@ export declare enum SplatFileType {
   RAD = "rad",
 }
 export type SplatExtra = {
-  sh1?: Uint32Array;
-  sh2?: Uint32Array;
-  sh3a?: Uint32Array;
-  sh3b?: Uint32Array;
+  shBlock0?: Uint32Array;
+  shBlock1?: Uint32Array;
+  shBlock2?: Uint32Array;
+  shBlock3?: Uint32Array;
+  shBlock4?: Uint32Array;
+  shBlock5?: Uint32Array;
 };
 /** Morton storage records per cached spatial bounds block. */
 export declare const SPLAT_BOUNDS_BLOCK_SIZE = 256;

package/dist/types/data/splatData.d.cts

@@ -1,6 +1,13 @@
 import type { SplatExtra } from "./defines.cjs";
-export declare const SH_KEYS: readonly ["sh1", "sh2", "sh3a", "sh3b"];
-export declare const SH_ARRAY_COUNTS: readonly [0, 1, 2, 4];
+export declare const SH_KEYS: readonly [
+  "shBlock0",
+  "shBlock1",
+  "shBlock2",
+  "shBlock3",
+  "shBlock4",
+  "shBlock5",
+];
+export declare const SH_ARRAY_COUNTS: readonly [0, 1, 2, 4, 6];
 /** Merge cached min XYZ / max XYZ values without decoding records. */
 export declare function unionSplatBounds(
   target: Float32Array,
@@ -8,7 +15,7 @@ export declare function unionSplatBounds(
   offset?: number,
 ): void;
 export declare function resetSplatBounds(bounds: Float32Array): void;
-export declare function getSplatShDegree(extra: SplatExtra): 1 | 2 | 0 | 3;
+export declare function getSplatShDegree(extra: SplatExtra): 0 | 1 | 2 | 3 | 4;
 /** Packed texture storage; capacity includes padding, but excludes sort centers. */
 export declare function getSplatTextureBytes(
   capacity: number,

package/dist/types/data/splatData.d.ts

@@ -1,6 +1,13 @@
 import type { SplatExtra } from "./defines.js";
-export declare const SH_KEYS: readonly ["sh1", "sh2", "sh3a", "sh3b"];
-export declare const SH_ARRAY_COUNTS: readonly [0, 1, 2, 4];
+export declare const SH_KEYS: readonly [
+  "shBlock0",
+  "shBlock1",
+  "shBlock2",
+  "shBlock3",
+  "shBlock4",
+  "shBlock5",
+];
+export declare const SH_ARRAY_COUNTS: readonly [0, 1, 2, 4, 6];
 /** Merge cached min XYZ / max XYZ values without decoding records. */
 export declare function unionSplatBounds(
   target: Float32Array,
@@ -8,7 +15,7 @@ export declare function unionSplatBounds(
   offset?: number,
 ): void;
 export declare function resetSplatBounds(bounds: Float32Array): void;
-export declare function getSplatShDegree(extra: SplatExtra): 1 | 2 | 0 | 3;
+export declare function getSplatShDegree(extra: SplatExtra): 0 | 1 | 2 | 3 | 4;
 /** Packed texture storage; capacity includes padding, but excludes sort centers. */
 export declare function getSplatTextureBytes(
   capacity: number,

package/dist/types/loaders/postDecode/builder.d.cts

@@ -69,7 +69,7 @@ type AttributeValue<Components extends AttributeComponents> =
         : Vec4Value;
 type SplatShCoefficientContext = {
   index: number;
-  degree: 1 | 2 | 3;
+  degree: 1 | 2 | 3 | 4;
   order: number;
 };
 declare class SplatPostDecodeShPatch {

package/dist/types/loaders/postDecode/builder.d.ts

@@ -69,7 +69,7 @@ type AttributeValue<Components extends AttributeComponents> =
         : Vec4Value;
 type SplatShCoefficientContext = {
   index: number;
-  degree: 1 | 2 | 3;
+  degree: 1 | 2 | 3 | 4;
   order: number;
 };
 declare class SplatPostDecodeShPatch {

package/dist/types/loaders/postDecode/protocol.d.cts

@@ -67,7 +67,7 @@ export declare const InputField: {
 /** @internal */
 export type InputField = (typeof InputField)[keyof typeof InputField];
 /** @internal */
-export declare const SH_COEFFICIENT_COUNT = 15;
+export declare const SH_COEFFICIENT_COUNT = 24;
 /** @internal */
 export type SplatPostDecodeValueType =
   | "float"
@@ -184,8 +184,10 @@ export type PostDecodeSplatData = {
   splat1: Uint32Array;
   sortCenters: Float32Array;
   sourceIds?: Uint32Array;
-  sh1?: Uint32Array;
-  sh2?: Uint32Array;
-  sh3a?: Uint32Array;
-  sh3b?: Uint32Array;
+  shBlock0?: Uint32Array;
+  shBlock1?: Uint32Array;
+  shBlock2?: Uint32Array;
+  shBlock3?: Uint32Array;
+  shBlock4?: Uint32Array;
+  shBlock5?: Uint32Array;
 };

package/dist/types/loaders/postDecode/protocol.d.ts

@@ -67,7 +67,7 @@ export declare const InputField: {
 /** @internal */
 export type InputField = (typeof InputField)[keyof typeof InputField];
 /** @internal */
-export declare const SH_COEFFICIENT_COUNT = 15;
+export declare const SH_COEFFICIENT_COUNT = 24;
 /** @internal */
 export type SplatPostDecodeValueType =
   | "float"
@@ -184,8 +184,10 @@ export type PostDecodeSplatData = {
   splat1: Uint32Array;
   sortCenters: Float32Array;
   sourceIds?: Uint32Array;
-  sh1?: Uint32Array;
-  sh2?: Uint32Array;
-  sh3a?: Uint32Array;
-  sh3b?: Uint32Array;
+  shBlock0?: Uint32Array;
+  shBlock1?: Uint32Array;
+  shBlock2?: Uint32Array;
+  shBlock3?: Uint32Array;
+  shBlock4?: Uint32Array;
+  shBlock5?: Uint32Array;
 };

package/docs/PostDecode.md

@@ -43,9 +43,9 @@ Read these from `splat`:
 | `splat.opacity` | `float` | Opacity as stored in the model, which can be above 1 |
 | `splat.alpha` | `float` | Opacity from 0 (transparent) to 1 (opaque) |
 | `splat.color` | `vec3` | RGB color |
-| `splat.sh.coefficient(index)` | `vec3` | One of the 15 view-dependent color coefficients |
+| `splat.sh.coefficient(index)` | `vec3` | One of the 24 view-dependent color coefficients (indices 0–23, SH1–SH4) |
 
-`splat.sh.map((coefficient, { degree }) => ...)` builds a calculation for all 15 coefficients at once. Only the ones the model has are updated.
+`splat.sh.map((coefficient, { degree }) => ...)` builds a calculation for all 24 coefficients at once. Only the ones the model has are updated.
 
 ## Returning changes
 

package/docs/SplatFileType.md

@@ -11,6 +11,8 @@ The model formats you can load:
 | `SplatFileType.SOG` | `"sog"` | `.sog`, or a SOG `meta.json` with its images |
 | `SplatFileType.RAD` | `"rad"` | `.rad` |
 
+PLY and SPZ support view-dependent color up to SH4 on WebGL, WebGPU, and the WebGL2 fallback. RAD and SOG support up to SH3. Models render all their available coefficients by default; set [`mesh.maxSh`](SplatMesh.md#properties) to limit the degree.
+
 The format is normally detected from the URL or `fileName`, so you rarely need this. Set it when the name does not show the format:
 
 ```js

package/docs/SplatMesh.md

@@ -59,7 +59,7 @@ Choose at most one of `url`, `file`, `fileBytes`, or `splats`; combining them th
 | `numSplats` | `number` | Current Splat count |
 | `recolor` | `THREE.Color(1, 1, 1)` | Color multiplier for the whole model |
 | `opacity` | `1` | Opacity multiplier for the whole model |
-| `maxSh` | `3` | Limit view-dependent color detail; `0` uses the base color only |
+| `maxSh` | `4` | Limit view-dependent color detail to SH0–SH4; `0` uses the base color only |
 | `edits` | `SplatEdit[] \| null` | Explicit list of [edits](SplatEdit.md) for this mesh |
 | `splats` | `Splats \| undefined` | The model's [Splats](Splats.md) data |
 | `needsUpdate` | `boolean` setter | Set to `true` to force a refresh |

package/docs/Splats.md

@@ -49,7 +49,7 @@ Calling `initialize()` again or `dispose()` cancels a load still in progress; it
 ## Data rules
 
 - **Indices are not file order.** Splats are reordered while loading. Use `getSourceIndex(index)`, or a picking hit's `sourceIndex`, to get the ID from the original file. Passing existing `Splats` to a mesh keeps their order.
-- **Reads return copies.** `getSplat()` returns new `center`, `scales`, `quaternion`, `opacity`, `color`, and `sh` values on each call; changing them does not change the model. `sh` holds 0, 3, 8, or 15 RGB coefficients, depending on the model's degree.
+- **Reads return copies.** `getSplat()` returns new `center`, `scales`, `quaternion`, `opacity`, `color`, and `sh` values on each call; changing them does not change the model. `sh` holds 0, 3, 8, 15, or 24 RGB coefficients, depending on the model's degree (SH0–SH4).
 - **`forEachSplat()` reuses its objects.** The same objects are passed for every Splat, so clone anything you want to keep after the callback returns.
 - **Streamed data is read-only.** Data from [RadStreamScheduler](RadStreamScheduler.md) or [SogStreamScheduler](SogStreamScheduler.md) cannot be reinitialized.
 - **Bounds live on the mesh.** Use [`mesh.getBoundingBox()`](SplatMesh.md#bounding-box).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gaussian-splat-lite",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "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",