@micrio/client 5.5.6 → 6.0.1

package/micrio.min.d.ts

@@ -14,6 +14,10 @@ declare module '@micrio/client' {
 	export const loadTexture: (src: string) => Promise<TextureBitmap>;
 	/** Type for error codes */
 	export type ErrorCode = typeof ErrorCodes[keyof typeof ErrorCodes];
+	/**
+	 * Calculates the positive modulo (floored division remainder).
+	 */
+	export const mod: (n: number, m?: number) => number;
 	/**
 	 * Converts seconds into a human-readable time string (hh?:mm:ss).
 	 * @param s Time in seconds. Can be negative for remaining time display.
@@ -182,6 +186,9 @@ declare module '@micrio/client' {
 		readonly center: Models.Camera.Coords;
 		/** CORRECT view: [x0, y0, width, height] */
 		private readonly view;
+		private _getXY;
+		private _getCoo;
+		private _setMinScale;
 		/**
 		 * Gets the current image view rectangle.
 		 * @returns A copy of the current screen viewport array, or undefined if not initialized.
@@ -207,7 +214,7 @@ declare module '@micrio/client' {
 			noLimit?: boolean;
 			/** If true (for 360), corrects the view based on the `trueNorth` setting. */
 			correctNorth?: boolean;
-			/** If true, prevents triggering a Wasm render after setting the view. */
+			/** If true, prevents triggering a render after setting the view. */
 			noRender?: boolean;
 			/** If provided, interprets `view` relative to this sub-area instead of the full image. */
 			area?: Models.Camera.ViewRect;
@@ -265,33 +272,14 @@ declare module '@micrio/client' {
 		setScale: (s: number) => void;
 		/** Gets the scale at which the image fully covers the viewport. */
 		getCoverScale: () => number;
-		/**
-		 * Gets the minimum allowed zoom scale for the image.
-		 * @returns The minimum scale.
-		*/
 		getMinScale: () => number;
-		/**
-		 * Sets the minimum allowed zoom scale.
-		 * @param s The minimum scale to set.
-		*/
 		setMinScale(s: number): void;
-		/**
-		 * Sets the minimum screen size the image should occupy when zooming out (0-1).
-		 * Allows zooming out further than the image boundaries, creating margins.
-		 * Note: Does not work with albums.
-		 * @param s The minimum screen size fraction (0-1).
-		*/
 		setMinScreenSize(s: number): void;
-		/** Returns true if the camera is currently zoomed in to its maximum limit. */
 		isZoomedIn: () => boolean;
-		/**
-		 * Returns true if the camera is currently zoomed out to its minimum limit.
-		 * @param full If true, checks against the absolute minimum scale (ignoring `setMinScreenSize`).
-		*/
 		isZoomedOut: (full?: boolean) => boolean;
 		/**
 		 * Sets a rectangular limit for camera navigation within the image.
-		 * @param l The viewport limit rectangle [x0, y0, x1, y1].
+		 * @param v The viewport limit rectangle [x0, y0, x1, y1].
 		*/
 		setLimit(v: Models.Camera.ViewRect): void;
 		/**
@@ -299,14 +287,12 @@ declare module '@micrio/client' {
 		 * @param b If true, limits the view to cover the screen.
 		*/
 		setCoverLimit(b: boolean): void;
-		/** Gets whether the cover limit is currently enabled. */
 		getCoverLimit: () => boolean;
-		/**
-		 * Limits the horizontal and vertical viewing range for 360 images.
-		 * @param xPerc The horizontal arc limit as a percentage (0-1, where 1 = 360°). 0 disables horizontal limit.
-		 * @param yPerc The vertical arc limit as a percentage (0-1, where 1 = 180°). 0 disables vertical limit.
-		*/
+		stop(): void;
+		pause(): void;
+		resume(): void;
 		set360RangeLimit(xPerc?: number, yPerc?: number): void;
+		aniIsKinetic(): boolean;
 		/**
 		 * Animates the camera smoothly to a target viewport.
 		 * @param view The target viewport as either a View [x0, y0, x1, y1] or View {centerX, centerY, width, height}.
@@ -354,11 +340,11 @@ declare module '@micrio/client' {
 		 * @param duration Forced duration in ms (0 for instant).
 		 * @param x Screen pixel X-coordinate for zoom focus (optional, defaults to center).
 		 * @param y Screen pixel Y-coordinate for zoom focus (optional, defaults to center).
-		 * @param speed Animation speed multiplier (optional).
+		 * @param _speed Animation speed multiplier (optional).
 		 * @param noLimit If true, allows zooming beyond image boundaries.
 		 * @returns A Promise that resolves when the zoom animation completes.
 		 */
-		zoom: (delta: number, duration?: number, x?: number | undefined, y?: number | undefined, speed?: number, noLimit?: boolean) => Promise<void>;
+		zoom: (delta: number, duration?: number, x?: number | undefined, y?: number | undefined, _speed?: number, noLimit?: boolean) => Promise<void>;
 		/**
 		 * Zooms in by a specified factor.
 		 * @param factor Zoom factor (e.g., 1 = standard zoom step).
@@ -386,29 +372,12 @@ declare module '@micrio/client' {
 			render?: boolean;
 			noLimit?: boolean;
 		}): void;
-		/** Stops any currently running camera animation immediately. */
-		stop(): void;
-		/** Pauses the current camera animation. */
-		pause(): void;
-		/** Resumes a paused camera animation. */
-		resume(): void;
-		/** Returns true if the camera is currently performing a kinetic pan/zoom (coasting). */
-		aniIsKinetic(): boolean;
 		/** Gets the current viewing direction (yaw) in 360 mode.
 		 * @returns The current yaw in radians.
 		 */
 		getDirection: () => number;
-		/**
-		 * Sets the viewing direction (yaw and optionally pitch) instantly in 360 mode.
-		 * @param yaw The target yaw in radians.
-		 * @param pitch Optional target pitch in radians.
-		*/
-		setDirection(yaw: number, pitch?: number): void;
-		/**
-		 * Gets the current viewing pitch in 360 mode.
-		 * @returns The current pitch in radians.
-		*/
 		getPitch: () => number;
+		setDirection(yaw: number, pitch?: number): void;
 		/**
 		 * Sets the rendering area for this image within the main canvas.
 		 * Used for split-screen and potentially other layout effects. Animates by default.
@@ -420,7 +389,7 @@ declare module '@micrio/client' {
 			direct?: boolean;
 			/** If true, prevents dispatching view updates during the animation. */
 			noDispatch?: boolean;
-			/** If true, prevents triggering a Wasm render after setting the area. */
+			/** If true, prevents triggering a render after setting the area. */
 			noRender?: boolean;
 		}): void;
 		/** Sets the 3D rotation for an embedded image (used for placing embeds in 360 space). */
