three-vat 1.0.0 → 2.0.0

package/dist/instance-playback-BrGBIKLe.d.ts

@@ -1,109 +0,0 @@
-import { DataTexture, BufferGeometry, Material, Box3, InstancedMesh } from 'three';
-
-/** One baked animation range within a VAT's stacked frame rows. */
-interface VATClip {
-    /** Clip name, taken from the source `AnimationClip`. */
-    name: string;
-    /** First frame row (y) of this clip in the texture. */
-    startFrame: number;
-    /** Number of frame rows baked for this clip. */
-    frames: number;
-    /** Effective frames-per-second of the bake (`frames / duration`). */
-    fps: number;
-    /** Source clip duration in seconds. */
-    duration: number;
-    /**
-     * Largest per-vertex position-delta magnitude (metres) across the clip.
-     * Near-zero means the clip baked as a frozen pose — the diagnostic for a
-     * mis-targeted or genuinely static clip.
-     */
-    maxDelta: number;
-}
-/**
- * A baked Vertex Animation Texture: the position/normal `DataTexture`s, the
- * geometry they are indexed by, and the clip table and bounds needed to decode
- * and render them. Produced exactly one way — {@link bakeVAT}, at runtime, from
- * a loaded glTF (ADR-0010).
- *
- * The merged vertex ordering is the baker's own invention and the textures are
- * indexed by it (`x = gl_VertexID`), so the caller cannot bring its own
- * geometry — it must render the one baked here. `materials` is ordered to match
- * `geometry.groups[].materialIndex`, giving one draw call per material.
- */
-interface VAT {
-    /** RGBA float texture of per-vertex position deltas (`x = vertex`, `y = frame`). */
-    positionTexture: DataTexture;
-    /** RGBA float texture of per-vertex absolute normals (`x = vertex`, `y = frame`). */
-    normalTexture: DataTexture;
-    /** Merged, root-space rest-pose geometry. Its `position` is the delta reference. */
-    geometry: BufferGeometry;
-    /** Source materials, indexed by `geometry.groups[].materialIndex`. */
-    materials: Material[];
-    /** Clip table: name → `{ startFrame, frames, fps, ... }`. */
-    clips: VATClip[];
-    /** Union of every baked frame's bounds; use as the geometry bounding box. */
-    bounds: Box3;
-    /** Vertex count (texture width). */
-    vertexCount: number;
-    /** Total frame rows across all clips (texture height). */
-    totalFrames: number;
-    /** Position encoding. Only `'delta'` in v1. */
-    encoding: 'delta';
-}
-/**
- * The shared playback clock: one `{ value }` in seconds, read by every material
- * of every VAT mesh driven by it. Set it once per frame. Deliberately the
- * narrowest shape both decode paths satisfy — a WebGL `IUniform<number>` and a
- * TSL uniform node are both one of these — so `createVATMesh` returns the same
- * thing on either renderer.
- */
-interface VATClock {
-    value: number;
-}
-/**
- * A **crowd** ready to render: the mesh to add to the scene, and the clock to
- * advance. What `createVATMesh` returns on either decode path, so moving a
- * crowd between renderers is an import change and nothing else. Named for what
- * it is rather than for its `mesh` field — the clock is half of it.
- */
-interface VATCrowd {
-    /** Add to the scene. Its instance matrices are yours to write. */
-    mesh: InstancedMesh;
-    /** The shared playback clock — set `.value` once per frame. */
-    time: VATClock;
-}
-
-/** Per-instance playback state consumed by both decode paths. */
-interface VATInstance {
-    clip: Pick<VAT['clips'][number], 'startFrame' | 'frames' | 'fps'>;
-    /** Phase offset in seconds — desyncs the crowd. */
-    timeOffset: number;
-    /** Playback rate multiplier. */
-    speed: number;
-}
-/**
- * Attach the instance-playback attributes to an instanced geometry. Call once
- * before rendering, on the geometry you hand to the `InstancedMesh`.
- *
- * The attribute names and layout below are the shared contract, spelled once in
- * {@link PLAYBACK_ATTRIBUTES}. Both decode paths read exactly these five —
- * `DECODE_PRELUDE` in `src/webgl.ts` as GLSL attributes, `vatNodes` in
- * `src/tsl.ts` as TSL attribute nodes, when it is handed this geometry.
- *
- * | Attribute     | Type          | Source                |
- * | ------------- | ------------- | --------------------- |
- * | `aClipStart`  | `float` (x 1) | `instance.clip.startFrame` — first texture row of the clip's frame band |
- * | `aClipFrames` | `float` (x 1) | `instance.clip.frames` — rows in the band |
- * | `aClipFps`    | `float` (x 1) | `instance.clip.fps` — with `frames`, the clip's duration |
- * | `aTimeOffset` | `float` (x 1) | `instance.timeOffset` — phase, in seconds |
- * | `aSpeed`      | `float` (x 1) | `instance.speed` — rate multiplier |
- *
- * Every entry is a one-component `InstancedBufferAttribute` of `Float32Array`,
- * one element per instance, in instance order. Adding a field — crossfade's
- * reserved second clip index being the known case (ADR-0007) — means adding it
- * here, in the table above, and in each decode path's own attribute
- * declarations.
- */
-declare function addVATInstanceAttributes(geometry: BufferGeometry, instances: VATInstance[]): void;
-
-export { type VAT as V, type VATClip as a, type VATClock as b, type VATCrowd as c, type VATInstance as d, addVATInstanceAttributes as e };