@luma.gl/core 9.3.0-alpha.4 → 9.3.0-alpha.6

package/dist/adapter/canvas-context.d.ts

@@ -1,187 +1,11 @@
-import type { Device } from "./device.js";
-import type { Framebuffer } from "./resources/framebuffer.js";
-import type { TextureFormatDepthStencil } from "../shadertypes/textures/texture-formats.js";
-/** Properties for a CanvasContext */
-export type CanvasContextProps = {
-    /** Identifier, for debugging */
-    id?: string;
-    /** If a canvas not supplied, one will be created and added to the DOM. If a string, a canvas with that id will be looked up in the DOM */
-    canvas?: HTMLCanvasElement | OffscreenCanvas | string | null;
-    /** If new canvas is created, it will be created in the specified container, otherwise is appended as a child of document.body */
-    container?: HTMLElement | string | null;
-    /** Width in pixels of the canvas - used when creating a new canvas */
-    width?: number;
-    /** Height in pixels of the canvas - used when creating a new canvas */
-    height?: number;
-    /** Visibility (only used if new canvas is created). */
-    visible?: boolean;
-    /** Whether to size the drawing buffer to the pixel size during auto resize. If a number is provided it is used as a static pixel ratio */
-    useDevicePixels?: boolean | number;
-    /** Whether to track window resizes. */
-    autoResize?: boolean;
-    /** @see https://developer.mozilla.org/en-US/docs/Web/API/GPUCanvasContext/configure#alphamode */
-    alphaMode?: 'opaque' | 'premultiplied';
-    /** @see https://developer.mozilla.org/en-US/docs/Web/API/GPUCanvasContext/configure#colorspace */
-    colorSpace?: 'srgb';
-    /** Whether to track position changes. Calls this.device.onPositionChange */
-    trackPosition?: boolean;
-};
-export type MutableCanvasContextProps = {
-    /** Whether to size the drawing buffer to the pixel size during auto resize. If a number is provided it is used as a static pixel ratio */
-    useDevicePixels?: boolean | number;
-};
+export type { CanvasContextProps, MutableCanvasContextProps } from "./canvas-surface.js";
+import { CanvasSurface } from "./canvas-surface.js";
 /**
- * Manages a canvas. Supports both HTML or offscreen canvas
- * - Creates a new canvas or looks up a canvas from the DOM
- * - Provides check for DOM loaded
- * @todo commit() @see https://github.com/w3ctag/design-reviews/issues/288
- * @todo transferControlToOffscreen: @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/transferControlToOffscreen
+ * Manages a renderable backend canvas. Supports both HTML or offscreen canvas
+ * and returns backend framebuffers sourced from the canvas itself.
  */
