@luma.gl/webgl 9.1.0-alpha.1 → 9.1.0-alpha.10

package/src/adapter/webgl-adapter.ts

@@ -0,0 +1,113 @@
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {Adapter, Device, DeviceProps, CanvasContext, log} from '@luma.gl/core';
+import {WebGLDevice} from './webgl-device';
+import {enforceWebGL2} from '../context/polyfills/polyfill-webgl1-extensions';
+import {loadSpectorJS, DEFAULT_SPECTOR_PROPS} from '../context/debug/spector';
+import {loadWebGLDeveloperTools} from '../context/debug/webgl-developer-tools';
+
+const LOG_LEVEL = 1;
+
+export class WebGLAdapter extends Adapter {
+  /** type of device's created by this adapter */
+  readonly type: Device['type'] = 'webgl';
+
+  constructor() {
+    super();
+
+    // Add spector default props to device default props, so that runtime settings are observed
+    Device.defaultProps = {...Device.defaultProps, ...DEFAULT_SPECTOR_PROPS};
+
+    // @ts-ignore DEPRECATED For backwards compatibility luma.registerDevices
+    WebGLDevice.adapter = this;
+  }
+
+  /** Check if WebGL 2 is available */
+  isSupported(): boolean {
+    return typeof WebGL2RenderingContext !== 'undefined';
+  }
+
+  /** Force any created WebGL contexts to be WebGL2 contexts, polyfilled with WebGL1 extensions */
+  enforceWebGL2(enable: boolean): void {
+    enforceWebGL2(enable);
+  }
+
+  /**
+   * Get a device instance from a GL context
+   * Creates and instruments the device if not already created
+   * @param gl
+   * @returns
+   */
+  async attach(gl: Device | WebGL2RenderingContext): Promise<WebGLDevice> {
+    if (gl instanceof WebGLDevice) {
+      return gl;
+    }
+    // @ts-expect-error
+    if (gl?.device instanceof Device) {
+      // @ts-expect-error
+      return gl.device as WebGLDevice;
+    }
+    if (!isWebGL(gl)) {
+      throw new Error('Invalid WebGL2RenderingContext');
+    }
+    return new WebGLDevice({gl: gl as WebGL2RenderingContext});
+  }
+
+  async create(props: DeviceProps = {}): Promise<WebGLDevice> {
+    log.groupCollapsed(LOG_LEVEL, 'WebGLDevice created')();
+
+    const promises: Promise<unknown>[] = [];
+
+    // Load webgl and spector debug scripts from CDN if requested
+    if (props.debug) {
+      promises.push(loadWebGLDeveloperTools());
+    }
+
+    if (props.debugWithSpectorJS) {
+      promises.push(loadSpectorJS(props));
+    }
+
+    // Wait for page to load: if canvas is a string we need to query the DOM for the canvas element.
+    // We only wait when props.canvas is string to avoids setting the global page onload callback unless necessary.
+    if (typeof props.canvas === 'string') {
+      promises.push(CanvasContext.pageLoaded);
+    }
+
+    // Wait for all the loads to settle before creating the context.
+    // The Device.create() functions are async, so in contrast to the constructor, we can `await` here.
+    const results = await Promise.allSettled(promises);
+    for (const result of results) {
+      if (result.status === 'rejected') {
+        log.error(`Failed to initialize debug libraries ${result.reason}`)();
+      }
+    }
+
+    log.probe(LOG_LEVEL + 1, 'DOM is loaded')();
+
+    const device = new WebGLDevice(props);
+
+    // Log some debug info about the newly created context
+    const message = `\
+Created ${device.type}${device.debug ? ' debug' : ''} context: \
+${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContext.id}`;
+    log.probe(LOG_LEVEL, message)();
+    log.table(LOG_LEVEL, device.info)();
+
+    log.groupEnd(LOG_LEVEL)();
+
+    return device;
+  }
+}
+
+/** Check if supplied parameter is a WebGL2RenderingContext */
+function isWebGL(gl: any): boolean {
+  if (typeof WebGL2RenderingContext !== 'undefined' && gl instanceof WebGL2RenderingContext) {
+    return true;
+  }
+  // Look for debug contexts, headless gl etc
+  return Boolean(gl && Number.isFinite(gl._version));
+}
+
+export const webgl2Adapter = new WebGLAdapter();

package/src/adapter/webgl-device.ts

@@ -7,23 +7,21 @@ import type {DeviceProps, DeviceInfo, CanvasContextProps, TextureFormat} from '@
 import type {Buffer, Texture, Framebuffer, VertexArray, VertexArrayProps} from '@luma.gl/core';
 import {Device, CanvasContext, log} from '@luma.gl/core';
 import type {GLExtensions} from '@luma.gl/constants';
