@sparkjsdev/spark 2.2.0 → 2.3.1

package/dist/types/ExtSplats.d.ts

@@ -1,10 +1,12 @@
-import { RgbaArray } from './RgbaArray';
-import { SplatSource } from './SplatMesh';
-import { SplatFileType } from './defines';
-import { DynoInt, DynoUniform, DynoUsampler2DArray, DynoVal, Gsplat, TExtSplats } from './dyno';
 import * as THREE from "three";
+import type { RgbaArray } from "./RgbaArray";
+import type { SplatSource } from "./SplatMesh";
+import { type SplatFileType } from "./defines";
+import { DynoInt, DynoUniform, DynoUsampler2DArray, type DynoVal, type Gsplat, TExtSplats } from "./dyno";
 export type ExtSplatsOptions = {
     url?: string;
+    requestHeader?: Record<string, string>;
+    withCredentials?: boolean;
     fileBytes?: Uint8Array | ArrayBuffer;
     fileType?: SplatFileType;
     fileName?: string;

package/dist/types/PackedSplats.d.ts

@@ -1,13 +1,15 @@
-import { FullScreenQuad } from 'three/addons/postprocessing/Pass.js';
-import { RgbaArray } from './RgbaArray';
-import { GsplatGenerator } from './SplatGenerator';
-import { SplatSource } from './SplatMesh';
-import { SplatEncoding, SplatFileType } from './defines';
-import { DynoInt, DynoProgram, DynoProgramTemplate, DynoUniform, DynoUsampler2DArray, DynoVal, DynoVec3 } from './dyno';
-import { Gsplat, TPackedSplats } from './dyno/splats';
 import * as THREE from "three";
+import { FullScreenQuad } from "three/addons/postprocessing/Pass.js";
+import type { RgbaArray } from "./RgbaArray";
+import type { GsplatGenerator } from "./SplatGenerator";
+import type { SplatSource } from "./SplatMesh";
+import { type SplatEncoding, type SplatFileType } from "./defines";
+import { DynoInt, DynoProgram, DynoProgramTemplate, DynoUniform, DynoUsampler2DArray, type DynoVal, DynoVec3 } from "./dyno";
+import { type Gsplat, TPackedSplats } from "./dyno/splats";
 export type PackedSplatsOptions = {
     url?: string;
+    requestHeader?: Record<string, string>;
+    withCredentials?: boolean;
     fileBytes?: Uint8Array | ArrayBuffer;
     fileType?: SplatFileType;
     fileName?: string;
@@ -19,7 +21,7 @@ export type PackedSplatsOptions = {
     construct?: (splats: PackedSplats) => Promise<void> | void;
     onProgress?: (event: ProgressEvent) => void;
     extra?: Record<string, unknown>;
-    splatEncoding?: SplatEncoding;
+    splatEncoding?: Partial<SplatEncoding>;
     lod?: boolean | "quality";
     nonLod?: boolean;
     lodAbove?: number;
@@ -31,7 +33,7 @@ export declare class PackedSplats implements SplatSource {
     packedArray: Uint32Array | null;
     extra: Record<string, unknown>;
     maxSh: number;
-    splatEncoding?: SplatEncoding;
+    splatEncoding: SplatEncoding;
     lod?: boolean | "quality";
     nonLod?: boolean;
     lodSplats?: PackedSplats;

package/dist/types/Readback.d.ts

@@ -1,7 +1,7 @@
-import { FullScreenQuad } from 'three/addons/postprocessing/Pass.js';
-import { Dyno } from './dyno';
-import { DynoProgram, DynoProgramTemplate } from './dyno/program';
 import * as THREE from "three";
+import { FullScreenQuad } from "three/addons/postprocessing/Pass.js";
+import { type Dyno } from "./dyno";
+import { DynoProgram, DynoProgramTemplate } from "./dyno/program";
 export type Rgba8Readback = Dyno<{
     index: "int";
 }, {

package/dist/types/RgbaArray.d.ts

@@ -1,7 +1,7 @@
-import { PackedSplats } from './PackedSplats';
-import { Readback, Rgba8Readback } from './Readback';
-import { DynoUniform, DynoVal } from './dyno';
 import * as THREE from "three";
+import { type PackedSplats } from "./PackedSplats";
+import { Readback, type Rgba8Readback } from "./Readback";
+import { DynoUniform, type DynoVal } from "./dyno";
 export type RgbaArrayOptions = {
     capacity?: number;
     array?: Uint8Array;

package/dist/types/SparkPortals.d.ts

@@ -1,5 +1,5 @@
-import { SparkRenderer, SparkRendererOptions } from './SparkRenderer';
 import * as THREE from "three";
+import { SparkRenderer, type SparkRendererOptions } from "./SparkRenderer";
 /**
  * Fragment shader for portal disk clipping.
  * - diskRadius > 0: render "behind portal" only through the disk

package/dist/types/SparkRenderer.d.ts

@@ -1,7 +1,10 @@
-import { ExtSplats, PackedSplats, PagedSplats, SplatMesh, SplatPager } from '.';
-import { SplatAccumulator } from './SplatAccumulator';
-import { SplatWorker } from './SplatWorker';
 import * as THREE from "three";
+import { ExtSplats } from "./ExtSplats";
+import { PackedSplats } from "./PackedSplats";
+import { SplatAccumulator } from "./SplatAccumulator";
+import { SplatMesh } from "./SplatMesh";
+import { PagedSplats, SplatPager } from "./SplatPager";
+import { SplatWorker } from "./SplatWorker";
 export interface SparkRendererOptions {
     /**
      * Pass in your THREE.WebGLRenderer instance so Spark can perform work
@@ -12,7 +15,9 @@ export interface SparkRendererOptions {
     renderer: THREE.WebGLRenderer;
     /**
      * Callback function to be called when SparkRenderer needs to re-render,
-     * for example when splat sort order or LoD updates complete.
+     * for example when splat sort order or LoD updates complete. May fire
+     * several times per frame; schedule a single render rather than rendering
+     * inside the callback.
      */
     onDirty?: () => void;
     /**
@@ -193,6 +198,14 @@ export interface SparkRendererOptions {
      * @default 3
      */
     numLodFetchers?: number;
+    /**
+     * How long (ms) a LoD SplatMesh can go unrendered (hidden or removed from the
+     * scene) before its LoD state is released: the worker-side tree is dropped and,
+     * for paged meshes, its resident pages are freed for other meshes. Rendering it
+     * again rebuilds the tree and refetches pages. Set to Infinity to never release.
+     * @default 3000
+     */
+    lodCleanupTimeoutMs?: number;
     /**
      * Full-width angle in degrees of fixed foveation cone along the view direction
      * with no foveation applied (full resolution, foveate=1.0). Set to 0 to disable.
@@ -319,7 +332,7 @@ export declare class SparkRenderer extends THREE.Mesh {
     readonly timer: THREE.Timer;
     private readonly ownsTimer;
     lastFrame: number;
-    updateTimeoutId: number;
+    updateTimeoutId: ReturnType<typeof setTimeout> | undefined;
     onDirty?: () => void;
     dirty: boolean;
     orderingTexture: THREE.DataTexture | null;
@@ -332,10 +345,11 @@ export declare class SparkRenderer extends THREE.Mesh {
     sortDirty: boolean;
     lastSortTime: number;
     sortWorker: SplatWorker | null;
-    sortTimeoutId: number;
+    sortTimeoutId: ReturnType<typeof setTimeout> | undefined;
     sortedCenter: THREE.Vector3;
     sortedDir: THREE.Vector3;
     readback32: Uint32Array<ArrayBuffer>;
+    private readonly initWatched;
     enableLod: boolean;
     enableDriveLod: boolean;
     enableLodFetching: boolean;
@@ -347,6 +361,7 @@ export declare class SparkRenderer extends THREE.Mesh {
     pagedExtSplats: boolean;
     maxPagedSplats: number;
     numLodFetchers: number;
+    lodCleanupTimeoutMs: number;
     behindFoveate: number;
     coneFov0: number;
     coneFov: number;
@@ -516,6 +531,8 @@ export declare class SparkRenderer extends THREE.Mesh {
     private ensureLodWorker;
     defaultSplatTarget(): 500000 | 750000 | 1000000 | 1500000 | 2500000;
     private driveLod;
+    /** Body of the LoD update, run with exclusive access to the LoD worker. */
+    private driveLodExclusive;
     private initLodTree;
     private pageSizeWarning;
     private updateLodInstances;

package/dist/types/SparkXr.d.ts

@@ -1,5 +1,6 @@
-import { SplatMesh } from './SplatMesh';
 import * as THREE from "three";
+import { SplatMesh } from "./SplatMesh";
+import { Hand, type JointId } from "./hands";
 export interface SparkXrOptions {
     renderer: THREE.WebGLRenderer;
     element?: HTMLElement;
@@ -65,51 +66,6 @@ export declare const DEFAULT_CONTROLLER_GETMOVE: (gamepads: XrGamepads, sparkXr:
 export declare const DEFAULT_CONTROLLER_GETROTATE: (gamepads: XrGamepads, sparkXr: SparkXr) => THREE.Vector3;
 export declare const DEFAULT_CONTROLLER_GETFAST: (gamepads: XrGamepads, sparkXr: SparkXr) => boolean;
 export declare const DEFAULT_CONTROLLER_GETSLOW: (gamepads: XrGamepads, sparkXr: SparkXr) => boolean;
-export declare enum JointEnum {
-    w = "wrist",
-    t0 = "thumb-metacarpal",
-    t1 = "thumb-phalanx-proximal",
-    t2 = "thumb-phalanx-distal",
-    t3 = "thumb-tip",
-    i0 = "index-finger-metacarpal",
-    i1 = "index-finger-phalanx-proximal",
-    i2 = "index-finger-phalanx-intermediate",
-    i3 = "index-finger-phalanx-distal",
-    i4 = "index-finger-tip",
-    m0 = "middle-finger-metacarpal",
-    m1 = "middle-finger-phalanx-proximal",
-    m2 = "middle-finger-phalanx-intermediate",
-    m3 = "middle-finger-phalanx-distal",
-    m4 = "middle-finger-tip",
-    r0 = "ring-finger-metacarpal",
-    r1 = "ring-finger-phalanx-proximal",
-    r2 = "ring-finger-phalanx-intermediate",
-    r3 = "ring-finger-phalanx-distal",
-    r4 = "ring-finger-tip",
-    p0 = "pinky-finger-metacarpal",
-    p1 = "pinky-finger-phalanx-proximal",
-    p2 = "pinky-finger-phalanx-intermediate",
-    p3 = "pinky-finger-phalanx-distal",
-    p4 = "pinky-finger-tip"
-}
-export type JointId = keyof typeof JointEnum;
-export declare const JOINT_IDS: JointId[];
-export declare const NUM_JOINTS: number;
-export declare const JOINT_INDEX: {
-    [key in JointId]: number;
-};
-export declare const JOINT_RADIUS: {
-    [key in JointId]: number;
-};
-export declare const JOINT_SEGMENTS: JointId[][];
-export declare const JOINT_SEGMENT_STEPS: number[][];
-export declare const JOINT_TIPS: JointId[];
-export declare const FINGER_TIPS: JointId[];
-export declare enum Hand {
-    left = "left",
-    right = "right"
-}
-export declare const HANDS: Hand[];
 export type Joint = {
     position: THREE.Vector3;
     quaternion: THREE.Quaternion;
@@ -138,15 +94,36 @@ export declare class SparkXr {
     private updateElement;
     private static createButton;
     xrSupported(): boolean;
-    static JointEnum: typeof JointEnum;
-    static JOINT_IDS: ("w" | "t0" | "t1" | "t2" | "t3" | "i0" | "i1" | "i2" | "i3" | "i4" | "m0" | "m1" | "m2" | "m3" | "m4" | "r0" | "r1" | "r2" | "r3" | "r4" | "p0" | "p1" | "p2" | "p3" | "p4")[];
-    static NUM_JOINTS: number;
-    static JOINT_INDEX: {
-        w: number;
-        t0: number;
-        t1: number;
-        t2: number;
-        t3: number;
+    static readonly JointEnum: {
+        readonly w: "wrist";
+        readonly t0: "thumb-metacarpal";
+        readonly t1: "thumb-phalanx-proximal";
+        readonly t2: "thumb-phalanx-distal";
+        readonly t3: "thumb-tip";
+        readonly i0: "index-finger-metacarpal";
+        readonly i1: "index-finger-phalanx-proximal";
+        readonly i2: "index-finger-phalanx-intermediate";
+        readonly i3: "index-finger-phalanx-distal";
+        readonly i4: "index-finger-tip";
+        readonly m0: "middle-finger-metacarpal";
+        readonly m1: "middle-finger-phalanx-proximal";
+        readonly m2: "middle-finger-phalanx-intermediate";
+        readonly m3: "middle-finger-phalanx-distal";
+        readonly m4: "middle-finger-tip";
+        readonly r0: "ring-finger-metacarpal";
+        readonly r1: "ring-finger-phalanx-proximal";
+        readonly r2: "ring-finger-phalanx-intermediate";
+        readonly r3: "ring-finger-phalanx-distal";
+        readonly r4: "ring-finger-tip";
+        readonly p0: "pinky-finger-metacarpal";
+        readonly p1: "pinky-finger-phalanx-proximal";
+        readonly p2: "pinky-finger-phalanx-intermediate";
+        readonly p3: "pinky-finger-phalanx-distal";
+        readonly p4: "pinky-finger-tip";
+    };
+    static readonly JOINT_IDS: ("i0" | "i1" | "i2" | "i3" | "i4" | "m0" | "m1" | "m2" | "m3" | "m4" | "p0" | "p1" | "p2" | "p3" | "p4" | "r0" | "r1" | "r2" | "r3" | "r4" | "t0" | "t1" | "t2" | "t3" | "w")[];
+    static readonly NUM_JOINTS: number;
+    static readonly JOINT_INDEX: {
         i0: number;
         i1: number;
         i2: number;
@@ -157,23 +134,23 @@ export declare class SparkXr {
         m2: number;
         m3: number;
         m4: number;
-        r0: number;
-        r1: number;
-        r2: number;
-        r3: number;
-        r4: number;
         p0: number;
         p1: number;
         p2: number;
         p3: number;
         p4: number;
-    };
-    static JOINT_RADIUS: {
-        w: number;
+        r0: number;
+        r1: number;
+        r2: number;
+        r3: number;
+        r4: number;
         t0: number;
         t1: number;
         t2: number;
         t3: number;
+        w: number;
+    };
+    static readonly JOINT_RADIUS: {
         i0: number;
         i1: number;
         i2: number;
@@ -184,23 +161,28 @@ export declare class SparkXr {
         m2: number;
         m3: number;
         m4: number;
-        r0: number;
-        r1: number;
-        r2: number;
-        r3: number;
-        r4: number;
         p0: number;
         p1: number;
         p2: number;
         p3: number;
         p4: number;
+        r0: number;
+        r1: number;
+        r2: number;
+        r3: number;
+        r4: number;
+        t0: number;
+        t1: number;
+        t2: number;
+        t3: number;
+        w: number;
     };
-    static JOINT_SEGMENTS: ("w" | "t0" | "t1" | "t2" | "t3" | "i0" | "i1" | "i2" | "i3" | "i4" | "m0" | "m1" | "m2" | "m3" | "m4" | "r0" | "r1" | "r2" | "r3" | "r4" | "p0" | "p1" | "p2" | "p3" | "p4")[][];
-    static JOINT_SEGMENT_STEPS: number[][];
-    static JOINT_TIPS: ("w" | "t0" | "t1" | "t2" | "t3" | "i0" | "i1" | "i2" | "i3" | "i4" | "m0" | "m1" | "m2" | "m3" | "m4" | "r0" | "r1" | "r2" | "r3" | "r4" | "p0" | "p1" | "p2" | "p3" | "p4")[];
-    static FINGER_TIPS: ("w" | "t0" | "t1" | "t2" | "t3" | "i0" | "i1" | "i2" | "i3" | "i4" | "m0" | "m1" | "m2" | "m3" | "m4" | "r0" | "r1" | "r2" | "r3" | "r4" | "p0" | "p1" | "p2" | "p3" | "p4")[];
-    static Hand: typeof Hand;
-    static HANDS: Hand[];
+    static readonly JOINT_SEGMENTS: ("i0" | "i1" | "i2" | "i3" | "i4" | "m0" | "m1" | "m2" | "m3" | "m4" | "p0" | "p1" | "p2" | "p3" | "p4" | "r0" | "r1" | "r2" | "r3" | "r4" | "t0" | "t1" | "t2" | "t3" | "w")[][];
+    static readonly JOINT_SEGMENT_STEPS: number[][];
+    static readonly JOINT_TIPS: ("i0" | "i1" | "i2" | "i3" | "i4" | "m0" | "m1" | "m2" | "m3" | "m4" | "p0" | "p1" | "p2" | "p3" | "p4" | "r0" | "r1" | "r2" | "r3" | "r4" | "t0" | "t1" | "t2" | "t3" | "w")[];
+    static readonly FINGER_TIPS: ("i0" | "i1" | "i2" | "i3" | "i4" | "m0" | "m1" | "m2" | "m3" | "m4" | "p0" | "p1" | "p2" | "p3" | "p4" | "r0" | "r1" | "r2" | "r3" | "r4" | "t0" | "t1" | "t2" | "t3" | "w")[];
+    static readonly Hand: typeof Hand;
+    static readonly HANDS: Hand[];
     left(): XrHand;
     right(): XrHand;
     updateControllers(camera: THREE.Camera): void;

package/dist/types/SplatAccumulator.d.ts

@@ -1,9 +1,9 @@
-import { FullScreenQuad } from 'three/addons/postprocessing/Pass.js';
-import { Readback } from './Readback';
-import { CovSplatGenerator, GsplatGenerator, SplatGenerator } from './SplatGenerator';
-import { SplatMesh } from './SplatMesh';
-import { DynoBool, DynoProgram, DynoProgramTemplate, DynoUsampler2DArray, DynoVec3 } from './dyno';
 import * as THREE from "three";
+import { FullScreenQuad } from "three/addons/postprocessing/Pass.js";
+import { Readback } from "./Readback";
+import { type CovSplatGenerator, type GsplatGenerator, SplatGenerator } from "./SplatGenerator";
+import { SplatMesh } from "./SplatMesh";
+import { DynoBool, DynoProgram, DynoProgramTemplate, DynoUsampler2DArray, DynoVec3 } from "./dyno";
 export type GeneratorMapping = {
     node: SplatGenerator;
     generator?: GsplatGenerator;
@@ -58,7 +58,7 @@ export declare class SplatAccumulator {
     };
     static programExtTemplate: DynoProgramTemplate;
     static programTemplate: DynoProgramTemplate;
-    static generatorProgram: WeakMap<GsplatGenerator | CovSplatGenerator, DynoProgram>;
+    static generatorProgram: WeakMap<CovSplatGenerator | GsplatGenerator, DynoProgram>;
     static fullScreenQuad: FullScreenQuad;
     generate({ generator, covGenerator, base, count, renderer, }: {
         generator?: GsplatGenerator;

package/dist/types/SplatEdit.d.ts

@@ -1,5 +1,5 @@
-import { CovSplat, DynoUniform, DynoVal, Gsplat } from './dyno';
 import * as THREE from "three";
+import { CovSplat, DynoUniform, type DynoVal, Gsplat } from "./dyno";
 export declare enum SplatEditSdfType {
     ALL = "all",
     PLANE = "plane",
@@ -24,6 +24,7 @@ export type SplatEditSdfOptions = {
     radius?: number;
 };
 export declare class SplatEditSdf extends THREE.Object3D {
+    readonly isSplatEditSdf = true;
     type: SplatEditSdfType;
     invert: boolean;
     opacity: number;
@@ -32,6 +33,7 @@ export declare class SplatEditSdf extends THREE.Object3D {
     radius: number;
     constructor(options?: SplatEditSdfOptions);
 }
+export declare function isSplatEditSdf(obj: THREE.Object3D): obj is SplatEditSdf;
 export type SplatEditOptions = {
     name?: string;
     rgbaBlendMode?: SplatEditRgbaBlendMode;
@@ -41,6 +43,7 @@ export type SplatEditOptions = {
     sdfs?: SplatEditSdf[];
 };
 export declare class SplatEdit extends THREE.Object3D {
+    readonly isSplatEdit = true;
     ordering: number;
     rgbaBlendMode: SplatEditRgbaBlendMode;
     sdfSmooth: number;
@@ -52,6 +55,7 @@ export declare class SplatEdit extends THREE.Object3D {
     addSdf(sdf: SplatEditSdf): void;
     removeSdf(sdf: SplatEditSdf): void;
 }
+export declare function isSplatEdit(obj: THREE.Object3D): obj is SplatEdit;
 export declare class SplatEdits {
     maxSdfs: number;
     numSdfs: number;

package/dist/types/SplatGenerator.d.ts

@@ -1,6 +1,6 @@
-import { SplatEdit } from './SplatEdit';
-import { CovSplat, Dyno, DynoFloat, DynoMat3, DynoVal, DynoVec3, DynoVec4, Gsplat } from './dyno';
 import * as THREE from "three";
+import type { SplatEdit } from "./SplatEdit";
+import { CovSplat, Dyno, DynoFloat, DynoMat3, type DynoVal, DynoVec3, DynoVec4, Gsplat } from "./dyno";
 export type GsplatGenerator = Dyno<{
     index: "int";
 }, {
@@ -62,7 +62,15 @@ export interface FrameUpdateContext {
         texture: THREE.DataTexture;
     };
 }
-export declare class SplatGenerator extends THREE.Object3D {
+export interface SplatGeneratorEventMap extends THREE.Object3DEventMap {
+    /**
+     * Dispatched when asynchronous initialization completes and the splats are
+     * ready to render. Not dispatched for splats that are initialized on
+     * construction
+     */
+    initialized: object;
+}
+export declare class SplatGenerator extends THREE.Object3D<SplatGeneratorEventMap> {
     numSplats: number;
     generator?: GsplatGenerator;
     covGenerator?: CovSplatGenerator;

package/dist/types/SplatLoader.d.ts

@@ -1,8 +1,8 @@
-import { FileLoader, Loader, LoadingManager } from 'three';
-import { ExtSplats } from './ExtSplats';
-import { PackedSplats } from './PackedSplats';
-import { SplatMesh } from './SplatMesh';
-import { SplatFileType } from './defines';
+import { FileLoader, Loader, type LoadingManager } from "three";
+import { ExtSplats } from "./ExtSplats";
+import { PackedSplats } from "./PackedSplats";
+import { SplatMesh } from "./SplatMesh";
+import { SplatFileType } from "./defines";
 export declare class SplatLoader extends Loader {
     fileLoader: FileLoader;
     constructor(manager?: LoadingManager);
@@ -142,23 +142,3 @@ export declare class SplatData {
     setSh2(index: number, sh2: Float32Array): void;
     setSh3(index: number, sh3: Float32Array): void;
 }
-export type FileInput = {
-    fileBytes: Uint8Array;
-    fileType?: SplatFileType;
-    pathOrUrl?: string;
-    transform?: {
-        translate?: number[];
-        quaternion?: number[];
-        scale?: number;
-    };
-};
-export type TranscodeSpzInput = {
-    inputs: FileInput[];
-    maxSh?: number;
-    clipXyz?: {
-        min: number[];
-        max: number[];
-    };
-    fractionalBits?: number;
-    opacityThreshold?: number;
-};

package/dist/types/SplatMesh.d.ts

@@ -1,15 +1,17 @@
-import { ExtSplats } from './ExtSplats';
-import { PackedSplats } from './PackedSplats';
-import { RgbaArray, TRgbaArray } from './RgbaArray';
-import { SplatEdit, SplatEdits } from './SplatEdit';
-import { CovSplatModifier, CovSplatTransformer, FrameUpdateContext, GsplatModifier, SplatGenerator, SplatTransformer } from './SplatGenerator';
-import { PagedSplats, SplatPager } from './SplatPager';
-import { SplatSkinning } from './SplatSkinning';
-import { SplatEncoding, SplatFileType } from './defines';
-import { DynoBool, DynoFloat, DynoInt, DynoUsampler2D, DynoVal, DynoVec4, Gsplat } from './dyno';
 import * as THREE from "three";
+import { ExtSplats } from "./ExtSplats";
+import { PackedSplats } from "./PackedSplats";
+import { type RgbaArray, TRgbaArray } from "./RgbaArray";
+import { type SplatEdit, SplatEdits } from "./SplatEdit";
+import { type CovSplatModifier, CovSplatTransformer, type FrameUpdateContext, type GsplatModifier, SplatGenerator, SplatTransformer } from "./SplatGenerator";
+import { PagedSplats, SplatPager } from "./SplatPager";
+import type { SplatSkinning } from "./SplatSkinning";
+import { type SplatEncoding, type SplatFileType } from "./defines";
+import { DynoBool, DynoFloat, DynoInt, DynoUsampler2D, type DynoVal, DynoVec4, Gsplat } from "./dyno";
 export type SplatMeshOptions = {
     url?: string;
+    requestHeader?: Record<string, string>;
+    withCredentials?: boolean;
     fileBytes?: Uint8Array | ArrayBuffer;
     fileType?: SplatFileType;
     fileName?: string;
@@ -35,7 +37,7 @@ export type SplatMeshOptions = {
     worldModifiers?: GsplatModifier[];
     covObjectModifiers?: CovSplatModifier[];
     covWorldModifiers?: CovSplatModifier[];
-    splatEncoding?: SplatEncoding;
+    splatEncoding?: Partial<SplatEncoding>;
     extSplats?: boolean | ExtSplats;
     covSplats?: boolean;
     lod?: boolean | "quality";

package/dist/types/SplatPager.d.ts

@@ -1,7 +1,7 @@
-import { dyno } from '.';
-import { SplatSource } from './SplatMesh';
-import { ExtResult, PackedResult, RadMeta, SplatEncoding, SplatFileType } from './defines';
 import * as THREE from "three";
+import type { SplatSource } from "./SplatMesh";
+import { type ExtResult, type PackedResult, type RadMeta, type SplatEncoding, SplatFileType } from "./defines";
+import * as dyno from "./dyno";
 export interface PagedSplatsOptions {
     pager?: SplatPager;
     rootUrl?: string;
@@ -44,7 +44,9 @@ export declare class PagedSplats implements SplatSource {
         chunksStart: number;
     }>;
     chunkUrl(chunk: number): string;
-    fetchDecodeChunk(chunk: number): Promise<PackedResult | ExtResult>;
+    fetchDecodeChunk(chunk: number): Promise<ExtResult | PackedResult>;
+    /** Draw nothing until the next update(), keeping the indices texture allocated. */
+    clear(): void;
     update(numSplats: number, indices: Uint32Array): void;
     prepareFetchSplat(): void;
     getNumSplats(): number;
@@ -86,6 +88,11 @@ export interface SplatPagerOptions {
      * @default 3
      */
     numFetchers?: number;
+    /**
+     * Called after each chunk fetch attempt settles (success or failure);
+     * a render is needed to page in the chunk or retry.
+     */
+    onUpdate: () => void;
 }
 export declare class SplatPager {
     readonly renderer: THREE.WebGLRenderer;
@@ -97,6 +104,7 @@ export declare class SplatPager {
     curSh: number;
     autoDrive: boolean;
     numFetchers: number;
+    onUpdate?: () => void;
     fetchPause: number;
     splatsChunkToPage: Map<PagedSplats, ({
         page: number;
@@ -186,6 +194,16 @@ export declare class SplatPager {
     private allocateFreeable;
     private processFetched;
     processUploads(): void;
+    /** True while chunk requests are in flight. */
+    isFetching(): boolean;
+    /**
+     * True while fetched chunks, uploads, or tree updates wait for Spark to
+     * consume them. Uploads already handed to Spark (flushed by its next LoD
+     * traverse via processUploads) are not counted.
+     */
+    hasQueued(): boolean;
+    /** True while chunks are being fetched or are waiting to be paged in. */
+    isPending(): boolean;
     consumeLodTreeUpdates(): {
         splats: PagedSplats;
         page: number;

package/dist/types/SplatSkinning.d.ts

@@ -1,6 +1,6 @@
-import { SplatMesh } from './SplatMesh';
-import { CovSplat, DynoUniform, DynoVal, Gsplat } from './dyno';
 import * as THREE from "three";
+import type { SplatMesh } from "./SplatMesh";
+import { CovSplat, DynoUniform, type DynoVal, Gsplat } from "./dyno";
 export declare enum SplatSkinningMode {
     DUAL_QUATERNION = "dual_quaternion",
     LINEAR_BLEND = "linear_blend"
@@ -41,11 +41,11 @@ export declare class SplatSkinning {
     setBoneMatrix(boneIndex: number, matrix: THREE.Matrix4): void;
     setSplatBones(splatIndex: number, boneIndices: THREE.Vector4, weights: THREE.Vector4): void;
     updateBones(): void;
-    private static UNIT_SCALE;
-    private static relQuat;
-    private static relPos;
-    private static dual;
-    private static skinMat;
+    private static readonly UNIT_SCALE;
+    private static readonly relQuat;
+    private static readonly relPos;
+    private static readonly dual;
+    private static readonly skinMat;
 }
 export declare const GsplatSkinning: {
     type: "GsplatSkinning";

package/dist/types/SplatWorker.d.ts

@@ -1,4 +1,4 @@
-import { rpcHandlers } from './worker';
+import type { rpcHandlers } from "./worker";
 type PromiseRecord = {
     resolve: (value: unknown) => void;
     reject: (reason?: unknown) => void;