@idetik/core 0.46.0 → 0.46.2

package/dist/index.d.ts

@@ -1316,6 +1316,11 @@ declare class Viewport {
     /** Input controls driving the camera. */
     cameraControls?: CameraControls;
     private layers_;
+    private layersChanged_;
+    private lastRenderBox_?;
+    private lastVisibility_?;
+    private readonly lastCameraTransform_;
+    private readonly lastProjection_;
     constructor(props: ViewportProps);
     /**
      * The layers rendered by this viewport in order. Layers with `occludes`
@@ -1337,6 +1342,8 @@ declare class Viewport {
     removeLayer(layer: Layer): void;
     /** Removes all layers from the viewport. */
     removeAllLayers(): void;
+    /** @hidden */
+    renderStateChanged(canvas: HTMLCanvasElement): boolean;
     /**
      * Syncs the camera's aspect ratio to the host element's size. Called
      * automatically when the host element resizes.
@@ -1429,7 +1436,9 @@ type LayerProps = {
  *     this.setState("ready");
  *   }
  *
- *   public update() {}
+ *   public update(): boolean {
+ *     return true;
+ *   }
  * }
  *
  * viewport.addLayer(new Particles(points));
@@ -1440,28 +1449,16 @@ type LayerProps = {
 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 renderStateChanged_;
     private opacity_;
+    private blendMode_;
+    private occludes_;
     /**
      * Creates a layer with the given presentation state.
      *
@@ -1474,6 +1471,23 @@ declare abstract class Layer {
      * sample. A layer cannot both occlude and read scene depth.
      */
     get requiresSceneDepth(): boolean;
+    /**
+     * How the layer's output blends with previously drawn content.
+     */
+    get blendMode(): BlendMode;
+    /** @param value - The blending mode to use. */
+    set blendMode(value: 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.
+     */
+    get occludes(): boolean;
+    /** @param value - Whether the layer writes depth. */
+    set occludes(value: boolean);
     /** The layer's opacity in `[0, 1]`. Values outside are clamped. */
     get opacity(): number;
     /** @param value - The new opacity in `[0, 1]`. */
@@ -1483,9 +1497,21 @@ declare abstract class Layer {
      * view. Called automatically once per frame for every layer in a
      * viewport.
      *
+     * Return `true` if this update changed the rendered output, otherwise
+     * return `false`. Changes marked by {@link invalidate} are tracked
+     * separately, so returning `false` does not discard them.
+     *
      * @param viewport - The viewport being rendered.
      */
-    abstract update(viewport?: Viewport): void;
+    abstract update(viewport?: Viewport): boolean;
+    /**
+     * Marks the layer's rendered output as changed. Call from setters or
+     * asynchronous callbacks when a change happens outside {@link update}.
+     * The runtime checks this flag on its next update.
+     */
+    protected invalidate(): void;
+    /** @hidden */
+    renderStateChanged(): boolean;
     /**
      * Handles a pointer or wheel event from the owning viewport. Called
      * automatically for each event before the camera controls. The default
@@ -1629,7 +1655,7 @@ declare class Stats {
 }
 
 /**
- * An object updated once per frame after all viewports have rendered.
+ * An object updated once per animation frame after any drawing.
  *
  * Overlays drive HUD elements that live outside the canvas such as scale
  * bars, time indicators, or memory readouts.
@@ -1645,7 +1671,7 @@ declare class Stats {
  * ```
  */
 type Overlay = {
-    /** Called once per rendered frame. */
+    /** Called every animation frame, including when drawing is skipped. */
     update: (idetik: Idetik) => void;
 };
 /**
@@ -1728,6 +1754,8 @@ declare class Idetik {
     private readonly sizeObserver_;
     private lastAnimationId_?;
     private lastTimestamp_;
+    private renderRequested_;
+    private renderInvalidated_;
     /**
      * Creates an Idetik runtime for the given canvas.
      *
@@ -1782,6 +1810,11 @@ declare class Idetik {
      * @param memoryLimitMB - The new budget in megabytes.
      */
     setMemoryLimitMB(memoryLimitMB: number): void;
+    /**
+     * Explicitly requests a draw on the next animation frame while running,
+     * even if no internal state has changed.
+     */
+    requestRender(): void;
     /**
      * Starts the render loop and connects input handlers.
      *
@@ -1789,8 +1822,10 @@ declare class Idetik {
      */
     start(): this;
     private detachRemovedLayers;
-    private renderViewport;
     private animate;
+    private invalidate;
+    private updateViewport;
+    private draw;
     /**
      * Stops the render loop and disconnects input handlers.
      */
@@ -2540,7 +2575,7 @@ declare class AxesLayer extends Layer {
      */
     constructor(props: AxesLayerProps);
     /** Performs no per-frame work. The axes are built at construction. */
-    update(): void;
+    update(): boolean;
 }
 
 /**
@@ -2657,7 +2692,7 @@ declare class ImageLayer extends Layer implements ChannelsEnabled {
      *
      * @param viewport - The viewport being rendered.
      */
-    update(viewport?: Viewport): void;
+    update(viewport?: Viewport): boolean;
     /** The slice plane the layer displays. */
     get orientation(): SliceOrientation;
     /**
@@ -2868,7 +2903,7 @@ declare class VolumeLayer extends Layer implements ChannelsEnabled {
      *
      * @param viewport - The viewport being rendered.
      */
-    update(viewport?: Viewport): void;
+    update(viewport?: Viewport): boolean;
     private rebuildObjects;
     /** @hidden */
     get chunkStoreView(): ChunkStoreView | undefined;
@@ -3066,7 +3101,7 @@ declare class LabelLayer extends Layer {
      *
      * @param viewport - The viewport being rendered.
      */
-    update(viewport?: Viewport): void;
+    update(viewport?: Viewport): boolean;
     /** The slice plane the layer displays. */
     get orientation(): SliceOrientation;
     /**
@@ -3251,7 +3286,9 @@ type PointProps = {
  *     this.setState("ready");
  *   }
  *
- *   public update() {}
+ *   public update(): boolean {
+ *     return true;
+ *   }
  * }
  * ```
  *