-import {
-  popContextState,
-  pushContextState,
-  trackContextState
-} from '../context/state-tracker/track-context-state';
+import {WebGLStateTracker} from '../context/state-tracker/webgl-state-tracker';
 import {createBrowserContext} from '../context/helpers/create-browser-context';
 import {getDeviceInfo} from './device-helpers/webgl-device-info';
 import {WebGLDeviceFeatures} from './device-helpers/webgl-device-features';
 import {WebGLDeviceLimits} from './device-helpers/webgl-device-limits';
 import {WebGLCanvasContext} from './webgl-canvas-context';
-import {loadSpectorJS, initializeSpectorJS} from '../context/debug/spector';
-import {loadWebGLDeveloperTools, makeDebugContext} from '../context/debug/webgl-developer-tools';
+import type {Spector} from '../context/debug/spector-types';
+import {initializeSpectorJS} from '../context/debug/spector';
+import {makeDebugContext} from '../context/debug/webgl-developer-tools';
 import {
   isTextureFormatSupported,
   isTextureFormatRenderable,
   isTextureFormatFilterable
 } from './converters/texture-formats';
+import {uid} from '../utils/uid';
 
 // WebGL classes
 import type {
@@ -71,17 +69,12 @@ import {withGLParameters} from '../context/state-tracker/with-parameters';
 import {clear} from '../classic/clear';
 import {getWebGLExtension} from '../context/helpers/webgl-extensions';
 
-const LOG_LEVEL = 1;
-
 /** WebGPU style Device API for a WebGL context */
 export class WebGLDevice extends Device {
   //
   // Public `Device` API
   //
 
-  /** type of this device */
-  static readonly type: string = 'webgl';
-
   /** type of this device */
   readonly type = 'webgl';
 
@@ -97,93 +90,26 @@ export class WebGLDevice extends Device {
 
   private _resolveContextLost?: (value: {reason: 'destroyed'; message: string}) => void;
 
-  //
-  // Static methods, expected to be present by `luma.createDevice()`
-  //
-
-  /** Check if WebGL 2 is available */
-  static isSupported(): boolean {
-    return typeof WebGL2RenderingContext !== 'undefined';
-  }
-
-  /**
-   * Get a device instance from a GL context
-   * Creates and instruments the device if not already created
-   * @param gl
-   * @returns
-   */
-  static attach(gl: Device | WebGL2RenderingContext): WebGLDevice {
-    if (gl instanceof WebGLDevice) {
-      return gl;
-    }
-    // @ts-expect-error
-    if (gl?.device instanceof Device) {
-      // @ts-expect-error
-      return gl.device as WebGLDevice;
-    }
-    if (!isWebGL(gl)) {
-      throw new Error('Invalid WebGL2RenderingContext');
-    }
-    return new WebGLDevice({gl: gl as WebGL2RenderingContext});
-  }
-
-  static async create(props: DeviceProps = {}): Promise<WebGLDevice> {
-    log.groupCollapsed(LOG_LEVEL, 'WebGLDevice created')();
-
-    const promises: Promise<unknown>[] = [];
-
-    // Load webgl and spector debug scripts from CDN if requested
-    if (props.debug) {
-      promises.push(loadWebGLDeveloperTools());
-    }
-
-    if (props.spector) {
-      promises.push(loadSpectorJS());
-    }
-
-    // Wait for page to load: if canvas is a string we need to query the DOM for the canvas element.
-    // We only wait when props.canvas is string to avoids setting the global page onload callback unless necessary.
-    if (typeof props.canvas === 'string') {
-      promises.push(CanvasContext.pageLoaded);
-    }
-
-    // Wait for all the loads to settle before creating the context.
-    // The Device.create() functions are async, so in contrast to the constructor, we can `await` here.
-    const results = await Promise.allSettled(promises);
-    for (const result of results) {
-      if (result.status === 'rejected') {
-        log.error(`Failed to initialize debug libraries ${result.reason}`)();
-      }
-    }
-
-    log.probe(LOG_LEVEL + 1, 'DOM is loaded')();
-
-    // @ts-expect-error
-    if (props.gl?.device) {
-      log.warn('reattaching existing device')();
-      return WebGLDevice.attach(props.gl);
-    }
-
-    const device = new WebGLDevice(props);
+  /** WebGL2 context. */
+  readonly gl: WebGL2RenderingContext;
+  readonly debug: boolean = false;
 
-    // Log some debug info about the newly created context
-    const message = `\
-Created ${device.type}${device.debug ? ' debug' : ''} context: \
-${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContext.id}`;
-    log.probe(LOG_LEVEL, message)();
-    log.table(LOG_LEVEL, device.info)();
+  /** State used by luma.gl classes: TODO - move to canvasContext*/
+  readonly _canvasSizeInfo = {clientWidth: 0, clientHeight: 0, devicePixelRatio: 1};
 
-    log.groupEnd(LOG_LEVEL)();
+  /** State used by luma.gl classes - TODO - not used? */
+  readonly _extensions: GLExtensions = {};
+  _polyfilled: boolean = false;
 
-    return device;
-  }
+  /** Instance of Spector.js (if initialized) */
+  spectorJS: Spector;
 
   //
   // Public API
   //
 
   constructor(props: DeviceProps) {
-    super({...props, id: props.id || 'webgl-device'});
+    super({...props, id: props.id || uid('webgl-device')});
 
     // If attaching to an already attached context, return the attached device
     // @ts-expect-error device is attached to context
@@ -200,8 +126,7 @@ ${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContex
       this._resolveContextLost = resolve;
     });
 
-    let gl: WebGL2RenderingContext | null = props.gl || null;
-    gl ||= createBrowserContext(this.canvasContext.canvas, {
+    this.handle = createBrowserContext(this.canvasContext.canvas, {
       ...props,
       onContextLost: (event: Event) =>
         this._resolveContextLost?.({
@@ -209,18 +134,22 @@ ${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContex
           message: 'Entered sleep mode, or too many apps or browser tabs are using the GPU.'
         })
     });
+    this.gl = this.handle;
 
-    if (!gl) {
+    if (!this.handle) {
       throw new Error('WebGL context creation failed');
     }
 
-    this.handle = gl;
-    this.gl = gl;
+    // Add spector debug instrumentation to context
+    // We need to trust spector integration to decide if spector should be initialized
+    // We also run spector instrumentation first, otherwise spector can clobber luma instrumentation.
+    this.spectorJS = initializeSpectorJS({...this.props, gl: this.handle});
 
+    // Instrument context
     (this.gl as any).device = this; // Update GL context: Link webgl context back to device
     (this.gl as any)._version = 2; // Update GL context: Store WebGL version field on gl context (HACK to identify debug contexts)
 
-    // luma Device fields
+    // initialize luma Device fields
     this.info = getDeviceInfo(this.gl, this._extensions);
     this.limits = new WebGLDeviceLimits(this.gl);
     this.features = new WebGLDeviceFeatures(this.gl, this._extensions, this.props.disabledFeatures);
@@ -231,25 +160,18 @@ ${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContex
     this.canvasContext.resize();
 
     // Install context state tracking
-    // @ts-expect-error - hidden parameters
-    const {enable = true, copyState = false} = props;
-    trackContextState(this.gl, {
-      enable,
-      copyState,
+    const glState = new WebGLStateTracker(this.gl, {
       log: (...args: any[]) => log.log(1, ...args)()
     });
+    glState.trackState(this.gl, {copyState: false});
 
-    // DEBUG contexts: Add debug instrumentation to the context, force log level to at least 1
+    // DEBUG contexts: Add luma debug instrumentation to the context, force log level to at least 1
     if (props.debug) {
       this.gl = makeDebugContext(this.gl, {...props, throwOnError: true});
       this.debug = true;
       log.level = Math.max(log.level, 1);
       log.warn('WebGL debug mode activated. Performance reduced.')();
     }
-
-    if (props.spector) {
-      this.spectorJS = initializeSpectorJS({...this.props, canvas: this.handle.canvas});
-    }
   }
 
   /**
@@ -262,10 +184,6 @@ ${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContex
     return this.gl.isContextLost();
   }
 
-  getSize(): [number, number] {
-    return [this.gl.drawingBufferWidth, this.gl.drawingBufferHeight];
-  }
-
   isTextureFormatSupported(format: TextureFormat): boolean {
     return isTextureFormatSupported(this.gl, format, this._extensions);
   }
@@ -425,20 +343,6 @@ ${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContex
   // WebGL-only API (not part of `Device` API)
   //
 
-  /** WebGL2 context. */
-  readonly gl: WebGL2RenderingContext;
-  readonly debug: boolean = false;
-
-  /** State used by luma.gl classes: TODO - move to canvasContext*/
-  readonly _canvasSizeInfo = {clientWidth: 0, clientHeight: 0, devicePixelRatio: 1};
-
-  /** State used by luma.gl classes - TODO - not used? */
-  readonly _extensions: GLExtensions = {};
-  _polyfilled: boolean = false;
-
-  /** Instance of Spector.js (if initialized) */
-  spectorJS: unknown;
-
   /**
    * Triggers device (or WebGL context) loss.
    * @note primarily intended for testing how application reacts to device loss
@@ -461,12 +365,14 @@ ${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContex
 
   /** Save current WebGL context state onto an internal stack */
   pushState(): void {
-    pushContextState(this.gl);
+    const webglState = WebGLStateTracker.get(this.gl);
+    webglState.push();
   }
 
   /** Restores previously saved context state */
   popState(): void {
-    popContextState(this.gl);
+    const webglState = WebGLStateTracker.get(this.gl);
+    webglState.pop();
   }
 
   /**
@@ -541,15 +447,6 @@ ${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContex
   }
 }
 
-/** Check if supplied parameter is a WebGL2RenderingContext */
-function isWebGL(gl: any): boolean {
-  if (typeof WebGL2RenderingContext !== 'undefined' && gl instanceof WebGL2RenderingContext) {
-    return true;
-  }
-  // Look for debug contexts, headless gl etc
-  return Boolean(gl && Number.isFinite(gl._version));
-}
-
 /** Set constant float array attribute */
 function setConstantFloatArray(device: WebGLDevice, location: number, array: Float32Array): void {
   switch (array.length) {

package/src/classic/copy-and-blit.ts

@@ -33,13 +33,13 @@ export function readPixelsToArray(
     // following parameters are auto deduced if not provided
     sourceWidth?: number;
     sourceHeight?: number;
+    sourceDepth?: number;
     sourceType?: number;
   }
 ): Uint8Array | Uint16Array | Float32Array {
   const {
     sourceX = 0,
     sourceY = 0,
-    sourceFormat = GL.RGBA,
     sourceAttachment = GL.COLOR_ATTACHMENT0 // TODO - support gl.readBuffer
   } = options || {};
   let {
@@ -47,29 +47,32 @@ export function readPixelsToArray(
     // following parameters are auto deduced if not provided
     sourceWidth,
     sourceHeight,
+    sourceDepth,
+    sourceFormat,
     sourceType
   } = options || {};
 
   const {framebuffer, deleteFramebuffer} = getFramebuffer(source);
   // assert(framebuffer);
   const {gl, handle} = framebuffer;
-  sourceWidth = sourceWidth || framebuffer.width;
-  sourceHeight = sourceHeight || framebuffer.height;
+  const attachment = sourceAttachment - GL.COLOR_ATTACHMENT0;
+
+  sourceWidth ||= framebuffer.width;
+  sourceHeight ||= framebuffer.height;
 
   // TODO - Set and unset gl.readBuffer
   // if (sourceAttachment === GL.COLOR_ATTACHMENT0 && handle === null) {
   //   sourceAttachment = GL.FRONT;
   // }
 
-  const attachment = sourceAttachment - GL.COLOR_ATTACHMENT0;
-  // assert(attachments[sourceAttachment]);
+  sourceDepth = framebuffer.colorAttachments[attachment]?.texture?.depth || 1;
 
+  sourceFormat ||= framebuffer.colorAttachments[attachment]?.texture?.glFormat || GL.RGBA;
   // Deduce the type from color attachment if not provided.
-  sourceType =
-    sourceType || framebuffer.colorAttachments[attachment]?.texture?.glType || GL.UNSIGNED_BYTE;
+  sourceType ||= framebuffer.colorAttachments[attachment]?.texture?.glType || GL.UNSIGNED_BYTE;
 
   // Deduce type and allocated pixelArray if needed
-  target = getPixelArray(target, sourceType, sourceFormat, sourceWidth, sourceHeight);
+  target = getPixelArray(target, sourceType, sourceFormat, sourceWidth, sourceHeight, sourceDepth);
 
   // Pixel array available, if necessary, deduce type from it.
   sourceType = sourceType || getGLTypeFromTypedArray(target);
@@ -299,12 +302,14 @@ export function toFramebuffer(texture: Texture, props?: FramebufferProps): WEBGL
   return framebuffer as WEBGLFramebuffer;
 }
 
+// eslint-disable-next-line max-params
 function getPixelArray(
   pixelArray,
   type,
   format,
   width: number,
-  height: number
+  height: number,
+  depth?: number
 ): Uint8Array | Uint16Array | Float32Array {
   if (pixelArray) {
     return pixelArray;