-export declare abstract class CanvasContext {
-    static isHTMLCanvas(canvas: unknown): canvas is HTMLCanvasElement;
-    static isOffscreenCanvas(canvas: unknown): canvas is OffscreenCanvas;
-    static defaultProps: Required<CanvasContextProps>;
-    abstract readonly device: Device;
+export declare abstract class CanvasContext extends CanvasSurface {
+    static defaultProps: Required<import("./canvas-surface").CanvasContextProps>;
     abstract readonly handle: unknown;
-    readonly id: string;
-    readonly props: Required<CanvasContextProps>;
-    readonly canvas: HTMLCanvasElement | OffscreenCanvas;
-    /** Handle to HTML canvas */
-    readonly htmlCanvas?: HTMLCanvasElement;
-    /** Handle to wrapped OffScreenCanvas */
-    readonly offscreenCanvas?: OffscreenCanvas;
-    readonly type: 'html-canvas' | 'offscreen-canvas' | 'node';
-    /** Promise that resolved once the resize observer has updated the pixel size */
-    initialized: Promise<void>;
-    isInitialized: boolean;
-    /** Visibility is automatically updated (via an IntersectionObserver) */
-    isVisible: boolean;
-    /** Width of canvas in CSS units (tracked by a ResizeObserver) */
-    cssWidth: number;
-    /** Height of canvas in CSS units (tracked by a ResizeObserver) */
-    cssHeight: number;
-    /** Device pixel ratio. Automatically updated via media queries */
-    devicePixelRatio: number;
-    /** Exact width of canvas in physical pixels (tracked by a ResizeObserver) */
-    devicePixelWidth: number;
-    /** Exact height of canvas in physical pixels (tracked by a ResizeObserver) */
-    devicePixelHeight: number;
-    /** Width of drawing buffer: automatically tracks this.pixelWidth if props.autoResize is true */
-    drawingBufferWidth: number;
-    /** Height of drawing buffer: automatically tracks this.pixelHeight if props.autoResize is true */
-    drawingBufferHeight: number;
-    /** Resolves when the canvas is initialized, i.e. when the ResizeObserver has updated the pixel size */
-    protected _initializedResolvers: {
-        promise: Promise<void>;
-        resolve: (t: void) => void;
-        reject: (error: Error) => void;
-    };
-    /** ResizeObserver to track canvas size changes */
-    protected readonly _resizeObserver: ResizeObserver | undefined;
-    /** IntersectionObserver to track canvas visibility changes */
-    protected readonly _intersectionObserver: IntersectionObserver | undefined;
-    private _observeDevicePixelRatioTimeout;
-    /** Position of the canvas in the document, updated by a timer */
-    protected _position: [number, number];
-    /** Whether this canvas context has been destroyed */
-    protected destroyed: boolean;
-    /** Whether the drawing buffer size needs to be resized (deferred resizing to avoid flicker) */
-    protected _needsDrawingBufferResize: boolean;
-    abstract get [Symbol.toStringTag](): string;
-    toString(): string;
-    constructor(props?: CanvasContextProps);
-    destroy(): void;
-    setProps(props: MutableCanvasContextProps): this;
-    /** Returns a framebuffer with properly resized current 'swap chain' textures */
-    getCurrentFramebuffer(options?: {
-        depthStencilFormat?: TextureFormatDepthStencil | false;
-    }): Framebuffer;
-    /**
-     * Returns the size covered by the canvas in CSS pixels
-     * @note This can be different from the actual device pixel size of a canvas due to DPR scaling, and rounding to integer pixels
-     * @note This is independent of the canvas' internal drawing buffer size (.width, .height).
-     */
-    getCSSSize(): [number, number];
-    getPosition(): [number, number];
-    /**
-     * Returns the size covered by the canvas in actual device pixels.
-     * @note This can be different from the 'CSS' size of a canvas due to DPR scaling, and rounding to integer pixels
-     * @note This is independent of the canvas' internal drawing buffer size (.width, .height).
-     */
-    getDevicePixelSize(): [number, number];
-    /** Get the drawing buffer size (number of pixels GPU is rendering into, can be different from CSS size) */
-    getDrawingBufferSize(): [number, number];
-    /** Returns the biggest allowed framebuffer size. @todo Allow the application to limit this? */
-    getMaxDrawingBufferSize(): [number, number];
-    /**
-     * Update the canvas drawing buffer size.
-     * @note - Called automatically if props.autoResize is true.
-     * @note - Defers update of drawing buffer size until framebuffer is requested to avoid flicker
-     * (resizing clears the drawing buffer)!
-     */
-    setDrawingBufferSize(width: number, height: number): void;
-    /**
-     * Returns the current DPR (number of physical pixels per CSS pixel), if props.useDevicePixels is true
-     * @note This can be a fractional (non-integer) number, e.g. when the user zooms in the browser.
-     * @note This function handles the non-HTML canvas cases
-     */
-    getDevicePixelRatio(): number;
-    /**
-     * Maps CSS pixel position to device pixel position
-     */
-    cssToDevicePixels(cssPixel: [number, number], yInvert?: boolean): {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-    /** @deprecated - use .getDevicePixelSize() */
-    getPixelSize(): [number, number];
-    /** @deprecated - TODO which values should we use for aspect */
-    getAspect(): number;
-    /** @deprecated Returns multiplier need to convert CSS size to Device size */
-    cssToDeviceRatio(): number;
-    /** @deprecated Use canvasContext.setDrawingBufferSize() */
-    resize(size: {
-        width: number;
-        height: number;
-    }): void;
-    /**
-     * Performs platform specific updates (WebGPU vs WebGL)
-     * Can be called after changes to size or props,
-     * to give implementation an opportunity to update configurations.
-     */
-    protected abstract _configureDevice(): void;
-    /** Returns a framebuffer with properly resized current 'swap chain' textures */
-    protected abstract _getCurrentFramebuffer(options?: {
-        depthStencilFormat?: TextureFormatDepthStencil | false;
-    }): Framebuffer;
-    /**
-     * Allows subclass constructor to override the canvas id for auto created canvases.
-     * This can really help when debugging DOM in apps that create multiple devices
-     */
-    protected _setAutoCreatedCanvasId(id: string): void;
-    /** reacts to an observed intersection */
-    protected _handleIntersection(entries: IntersectionObserverEntry[]): void;
-    /**
-     * Reacts to an observed resize by using the most accurate pixel size information the browser can provide
-     * @see https://web.dev/articles/device-pixel-content-box
-     * @see https://webgpufundamentals.org/webgpu/lessons/webgpu-resizing-the-canvas.html
-     */
-    protected _handleResize(entries: ResizeObserverEntry[]): void;
-    /** Initiate a deferred update for the canvas drawing buffer size */
-    protected _updateDrawingBufferSize(): void;
-    /** Perform a deferred resize of the drawing buffer if needed */
-    _resizeDrawingBufferIfNeeded(): void;
-    /** Monitor DPR changes */
-    _observeDevicePixelRatio(): void;
-    /** Start tracking positions with a timer */
-    _trackPosition(intervalMs?: number): void;
-    /**
-     * Calculated the absolute position of the canvas
-     * @note - getBoundingClientRect() is normally cheap but can be expensive
-     * if called before browser has finished a reflow. Should not be the case here.
-     */
-    updatePosition(): void;
 }
 //# sourceMappingURL=canvas-context.d.ts.map

package/dist/adapter/canvas-context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"canvas-context.d.ts","sourceRoot":"","sources":["../../src/adapter/canvas-context.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,MAAM,EAAC,oBAAiB;AACrC,OAAO,KAAK,EAAC,WAAW,EAAC,mCAAgC;AACzD,OAAO,KAAK,EAAC,yBAAyB,EAAC,mDAAgD;AAKvF,qCAAqC;AACrC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,gCAAgC;IAChC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0IAA0I;IAC1I,MAAM,CAAC,EAAE,iBAAiB,GAAG,eAAe,GAAG,MAAM,GAAG,IAAI,CAAC;IAC7D,iIAAiI;IACjI,SAAS,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;IACxC,sEAAsE;IACtE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0IAA0I;IAC1I,eAAe,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IACnC,uCAAuC;IACvC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iGAAiG;IACjG,SAAS,CAAC,EAAE,QAAQ,GAAG,eAAe,CAAC;IACvC,kGAAkG;IAClG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,0IAA0I;IAC1I,eAAe,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CACpC,CAAC;AAEF;;;;;;GAMG;AACH,8BAAsB,aAAa;IACjC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,iBAAiB;IAIjE,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,eAAe;IAIpE,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAY/C;IAEF,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAC7C,QAAQ,CAAC,MAAM,EAAE,iBAAiB,GAAG,eAAe,CAAC;IACrD,4BAA4B;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IACxC,wCAAwC;IACxC,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;IAC3C,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,kBAAkB,GAAG,MAAM,CAAC;IAE3D,gFAAgF;IAChF,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,aAAa,EAAE,OAAO,CAAS;IAE/B,wEAAwE;IACxE,SAAS,EAAE,OAAO,CAAQ;IAE1B,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAC;IACjB,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAElB,kEAAkE;IAClE,gBAAgB,EAAE,MAAM,CAAC;IACzB,6EAA6E;IAC7E,gBAAgB,EAAE,MAAM,CAAC;IACzB,8EAA8E;IAC9E,iBAAiB,EAAE,MAAM,CAAC;IAE1B,gGAAgG;IAChG,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kGAAkG;IAClG,mBAAmB,EAAE,MAAM,CAAC;IAE5B,uGAAuG;IACvG,SAAS,CAAC,qBAAqB;;;;MAAyB;IACxD,kDAAkD;IAClD,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,cAAc,GAAG,SAAS,CAAC;IAC/D,8DAA8D;IAC9D,SAAS,CAAC,QAAQ,CAAC,qBAAqB,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC3E,OAAO,CAAC,+BAA+B,CAA8C;IACrF,iEAAiE;IACjE,SAAS,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAU;IAC/C,qDAAqD;IACrD,SAAS,CAAC,SAAS,UAAS;IAC5B,+FAA+F;IAC/F,SAAS,CAAC,yBAAyB,EAAE,OAAO,CAAQ;IAEpD,QAAQ,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC;IAE5C,QAAQ,IAAI,MAAM;gBAIN,KAAK,CAAC,EAAE,kBAAkB;IAqEtC,OAAO;IAeP,QAAQ,CAAC,KAAK,EAAE,yBAAyB,GAAG,IAAI;IAQhD,gFAAgF;IAChF,qBAAqB,CAAC,OAAO,CAAC,EAAE;QAC9B,kBAAkB,CAAC,EAAE,yBAAyB,GAAG,KAAK,CAAC;KACxD,GAAG,WAAW;IAOf;;;;OAIG;IACH,UAAU,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;IAI9B,WAAW;IAIX;;;;OAIG;IACH,kBAAkB,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;IAItC,2GAA2G;IAC3G,oBAAoB,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;IAIxC,+FAA+F;IAC/F,uBAAuB,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;IAK3C;;;;;OAKG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAYlD;;;;OAIG;IACH,mBAAmB,IAAI,MAAM;IAO7B;;OAEG;IACH,iBAAiB,CACf,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAC1B,OAAO,GAAE,OAAc,GACtB;QACD,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB;IAMD,8CAA8C;IAC9C,YAAY;IAIZ,+DAA+D;IAC/D,SAAS,IAAI,MAAM;IAKnB,6EAA6E;IAC7E,gBAAgB,IAAI,MAAM;IAU1B,2DAA2D;IAC3D,MAAM,CAAC,IAAI,EAAE;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,GAAG,IAAI;IAMnD;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,IAAI,IAAI;IAE3C,gFAAgF;IAChF,SAAS,CAAC,QAAQ,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE;QAClD,kBAAkB,CAAC,EAAE,yBAAyB,GAAG,KAAK,CAAC;KACxD,GAAG,WAAW;IAIf;;;OAGG;IACH,SAAS,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM;IAM5C,yCAAyC;IACzC,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,yBAAyB,EAAE;IAiBlE;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,mBAAmB,EAAE;IAwCtD,oEAAoE;IACpE,SAAS,CAAC,wBAAwB;IAoBlC,gEAAgE;IAChE,4BAA4B;IAgB5B,0BAA0B;IAC1B,wBAAwB;IAmBxB,4CAA4C;IAC5C,cAAc,CAAC,UAAU,GAAE,MAAY,GAAG,IAAI;IAU9C;;;;OAIG;IACH,cAAc;CAkBf"}
+{"version":3,"file":"canvas-context.d.ts","sourceRoot":"","sources":["../../src/adapter/canvas-context.ts"],"names":[],"mappings":"AAIA,YAAY,EAAC,kBAAkB,EAAE,yBAAyB,EAAC,4BAAyB;AACpF,OAAO,EAAC,aAAa,EAAC,4BAAyB;AAE/C;;;GAGG;AACH,8BAAsB,aAAc,SAAQ,aAAa;IACvD,OAAgB,YAAY,0DAA8B;IAE1D,kBAA2B,MAAM,EAAE,OAAO,CAAC;CAC5C"}