@@ -431,52 +400,90 @@ declare module '@micrio/client' {
 		getOmniFrame(rot?: number): number | undefined;
 		/** [Omni] Gets the screen coordinates [x, y, scale, depth] for given 3D object coordinates. */
 		getOmniXY(x: number, y: number, z: number): Float64Array;
-		/** [Omni] Applies Omni-specific camera settings (distance, FoV, angle) to Wasm. */
+		/** [Omni] Applies Omni-specific camera settings (distance, FoV, angle) to the engine canvas. */
 		setOmniSettings(): void;
 	}
 	/**
-	 * The main WebAssembly controller class. Handles interaction between JavaScript
-	 * and the compiled C++ core of Micrio. Accessed via `micrio.wasm`.
+	 * The main Micrio compute controller class. Handles the engine lifecycle,
+	 * render loop, tile management, and WebGL integration.
+	 * Accessed via `micrio.engine`.
 	 */
-	export class Wasm {
+	export class Engine {
 		micrio: HTMLMicrioElement;
-		/** Flag indicating if the Wasm module has been loaded and initialized. */
 		ready: boolean;
-		/** Shared WebAssembly memory instance. */
-		private memory;
 		/** Forget in-memory tiles after X seconds not drawn */
 		private deleteAfterSeconds;
-		/**
-		 * Creates the Wasm controller instance.
-		 * @param micrio The main HTMLMicrioElement instance.
-		*/
+		preventDirectionSet: boolean;
+		/** Shared Float32Array for standard tile vertex data. */
+		_vertexBuffer: Float32Array;
+		/** Static Float32Array holding texture coordinates for a standard quad. */
+		static readonly _textureBuffer: Float32Array;
+		/** Shared Float32Array for 360 tile vertex data. */
+		_vertexBuffer360: Float32Array;
+		/** Static Float32Array holding texture coordinates for the 360 sphere. */
+		static _textureBuffer360: Float32Array;
+		/** Flag indicating if the current context is a gallery. */
+		private isGallery;
+		private now;
+		private raf;
+		private drawing;
 		constructor(micrio: HTMLMicrioElement);
 		/**
-		 * Loads and instantiates the WebAssembly module.
-		 * @returns A Promise that resolves when the Wasm module is ready.
-		 * @throws Error if WebAssembly binary loading or instantiation fails
-		*/
+		 * Initializes the engine (replaces WebAssembly loading).
+		 * @throws Error if engine initialization fails
+		 */
 		load(): Promise<void>;
+		private _hostDrawQuad;
+		private _hostGetTileOpacity;
+		private _hostSetTileOpacity;
+		private _hostSetMatrix;
+		private _hostSetViewport;
+		private _hostAniDone;
+		private _hostAniAbort;
+		private _hostViewSet;
+		private _hostViewportSet;
+		private _hostSetCanvasVisible;
+		private _hostSetImageVisible;
 		/** Unbinds event listeners, stops rendering, and cleans up resources. */
 		unbind(): void;
 		/**
-		 * Sets the currently active canvas/image instance in the Wasm module.
-		 * Handles adding the canvas to Wasm if it's not already initialized.
-		 * @param canvas The MicrioImage instance to set as active.
-		*/
+		 * Sets the currently active canvas/image instance in the engine.
+		 */
 		setCanvas(canvas?: MicrioImage): void;
-		/** Removes a canvas instance from the Wasm module. */
+		/** Removes a canvas instance from the engine. */
 		removeCanvas(c: MicrioImage): void;
-		/** Requests the next animation frame to trigger the `draw` method. */
+		/** Requests the next animation frame. */
 		render(): void;
+		/**
+		 * Callback for the engine to request drawing a tile.
+		 * @returns True if the tile texture is ready and drawn, false otherwise.
+		 */
+		private drawTile;
 		/** Add a child image to the current canvas, either embed or independent canvas */
 		private addImage;
-		/** Add a child independent canvas to the current canvas, used for grid images
-		 * @param image The image
-		 * @param parent The parent image
-		 * @returns Promise when the image is added
-		 */
+		/** Add a child independent canvas to the current canvas */
 		addChild: (image: MicrioImage, parent: MicrioImage) => Promise<void>;
+		setZIndex(ptr: number, z: number): void;
+		setGridTransitionDuration(dur: number): void;
+		setGridTransitionTimingFunction(fn: number): void;
+		setCrossfadeDuration(dur: number): void;
+		fadeTo(ptr: number, opacity: number, direct: boolean): void;
+		fadeIn(ptr: number): void;
+		fadeOut(ptr: number): void;
+		areaAnimating(ptr: number): boolean;
+		getActiveImageIdx(ptr: number): number;
+		setNoPinchPan(v: boolean): void;
+		setIsSwipe(v: boolean): void;
+		ease(p: number): number;
+		panStart(ptr: number): void;
+		panStop(ptr: number): void;
+		pinchStart(ptr: number): void;
+		pinch(ptr: number, x0: number, y0: number, x1: number, y1: number): void;
+		pinchStop(ptr: number, t: number): void;
+		setLimited(ptr: number, v: boolean): void;
+		set360Orientation(d: number, dX: number, dY: number): void;
+		setCanvasArea(w: number, h: number): void;
+		setImageVideoPlaying(ptr: number, playing: boolean): void;
 	}
 	/**
 	 * Handles swipe gestures for navigating image sequences, particularly for
@@ -488,7 +495,7 @@ declare module '@micrio/client' {
 		private length;
 		goto: (i: number) => void;
 		private opts;
-		/** Getter for the current active image/frame index from the Wasm module. */
+		/** Getter for the current active image/frame index from the engine. */
 		get currentIndex(): number;
 		/**
 		 * Creates a GallerySwiper instance.
@@ -644,7 +651,7 @@ declare module '@micrio/client' {
 	/**
 	 * Represents and controls a single Micrio image instance within the viewer.
 	 * This class manages the image's metadata (info), cultural data (data),
-	 * settings, camera, state, and interactions with the WebAssembly module
+	 * settings, camera, state, and interactions with the compute engine
 	 * for rendering and processing. It handles loading image tiles, embeds,
 	 * markers, tours, and galleries associated with the image.
 	 *
@@ -652,7 +659,7 @@ declare module '@micrio/client' {
 	 * @author Marcel Duin <marcel@micr.io>
 	*/
 	export class MicrioImage {
-		wasm: Wasm;
+		engine: Engine;
 		private attr;
 		opts: {
 			/** Optional sub area [x0, y0, x1, y1] defining placement within a parent canvas (for embeds/galleries). */
@@ -2132,19 +2139,19 @@ declare module '@micrio/client' {
 			/** A numeric array or Float64Array used for camera geometry. */
 			type CameraArray = number[] | Float64Array;
 			/** A viewport rectangle `[x0, y0, x1, y1]` (corners). */
-			export type ViewRect = CameraArray;
+			type ViewRect = CameraArray;
 			/** An area definition `[x0, y0, width, height]` (origin + size). */
-			export type View = CameraArray;
+			type View = CameraArray;
 			/** Coordinate tuple, [x, y, scale] */
-			export type Coords = [number, number, number?] | Float64Array;
+			type Coords = [number, number, number?] | Float64Array;
 			/** A 360 vector for use in Spaces */
-			export type Vector = {
+			type Vector = {
 				direction: number;
 				distanceX: number;
 				distanceY: number;
 			};
-			export type TimingFunction = ('ease' | 'ease-in' | 'ease-out' | 'linear');
-			export interface AnimationOptions {
+			type TimingFunction = ('ease' | 'ease-in' | 'ease-out' | 'linear');
+			interface AnimationOptions {
 				/** Animation duration in ms */
 				duration?: number;
 				/** Limit the viewport to fill the screen */
@@ -2154,7 +2161,6 @@ declare module '@micrio/client' {
 				/** Transition timing function */
 				timingFunction?: TimingFunction;
 			}
-			export {};
 		}
 		namespace Embeds {
 			interface EmbedOptions {
@@ -2462,7 +2468,7 @@ declare module '@micrio/client' {
 		 */
 		getRatio: (s?: Partial<Models.ImageInfo.Settings>) => number;
 		/**
-		 * Sets virtual offset margins in the Wasm controller.
+		 * Sets virtual offset margins in the engine controller.
 		 * This likely affects how viewports are calculated or limited.
 		 * @param width The horizontal offset margin in pixels.
 		 * @param height The vertical offset margin in pixels.
@@ -2931,7 +2937,7 @@ declare module '@micrio/client' {
 	/**
 	 * The main Micrio custom HTML element `<micr-io>`.
 	 * This class acts as the central controller for the Micrio viewer, managing
-	 * the WebGL canvas, WebAssembly module, Svelte UI, state, events, and image loading.
+	 * the WebGL canvas, compute engine, Svelte UI, state, events, and image loading.
 	 *
 	 * It orchestrates the interaction between different parts of the library and
 	 * exposes methods and properties for controlling the viewer.
@@ -2946,7 +2952,7 @@ declare module '@micrio/client' {
 	 * </script>
 	 * ```
 	 *
-	 * [[include:./ts/element.md]]
+	 * {@include ./element.md}
 	 *
 	 * @author Marcel Duin <marcel@micr.io>
 	*/
@@ -3025,7 +3031,7 @@ declare module '@micrio/client' {
 		/**
 		 * Closes an opened MicrioImage.
 		 * For split-screen images, it triggers the split-end transition.
-		 * For main images, it removes the canvas from the Wasm controller.
+		 * For main images, it removes the canvas from the engine.
 		 * @param img The {@link MicrioImage} instance to close.
 		*/
 		close(img: MicrioImage): void;
@@ -3071,20 +3077,20 @@ declare module '@micrio/client' {
 	 * Handles HLS playback via hls.js if necessary.
 	 */
 	export class GLEmbedVideo {
-		private wasm;
+		private engine;
 		private image;
 		private embed;
 		private paused;
 		private moved;
 		/**
 		 * Creates a GLEmbedVideo instance.
-		 * @param wasm The Wasm controller instance.
+		 * @param engine The Engine controller instance.
 		 * @param image The parent MicrioImage instance where the video is embedded.
 		 * @param embed The embed data object.
 		 * @param paused Initial paused state (e.g., due to pause-on-zoom).
-		 * @param moved Callback function to notify when position/state changes (triggers Wasm render).
+		 * @param moved Callback function to notify when position/state changes (triggers Engine render).
 		 */
-		constructor(wasm: Wasm, image: MicrioImage, embed: Models.ImageData.Embed, paused: boolean, // Initial paused state
+		constructor(engine: Engine, image: MicrioImage, embed: Models.ImageData.Embed, paused: boolean, // Initial paused state
 		moved: () => void);
 		/** Cleans up resources when the parent Embed component is unmounted. */
 		unmount(): void;
@@ -3264,7 +3270,7 @@ declare module '@micrio/client' {
 	export { Router } from "ts/nav/router";
 	export { Grid } from "ts/nav/grid";
 	export { GallerySwiper } from "ts/nav/swiper";
-	export { Wasm } from "ts/render/wasm";
+	export { Engine } from "ts/render/engine";
 	export { WebGL } from "ts/render/webgl";
 	export { Canvas } from "ts/render/canvas";
 	export { PostProcessor } from "ts/render/postprocess";