@idetik/core 0.40.0 → 0.40.2

package/dist/types/src/core/channel.d.ts

@@ -6,11 +6,17 @@ export type Channel = {
     contrastLimits: [number, number];
     opacity: number;
 };
-/** @group Layer Configuration */
+/**
+ * Appearance settings for a single image channel.
+ */
 export type ChannelProps = {
+    /** Whether the channel is drawn. Defaults to `true`. */
     visible?: boolean;
+    /** The channel's tint color. Defaults to white. */
     color?: ColorLike;
+    /** Intensity range shown. Defaults to the data range. */
     contrastLimits?: [number, number];
+    /** Channel opacity in `[0, 1]`. Defaults to `1`. */
     opacity?: number;
 };
 /** Layer that exposes channel controls. */

package/dist/types/src/core/channel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../../../src/core/channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,OAAO,EAA4B,MAAM,6BAA6B,CAAC;AAMhF,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;IACb,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,iCAAiC;AACjC,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,2CAA2C;AAC3C,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC;IACzC,eAAe,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACpD,iBAAiB,IAAI,IAAI,CAAC;IAC1B,wBAAwB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IACrD,2BAA2B,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CACzD;AAED,wBAAgB,eAAe,CAC7B,OAAO,EAAE,OAAO,GAAG,IAAI,EACvB,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,EAAE,YAAY,GACxD,OAAO,CAqBT;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,OAAO,GAAG,IAAI,EACvB,YAAY,EAAE,YAAY,EAAE,GAC3B,OAAO,EAAE,CAMX;AAED,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,YAAY,EAAE,GAAG,SAAS,EACxC,kBAAkB,EAAE,MAAM,GACzB,IAAI,CAON"}
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../../../src/core/channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,OAAO,EAA4B,MAAM,6BAA6B,CAAC;AAMhF,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;IACb,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,wDAAwD;IACxD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mDAAmD;IACnD,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,yDAAyD;IACzD,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,2CAA2C;AAC3C,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC;IACzC,eAAe,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACpD,iBAAiB,IAAI,IAAI,CAAC;IAC1B,wBAAwB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IACrD,2BAA2B,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CACzD;AAED,wBAAgB,eAAe,CAC7B,OAAO,EAAE,OAAO,GAAG,IAAI,EACvB,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,EAAE,YAAY,GACxD,OAAO,CAqBT;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,OAAO,GAAG,IAAI,EACvB,YAAY,EAAE,YAAY,EAAE,GAC3B,OAAO,EAAE,CAMX;AAED,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,YAAY,EAAE,GAAG,SAAS,EACxC,kBAAkB,EAAE,MAAM,GACzB,IAAI,CAON"}

package/dist/types/src/core/image_source_policy.d.ts

@@ -31,13 +31,13 @@ export type ImageSourcePolicy = Readonly<{
         bias: number;
     };
 }>;
-/** @group Layer Configuration */
+/** @hidden */
 export declare function createImageSourcePolicy(config: ImageSourcePolicyProps): ImageSourcePolicy;
-/** @group Layer Configuration */
+/** @hidden */
 export declare function createExplorationPolicy(overrides?: Partial<ImageSourcePolicyProps>): ImageSourcePolicy;
-/** @group Layer Configuration */
+/** @hidden */
 export declare function createPlaybackPolicy(overrides?: Partial<ImageSourcePolicyProps>): ImageSourcePolicy;
-/** @group Layer Configuration */
+/** @hidden */
 export declare function createNoPrefetchPolicy(overrides?: Partial<ImageSourcePolicyProps>): ImageSourcePolicy;
 export {};
 //# sourceMappingURL=image_source_policy.d.ts.map

package/dist/types/src/core/image_source_policy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image_source_policy.d.ts","sourceRoot":"","sources":["../../../../src/core/image_source_policy.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,cAAc,uGAMV,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE;QACR,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,CAAC,CAAC,EAAE,MAAM,CAAC;KACZ,CAAC;IACF,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC,GAAG,CAAC,EAAE;QACJ,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE;QACR,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF,aAAa,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC3C,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC;IACxD,GAAG,EAAE;QACH,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC,CAAC;AAEH,iCAAiC;AACjC,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,sBAAsB,GAC7B,iBAAiB,CAoCnB;AAED,iCAAiC;AACjC,wBAAgB,uBAAuB,CACrC,SAAS,GAAE,OAAO,CAAC,sBAAsB,CAAM,GAC9C,iBAAiB,CAanB;AAED,iCAAiC;AACjC,wBAAgB,oBAAoB,CAClC,SAAS,GAAE,OAAO,CAAC,sBAAsB,CAAM,GAC9C,iBAAiB,CAanB;AAED,iCAAiC;AACjC,wBAAgB,sBAAsB,CACpC,SAAS,GAAE,OAAO,CAAC,sBAAsB,CAAM,GAC9C,iBAAiB,CAanB"}
+{"version":3,"file":"image_source_policy.d.ts","sourceRoot":"","sources":["../../../../src/core/image_source_policy.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,cAAc,uGAMV,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE;QACR,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,CAAC,CAAC,EAAE,MAAM,CAAC;KACZ,CAAC;IACF,aAAa,EAAE,gBAAgB,EAAE,CAAC;IAClC,GAAG,CAAC,EAAE;QACJ,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE;QACR,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF,aAAa,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC3C,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC;IACxD,GAAG,EAAE;QACH,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH,CAAC,CAAC;AAEH,cAAc;AACd,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,sBAAsB,GAC7B,iBAAiB,CAoCnB;AAED,cAAc;AACd,wBAAgB,uBAAuB,CACrC,SAAS,GAAE,OAAO,CAAC,sBAAsB,CAAM,GAC9C,iBAAiB,CAanB;AAED,cAAc;AACd,wBAAgB,oBAAoB,CAClC,SAAS,GAAE,OAAO,CAAC,sBAAsB,CAAM,GAC9C,iBAAiB,CAanB;AAED,cAAc;AACd,wBAAgB,sBAAsB,CACpC,SAAS,GAAE,OAAO,CAAC,sBAAsB,CAAM,GAC9C,iBAAiB,CAanB"}

package/dist/types/src/core/layer.d.ts

@@ -2,63 +2,178 @@ import { IdetikContext } from "../idetik";
 import { RenderableObject } from "./renderable_object";
 import { EventContext } from "./event_dispatcher";
 import { Viewport } from "./viewport";
-/** @group Layers */
+/**
+ * The loading lifecycle state of a layer.
+ */
 export type LayerState = "initialized" | "loading" | "ready";
+/**
+ * How a layer's output blends with previously drawn content.
+ */
 export type BlendMode = "none" | "normal" | "additive" | "subtractive" | "multiply" | "premultipliedOver";
-type StateChangeCallback = (newState: LayerState, prevState?: LayerState) => void;
-export interface LayerProps {
+/**
+ * A callback invoked after a layer's state changes.
+ */
+export type StateChangeCallback = (newState: LayerState, prevState?: LayerState) => void;
+/**
+ * Initialization properties for constructing a layer.
+ */
+export type LayerProps = {
+    /** Layer opacity in `[0, 1]`. Defaults to `1`. */
     opacity?: number;
+    /** How the layer blends. Defaults to `"none"`. */
     blendMode?: BlendMode;
+    /** Hides content behind. Inferred from `blendMode`. */
     occludes?: boolean;
-}
+};
 /**
- * Abstract base class for everything that can be added to a viewport.
+ * Abstract base class for any layer that can be added to a viewport.
+ *
+ * A layer owns a set of renderable objects and contributes them to the
+ * scene each frame. Subclasses such as {@link ImageLayer},
+ * {@link VolumeLayer}, and {@link LabelLayer} implement {@link update} to
+ * build or refresh those objects for the current view. Custom layers
+ * register objects with {@link addObject} and report readiness through
+ * {@link setState}.
+ *
+ * Layers carry shared presentation state in {@link opacity},
+ * {@link blendMode}, and {@link occludes}, and expose a lifecycle
+ * {@link LayerState} that observers can subscribe to. A layer instance may
+ * be attached to only one viewport at a time.
+ *
+ * ```ts
+ * class Particles extends Layer {
+ *   public readonly type = "Particles";
  *
- * A `Layer` owns a set of renderable objects and contributes them to the scene
- * each frame. Subclasses (e.g. {@link ImageLayer}, {@link VolumeLayer},
- * {@link LabelLayer}) implement {@link Layer.update} to build or refresh those
- * objects for the current view, and may override the `attach`/`detach` hooks to
- * acquire and release resources when the layer joins or leaves a viewport.
+ *   constructor(points: PointProps[]) {
+ *     super();
+ *     this.addObject(new PointsRenderable(points));
+ *     this.setState("ready");
+ *   }
  *
- * Layers carry shared presentation state — {@link Layer.opacity} and blend mode —
- * and expose a lifecycle {@link LayerState} (`initialized` → `loading` → `ready`)
- * that observers can subscribe to. A layer instance may be attached to only one
- * viewport at a time.
+ *   public update() {}
+ * }
+ *
+ * viewport.addLayer(new Particles(points));
+ * ```
  *
  * @group Layers
  */
 export declare abstract class Layer {
+    /** A string identifying the concrete layer type. */
     abstract readonly type: string;
+    /**
+     * How the layer's output blends with previously drawn content. Also
+     * applies to blending between objects within the layer.
+     */
+    blendMode: BlendMode;
+    /**
+     * Whether the layer writes depth and hides content drawn behind it.
+     *
+     * Occluding layers render a depth pass and always draw before
+     * non-occluding layers regardless of their order in the viewport. When
+     * not set explicitly this value is inferred from `blendMode` at
+     * construction only. Reassigning {@link blendMode} later does not update
+     * it.
+     */
+    occludes: boolean;
+    /** Set to `true` by subclasses whose shaders read scene depth. */
+    protected requiresSceneDepth_: boolean;
     private readonly coverageGroups_;
     private state_;
     private attached_;
     private readonly callbacks_;
     private opacity_;
-    blendMode: BlendMode;
-    occludes: boolean;
-    protected requiresSceneDepth_: boolean;
+    /**
+     * Creates a layer with the given presentation state.
+     *
+     * @param props - Initialization properties.
+     */
     constructor({ opacity, blendMode, occludes, }?: LayerProps);
+    /**
+     * Whether the layer's shaders read scene depth. When `true` the renderer
+     * draws occluding layers to a depth texture the layer's shaders can
+     * sample. A layer cannot both occlude and read scene depth.
+     */
     get requiresSceneDepth(): boolean;
+    /** The layer's opacity in `[0, 1]`. Values outside are clamped. */
     get opacity(): number;
+    /** @param value - The new opacity in `[0, 1]`. */
     set opacity(value: number);
+    /**
+     * Builds or refreshes the layer's renderable objects for the current
+     * view. Called automatically once per frame for every layer in a
+     * viewport.
+     *
+     * @param viewport - The viewport being rendered.
+     */
     abstract update(viewport?: Viewport): void;
-    onEvent(_: EventContext): void;
+    /**
+     * Handles a pointer or wheel event from the owning viewport. Called
+     * automatically for each event before the camera controls. The default
+     * implementation does nothing.
+     *
+     * @param _event - The event with clip and world coordinates attached.
+     */
+    onEvent(_event: EventContext): void;
+    /**
+     * Lifecycle hook that is called automatically when a layer is
+     * is attached to a viewport. A layer can only be attached to one viewport
+     * at a time.
+     *
+     * @param context - The shared runtime context.
+     */
     onAttached(context: IdetikContext): void;
+    /**
+     * Lifecycle hook that is called automatically when a layer is detached
+     * from a viewport.
+     *
+     * @param context - The shared runtime context.
+     */
     onDetached(context: IdetikContext): void;
+    /** @hidden */
     protected attach(_context: IdetikContext): void;
+    /** @hidden */
     protected detach(_context: IdetikContext): void;
+    /**
+     * The layer's renderable objects grouped by coverage group. Objects in
+     * a group draw each pixel at most once, letting chunks at multiple
+     * levels of detail overlap correctly.
+     */
     get coverageGroups(): ReadonlyMap<number | null, readonly RenderableObject[]>;
+    /** The layer's current lifecycle state. */
     get state(): LayerState;
+    /**
+     * Registers a callback invoked after every state change.
+     *
+     * @param callback - Receives the new and previous states.
+     */
     addStateChangeCallback(callback: StateChangeCallback): void;
+    /**
+     * Removes a previously registered state change callback.
+     *
+     * @param callback - The callback to remove.
+     */
     removeStateChangeCallback(callback: StateChangeCallback): void;
+    /**
+     * Sets the lifecycle state and notifies state change callbacks.
+     *
+     * @param newState - The state to enter.
+     */
     protected setState(newState: LayerState): void;
+    /**
+     * Registers a renderable object for drawing. Objects in the same
+     * coverage group draw each pixel at most once.
+     *
+     * @param object - The object to add.
+     * @param coverageGroup - The group key.
+     */
     protected addObject(object: RenderableObject, coverageGroup?: number | null): void;
+    /** Removes all registered renderable objects. */
     protected clearObjects(): void;
     /**
-     * Get uniforms for shader program. Override in derived classes that need custom uniforms.
-     * @returns Object containing uniform name-value pairs
+     * Returns uniform name-value pairs applied to every object drawn by
+     * this layer. Override in subclasses that need custom shader uniforms.
      */
     getUniforms(): Record<string, unknown>;
 }
-export {};
 //# sourceMappingURL=layer.d.ts.map

package/dist/types/src/core/layer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"layer.d.ts","sourceRoot":"","sources":["../../../../src/core/layer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,oBAAoB;AACpB,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC;AAC7D,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,QAAQ,GACR,UAAU,GACV,aAAa,GACb,UAAU,GACV,mBAAmB,CAAC;AAExB,KAAK,mBAAmB,GAAG,CACzB,QAAQ,EAAE,UAAU,EACpB,SAAS,CAAC,EAAE,UAAU,KACnB,IAAI,CAAC;AAEV,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,KAAK;IACzB,kBAAyB,IAAI,EAAE,MAAM,CAAC;IAEtC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAG5B;IACJ,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA6B;IAExD,OAAO,CAAC,QAAQ,CAAS;IAElB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAEzB,SAAS,CAAC,mBAAmB,UAAS;gBAE1B,EACV,OAAa,EACb,SAAkB,EAClB,QAAQ,GACT,GAAE,UAAe;IAQlB,IAAW,kBAAkB,YAE5B;IAED,IAAW,OAAO,IAIQ,MAAM,CAF/B;IAED,IAAW,OAAO,CAAC,KAAK,EAAE,MAAM,EAQ/B;aAEe,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;IAE1C,OAAO,CAAC,CAAC,EAAE,YAAY,GAAG,IAAI;IAE9B,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAaxC,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAM/C,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAE/C,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAE/C,IAAW,cAAc,IAAI,WAAW,CACtC,MAAM,GAAG,IAAI,EACb,SAAS,gBAAgB,EAAE,CAC5B,CAEA;IAED,IAAW,KAAK,eAEf;IAEM,sBAAsB,CAAC,QAAQ,EAAE,mBAAmB;IAIpD,yBAAyB,CAAC,QAAQ,EAAE,mBAAmB;IAQ9D,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU;IAMvC,SAAS,CAAC,SAAS,CACjB,MAAM,EAAE,gBAAgB,EACxB,aAAa,GAAE,MAAM,GAAG,IAAW;IAUrC,SAAS,CAAC,YAAY;IAItB;;;OAGG;IACI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAG9C"}
+{"version":3,"file":"layer.d.ts","sourceRoot":"","sources":["../../../../src/core/layer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,SAAS,GAAG,OAAO,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,QAAQ,GACR,UAAU,GACV,aAAa,GACb,UAAU,GACV,mBAAmB,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,QAAQ,EAAE,UAAU,EACpB,SAAS,CAAC,EAAE,UAAU,KACnB,IAAI,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,kDAAkD;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,8BAAsB,KAAK;IACzB,oDAAoD;IACpD,kBAAyB,IAAI,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACI,SAAS,EAAE,SAAS,CAAC;IAE5B;;;;;;;;OAQG;IACI,QAAQ,EAAE,OAAO,CAAC;IAEzB,kEAAkE;IAClE,SAAS,CAAC,mBAAmB,UAAS;IAEtC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAG5B;IACJ,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA6B;IACxD,OAAO,CAAC,QAAQ,CAAS;IAEzB;;;;OAIG;gBACS,EACV,OAAa,EACb,SAAkB,EAClB,QAAQ,GACT,GAAE,UAAe;IAMlB;;;;OAIG;IACH,IAAW,kBAAkB,YAE5B;IAED,mEAAmE;IACnE,IAAW,OAAO,IAKQ,MAAM,CAH/B;IAED,kDAAkD;IAClD,IAAW,OAAO,CAAC,KAAK,EAAE,MAAM,EAQ/B;IAED;;;;;;OAMG;aACa,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI;IAEjD;;;;;;OAMG;IACI,OAAO,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAE1C;;;;;;OAMG;IACI,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAa/C;;;;;OAKG;IACI,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAM/C,cAAc;IACd,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAE/C,cAAc;IACd,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAE/C;;;;OAIG;IACH,IAAW,cAAc,IAAI,WAAW,CACtC,MAAM,GAAG,IAAI,EACb,SAAS,gBAAgB,EAAE,CAC5B,CAEA;IAED,2CAA2C;IAC3C,IAAW,KAAK,eAEf;IAED;;;;OAIG;IACI,sBAAsB,CAAC,QAAQ,EAAE,mBAAmB;IAI3D;;;;OAIG;IACI,yBAAyB,CAAC,QAAQ,EAAE,mBAAmB;IAQ9D;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,UAAU;IAMvC;;;;;;OAMG;IACH,SAAS,CAAC,SAAS,CACjB,MAAM,EAAE,gBAAgB,EACxB,aAAa,GAAE,MAAM,GAAG,IAAW;IAUrC,iDAAiD;IACjD,SAAS,CAAC,YAAY;IAItB;;;OAGG;IACI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAG9C"}

package/dist/types/src/core/renderable_object.d.ts

@@ -6,9 +6,49 @@ import { TrsTransform } from "../math/transforms";
 import { Shader } from "../renderers/shaders";
 import { Color } from "../math/color";
 import { CullingMode } from "../renderers/webgl_state";
+/**
+ * Abstract base class representing a {@link Layer}-renderable object.
+ *
+ * Renderables pair a geometry with a shader program, textures, uniform
+ * values, and a world transform. Subclasses assign a geometry, select one
+ * of the built-in shader programs through {@link programName} or provide
+ * a new one, bind textures with {@link setTexture}, and override {@link getUniforms} to
+ * feed values to the shader.
+ *
+ * ```ts
+ * class MyRenderable extends RenderableObject {
+ *   constructor(texture: Texture) {
+ *     super();
+ *     this.geometry = new PlaneGeometry(512, 512, 1, 1);
+ *     this.programName = "floatScalarImage";
+ *
+ *     this.setTexture(0, texture);
+ *   }
+ *
+ *   public get type() {
+ *     return "MyRenderable";
+ *   }
+ *
+ *   public override getUniforms() {
+ *     return { u_imageSampler: 0 };
+ *   }
+ * }
+ * ```
+ *
+ * @group Renderables
+ */
 export declare abstract class RenderableObject extends Node {
+    /**
+     * Draws the geometry's wireframe on top of the normal pass. Layers use
+     * this as a chunk debugging aid. Defaults to `false`.
+     */
     wireframeEnabled: boolean;
+    /** The color of the wireframe overlay. Defaults to `Color.WHITE`. */
     wireframeColor: Color;
+    /**
+     * Whether the object is depth tested when drawn. Objects that opt out
+     * are also left out of the depth prepass. Defaults to `true`.
+     */
     depthTest: boolean;
     private readonly textures_;
     private staleTextures_;
@@ -18,25 +58,90 @@ export declare abstract class RenderableObject extends Node {
     private programName_;
     private depthProgramName_;
     private cullFaceMode_;
+    /**
+     * Assigns a texture to the given texture unit. The renderer binds each
+     * entry of {@link textures} to its matching unit before drawing.
+     *
+     * @param index - The texture unit to bind to.
+     * @param texture - The texture to assign.
+     */
     setTexture(index: number, texture: Texture): void;
+    /**
+     * Removes all assigned textures.
+     */
     protected clearTextures(): void;
+    /**
+     * Queues a replaced texture for GPU disposal. Subclasses call this when
+     * swapping out a texture they own. The renderer drains the queue
+     * through {@link popStaleTextures} before the next draw. Passing
+     * `undefined` is a no-op.
+     *
+     * @param texture - The texture that is no longer in use.
+     */
     protected markStaleTexture(texture: Texture | undefined): void;
+    /**
+     * Drains the queue of textures marked stale. Called automatically by
+     * the renderer, which disposes the GPU resources of each returned
+     * texture.
+     *
+     * @returns The textures queued since the last call.
+     */
     popStaleTextures(): Texture[];
+    /**
+     * The geometry drawn for this object.
+     */
     get geometry(): Geometry;
+    /**
+     * A line-segment version of {@link geometry} used for the wireframe
+     * overlay. Built lazily on first access and cached until the geometry
+     * changes.
+     */
     get wireframeGeometry(): WireframeGeometry;
+    /** The assigned textures indexed by texture unit. */
     get textures(): Texture[];
+    /**
+     * The object's world transform as translation, rotation, and scale.
+     * Layers position, orient, and size renderables through it.
+     */
     get transform(): TrsTransform;
+    /** @param geometry - The geometry to draw. */
     set geometry(geometry: Geometry);
+    /**
+     * The name of a shader program that draws the object. The
+     * renderer skips objects whose program name is `null`.
+     */
     get programName(): Shader | null;
+    /**
+     * The name of the shader program used in the depth prepass or `null`
+     * to stay out of it. Objects without one never occlude other layers.
+     */
     get depthProgramName(): Shader | null;
-    get boundingBox(): import("../math/box3").Box3;
+    /**
+     * The geometry's bounding box transformed to world space. The renderer
+     * culls objects whose box falls outside the view frustum.
+     */
+    get boundingBox(): import("..").Box3;
+    /**
+     * @param programName - The shader program name.
+     */
     protected set programName(programName: Shader);
+    /**
+     * Selects the shader program for the depth prepass. Subclasses set
+     * this so the object writes depth and occludes content in other
+     * layers.
+     *
+     * @param programName - The shader program name.
+     */
     protected set depthProgramName(programName: Shader);
+    /** Which triangle faces are culled when drawing. Defaults to `"none"`. */
     get cullFaceMode(): CullingMode;
+    /** @param mode - The culling mode to apply. */
     set cullFaceMode(mode: CullingMode);
     /**
-     * Get uniforms for shader program. Override in derived classes that need custom uniforms.
-     * @returns Object containing uniform name-value pairs
+     * Returns the uniform values to upload before drawing. Override in
+     * subclasses that need custom uniforms. Values are matched to shader
+     * uniforms by name and take precedence over the owning layer's
+     * uniforms.
      */
     getUniforms(): Record<string, unknown>;
 }

package/dist/types/src/core/renderable_object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderable_object.d.ts","sourceRoot":"","sources":["../../../../src/core/renderable_object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,8BAAsB,gBAAiB,SAAQ,IAAI;IAC1C,gBAAgB,UAAS;IACzB,cAAc,QAAe;IAC7B,SAAS,UAAQ;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,kBAAkB,CAAkC;IAC5D,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,iBAAiB,CAAuB;IAChD,OAAO,CAAC,aAAa,CAAuB;IAErC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAIjD,SAAS,CAAC,aAAa;IAIvB,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS;IAMhD,gBAAgB;IAMvB,IAAW,QAAQ,IAiBW,QAAQ,CAfrC;IAED,IAAW,iBAAiB,sBAG3B;IAED,IAAW,QAAQ,cAElB;IAED,IAAW,SAAS,iBAEnB;IAED,IAAW,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAGrC;IAED,IAAW,WAAW,IAAI,MAAM,GAAG,IAAI,CAEtC;IAED,IAAW,gBAAgB,IAAI,MAAM,GAAG,IAAI,CAE3C;IAED,IAAW,WAAW,gCAIrB;IAED,SAAS,KAAK,WAAW,CAAC,WAAW,EAAE,MAAM,EAE5C;IAED,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAEjD;IAED,IAAW,YAAY,IAIO,WAAW,CAFxC;IAED,IAAW,YAAY,CAAC,IAAI,EAAE,WAAW,EAExC;IAED;;;OAGG;IACI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAG9C"}
+{"version":3,"file":"renderable_object.d.ts","sourceRoot":"","sources":["../../../../src/core/renderable_object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,8BAAsB,gBAAiB,SAAQ,IAAI;IACjD;;;OAGG;IACI,gBAAgB,UAAS;IAEhC,qEAAqE;IAC9D,cAAc,QAAe;IAEpC;;;OAGG;IACI,SAAS,UAAQ;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,kBAAkB,CAAkC;IAC5D,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,iBAAiB,CAAuB;IAChD,OAAO,CAAC,aAAa,CAAuB;IAE5C;;;;;;OAMG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAIjD;;OAEG;IACH,SAAS,CAAC,aAAa;IAIvB;;;;;;;OAOG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS;IAMvD;;;;;;OAMG;IACI,gBAAgB;IAMvB;;OAEG;IACH,IAAW,QAAQ,IA4BW,QAAQ,CA1BrC;IAED;;;;OAIG;IACH,IAAW,iBAAiB,sBAG3B;IAED,qDAAqD;IACrD,IAAW,QAAQ,cAElB;IAED;;;OAGG;IACH,IAAW,SAAS,iBAEnB;IAED,8CAA8C;IAC9C,IAAW,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAGrC;IAED;;;OAGG;IACH,IAAW,WAAW,IAAI,MAAM,GAAG,IAAI,CAEtC;IAED;;;OAGG;IACH,IAAW,gBAAgB,IAAI,MAAM,GAAG,IAAI,CAE3C;IAED;;;OAGG;IACH,IAAW,WAAW,sBAIrB;IAED;;OAEG;IACH,SAAS,KAAK,WAAW,CAAC,WAAW,EAAE,MAAM,EAE5C;IAED;;;;;;OAMG;IACH,SAAS,KAAK,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAEjD;IAED,0EAA0E;IAC1E,IAAW,YAAY,IAKO,WAAW,CAHxC;IAED,+CAA+C;IAC/C,IAAW,YAAY,CAAC,IAAI,EAAE,WAAW,EAExC;IAED;;;;;OAKG;IACI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAG9C"}

package/dist/types/src/core/viewport.d.ts

@@ -5,40 +5,120 @@ import { Box2 } from "../math/box2";
 import { vec2, vec3 } from "gl-matrix";
 import { EventDispatcher } from "./event_dispatcher";
 import { IdetikContext } from "../idetik";
-export interface ViewportProps {
+/**
+ * Initialization properties for constructing a viewport.
+ */
+export type ViewportProps = {
+    /** Unique id. Defaults to the element id or a generated id. */
     id?: string;
+    /** Host element. Defaults to the Idetik canvas. */
     element?: HTMLElement;
+    /** The camera the viewport renders with. */
     camera: Camera;
+    /** Layers to render in order. */
     layers?: Layer[];
+    /** Input controls driving the camera. */
     cameraControls?: CameraControls;
-}
+};
 interface ResolvedViewportProps extends ViewportProps {
     id: string;
     element: HTMLElement;
     context: IdetikContext;
 }
+/**
+ * A region of the canvas that renders a stack of layers through a camera.
+ *
+ * Every viewport draws into the shared canvas through the area of its host
+ * element. The element defaults to the canvas itself and must be unique
+ * across viewports.
+ *
+ * Viewports also route input. Pointer and wheel events on the host element
+ * are enriched with clip and world coordinates and a picking ray, sent to
+ * each layer in order and passed to the camera controls unless a layer stops
+ * propagation.
+ *
+ * ```ts
+ * const idetik = new Idetik({
+ *   canvas,
+ *   viewports: [{ id: 'main', camera, layers: [imageLayer] }],
+ * });
+ *
+ * const viewport = idetik.getViewport('main')!;
+ * viewport.addLayer(labelLayer);
+ * ```
+ *
+ * @group Core
+ */
 export declare class Viewport {
+    /** The viewport's unique identifier. */
     readonly id: string;
+    /** The host element defining the viewport's area. */
     readonly element: HTMLElement;
+    /** The camera the viewport renders with. */
     readonly camera: Camera;
+    /** The pointer and wheel event dispatcher for the host element. */
     readonly events: EventDispatcher;
+    /** Input controls driving the camera. */
     cameraControls?: CameraControls;
     private readonly context_;
     private layers_;
+    /** @hidden */
     constructor(props: ResolvedViewportProps);
+    /**
+     * The layers rendered by this viewport in order. Layers with `occludes`
+     * set draw before non-occluding layers regardless of stack order.
+     */
     get layers(): readonly Layer[];
+    /**
+     * Adds a layer to the top of the stack.
+     *
+     * @param layer - The layer to add.
+     */
     addLayer(layer: Layer): void;
+    /**
+     * Removes a previously added layer.
+     *
+     * @param layer - The layer to remove.
+     */
     removeLayer(layer: Layer): void;
+    /** Removes all layers from the viewport. */
     removeAllLayers(): void;
+    /**
+     * Syncs the camera's aspect ratio to the host element's size. Called
+     * automatically when the host element resizes.
+     */
     updateSize(): void;
+    /**
+     * Computes the viewport's box relative to the given canvas in device pixels.
+     *
+     * @param canvas - The canvas to compute the box against.
+     * @returns The viewport's box in the canvas's coordinate space.
+     */
     getBoxRelativeTo(canvas: HTMLCanvasElement): Box2;
+    /**
+     * The viewport's rectangle in the drawing buffer in device pixels.
+     */
     getBufferRect(): {
         x: number;
         y: number;
         width: number;
         height: number;
     };
+    /**
+     * Converts a client-space position to clip space. The `y` axis points
+     * down, matching the renderer's mirrored projection.
+     *
+     * @param position - The client-space position to convert.
+     * @param depth - The clip-space z value.
+     */
     clientToClip(position: vec2, depth?: number): vec3;
+    /**
+     * Converts a client-space position such as a pointer location to world
+     * space.
+     *
+     * @param position - The client-space position to convert.
+     * @param depth - The clip-space z value.
+     */
     clientToWorld(position: vec2, depth?: number): vec3;
     private getBox;
     private updateAspectRatio;

package/dist/types/src/core/viewport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"viewport.d.ts","sourceRoot":"","sources":["../../../../src/core/viewport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGvC,OAAO,EAAgB,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEnE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,MAAM,WAAW,aAAa;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,UAAU,qBAAsB,SAAQ,aAAa;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,aAAa,CAAC;CACxB;AAED,qBAAa,QAAQ;IACnB,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,SAAgB,OAAO,EAAE,WAAW,CAAC;IACrC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,MAAM,EAAE,eAAe,CAAC;IACjC,cAAc,CAAC,EAAE,cAAc,CAAC;IAKvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IAEzC,OAAO,CAAC,OAAO,CAAe;gBAElB,KAAK,EAAE,qBAAqB;IAkCxC,IAAW,MAAM,IAAI,SAAS,KAAK,EAAE,CAEpC;IAEM,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAK5B,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAS/B,eAAe,IAAI,IAAI;IAOvB,UAAU,IAAI,IAAI;IAIlB,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IA0BjD,aAAa,IAAI;QACtB,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB;IAIM,YAAY,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,GAAE,MAAU,GAAG,IAAI;IAUrD,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,GAAE,MAAU,GAAG,IAAI;IAK7D,OAAO,CAAC,MAAM;IAed,OAAO,CAAC,iBAAiB;CAY1B;AAED,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,WAAW,CAAA;CAAE,EAC9C,iBAAiB,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,WAAW,CAAA;CAAE,EAAE,GACxD,IAAI,CAmBN;AAQD,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,aAAa,EAAE,EACtB,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,aAAa,GACrB,QAAQ,EAAE,CAYZ"}
+{"version":3,"file":"viewport.d.ts","sourceRoot":"","sources":["../../../../src/core/viewport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGvC,OAAO,EAAgB,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEnE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,+DAA+D;IAC/D,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,mDAAmD;IACnD,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,yCAAyC;IACzC,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,UAAU,qBAAsB,SAAQ,aAAa;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,aAAa,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,QAAQ;IACnB,wCAAwC;IACxC,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,qDAAqD;IACrD,SAAgB,OAAO,EAAE,WAAW,CAAC;IACrC,4CAA4C;IAC5C,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,mEAAmE;IACnE,SAAgB,MAAM,EAAE,eAAe,CAAC;IACxC,yCAAyC;IAClC,cAAc,CAAC,EAAE,cAAc,CAAC;IAKvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IAEzC,OAAO,CAAC,OAAO,CAAe;IAE9B,cAAc;gBACF,KAAK,EAAE,qBAAqB;IAkCxC;;;OAGG;IACH,IAAW,MAAM,IAAI,SAAS,KAAK,EAAE,CAEpC;IAED;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAKnC;;;;OAIG;IACI,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAStC,4CAA4C;IACrC,eAAe,IAAI,IAAI;IAO9B;;;OAGG;IACI,UAAU,IAAI,IAAI;IAIzB;;;;;OAKG;IACI,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IA0BxD;;OAEG;IACI,aAAa,IAAI;QACtB,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB;IAID;;;;;;OAMG;IACI,YAAY,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,GAAE,MAAU,GAAG,IAAI;IAU5D;;;;;;OAMG;IACI,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,GAAE,MAAU,GAAG,IAAI;IAK7D,OAAO,CAAC,MAAM;IAed,OAAO,CAAC,iBAAiB;CAY1B;AAED,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,WAAW,CAAA;CAAE,EAC9C,iBAAiB,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,WAAW,CAAA;CAAE,EAAE,GACxD,IAAI,CAmBN;AAQD,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,aAAa,EAAE,EACtB,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,aAAa,GACrB,QAAQ,EAAE,CAYZ"}

package/dist/types/src/data/chunk.d.ts

@@ -42,32 +42,67 @@ export type Chunk = {
         z: number;
     };
 } & ChunkViewState;
+/**
+ * Per-axis dimension metadata for a multiscale image source.
+ *
+ * Maps the spatial axes `x`, `y`, `z` and the non-spatial axes `c` and
+ * `t` onto the source's stored dimensions.
+ */
 export type SourceDimensionMap = {
+    /** The `x` spatial dimension. */
     x: SourceDimension;
+    /** The `y` spatial dimension. */
     y: SourceDimension;
+    /** The `z` spatial dimension if present. */
     z?: SourceDimension;
+    /** The channel dimension if present. */
     c?: SourceDimension;
+    /** The time dimension if present. */
     t?: SourceDimension;
+    /** Number of levels of detail in the pyramid. */
     numLods: number;
 };
+/**
+ * One dimension of a multiscale image source.
+ */
 export type SourceDimension = {
+    /** Axis name from the source metadata. */
     name: string;
+    /** Position of the axis in the stored arrays. */
     index: number;
+    /** Physical unit if declared in the metadata. */
     unit?: string;
+    /** Per-LOD metadata ordered finest first. */
     lods: SourceDimensionLod[];
 };
-type SourceDimensionLod = {
+/**
+ * Metadata for one dimension at one level of detail.
+ *
+ * Combines array metadata with the OME-Zarr coordinate transform.
+ */
+export type SourceDimensionLod = {
+    /** Extent of the dimension in array elements. */
     size: number;
+    /** Chunk extent along the dimension in elements. */
     chunkSize: number;
+    /** World units per array element. */
     scale: number;
+    /** World coordinate of the first element. */
     translation: number;
 };
-/** @group Layer Configuration */
+/**
+ * World-space coordinates selecting the data to display.
+ */
 export type SliceCoordinates = {
+    /** Position on the `x` axis in world units. */
     x?: number;
+    /** Position on the `y` axis in world units. */
     y?: number;
+    /** Position on the `z` axis in world units. */
     z?: number;
+    /** Channel indices to load. Defaults to all channels. */
     c?: number[];
+    /** The time point to display. */
     t?: number;
 };
 export type ChunkSource = {

package/dist/types/src/data/chunk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chunk.d.ts","sourceRoot":"","sources":["../../../../src/data/chunk.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,yBAAyB,EAC1B,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,IAAI,EAAQ,MAAM,WAAW,CAAC;AACvC,OAAO,EAAiB,SAAS,EAAE,MAAM,cAAc,CAAC;AAExD,QAAA,MAAM,cAAc,+KAQV,CAAC;AACX,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AACnE,MAAM,MAAM,SAAS,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;AAE3D,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAU9D;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,KAAK,EAAE,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IACpD,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QACL,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF,iBAAiB,EAAE,yBAAyB,CAAC;IAC7C,UAAU,EAAE;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF,KAAK,EAAE;QACL,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF,MAAM,EAAE;QACN,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;CACH,GAAG,cAAc,CAAC;AAInB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,EAAE,eAAe,CAAC;IACnB,CAAC,EAAE,eAAe,CAAC;IACnB,CAAC,CAAC,EAAE,eAAe,CAAC;IACpB,CAAC,CAAC,EAAE,eAAe,CAAC;IACpB,CAAC,CAAC,EAAE,eAAe,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAGF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,kBAAkB,EAAE,CAAC;CAC5B,CAAC;AAMF,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,iCAAiC;AACjC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;IACb,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,MAAM,IAAI,WAAW,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,IAAI,kBAAkB,CAAC;IAE5C,kBAAkB,IAAI,MAAM,CAAC;IAE7B,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE,CAAC;AAEF,wBAAgB,YAAY,CAAC,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3E;AAED,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,kBAAkB,EACvB,KAAK,EAAE,MAAM,GACZ,MAAM,CAGR;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,CAW3E"}
+{"version":3,"file":"chunk.d.ts","sourceRoot":"","sources":["../../../../src/data/chunk.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,yBAAyB,EAC1B,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,IAAI,EAAQ,MAAM,WAAW,CAAC;AACvC,OAAO,EAAiB,SAAS,EAAE,MAAM,cAAc,CAAC;AAExD,QAAA,MAAM,cAAc,+KAQV,CAAC;AACX,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AACnE,MAAM,MAAM,SAAS,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC;AAE3D,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAU9D;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,KAAK,EAAE,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IACpD,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QACL,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF,iBAAiB,EAAE,yBAAyB,CAAC;IAC7C,UAAU,EAAE;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF,KAAK,EAAE;QACL,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF,MAAM,EAAE;QACN,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;CACH,GAAG,cAAc,CAAC;AAInB;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iCAAiC;IACjC,CAAC,EAAE,eAAe,CAAC;IACnB,iCAAiC;IACjC,CAAC,EAAE,eAAe,CAAC;IACnB,4CAA4C;IAC5C,CAAC,CAAC,EAAE,eAAe,CAAC;IACpB,wCAAwC;IACxC,CAAC,CAAC,EAAE,eAAe,CAAC;IACpB,qCAAqC;IACrC,CAAC,CAAC,EAAE,eAAe,CAAC;IACpB,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,IAAI,EAAE,kBAAkB,EAAE,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,+CAA+C;IAC/C,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,+CAA+C;IAC/C,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,+CAA+C;IAC/C,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,yDAAyD;IACzD,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;IACb,iCAAiC;IACjC,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,MAAM,IAAI,WAAW,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,IAAI,kBAAkB,CAAC;IAE5C,kBAAkB,IAAI,MAAM,CAAC;IAE7B,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE,CAAC;AAEF,wBAAgB,YAAY,CAAC,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE3E;AAED,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,kBAAkB,EACvB,KAAK,EAAE,MAAM,GACZ,MAAM,CAGR;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,CAW3E"}

package/dist/types/src/data/chunk_manager.d.ts

@@ -3,8 +3,13 @@ import { SliceAxes } from "../math/axes";
 import { ChunkStoreView } from "./chunk_store_view";
 import { ImageSourcePolicy } from "../core/image_source_policy";
 import { Texture } from "../objects/textures/texture";
+/**
+ * A snapshot of the chunk request queue.
+ */
 export type QueueStats = {
+    /** Number of requests waiting to start. */
     pending: number;
+    /** Number of requests currently in flight. */
     running: number;
 };
 export declare class ChunkManager {