@luma.gl/webgl 9.0.0-alpha.4 → 9.0.0-alpha.40

package/src/adapter/webgl-device.ts

@@ -1,22 +1,34 @@
 // luma.gl, MIT license
+// Copyright (c) vis.gl contributors
+
 import type {
   DeviceProps,
   DeviceInfo,
   DeviceLimits,
   DeviceFeature,
   CanvasContextProps,
-  TextureFormat
-} from '@luma.gl/api';
-import {Device, CanvasContext, log, assert} from '@luma.gl/api';
+  TextureFormat,
+  VertexArray,
+  VertexArrayProps,
+  TypedArray
+} from '@luma.gl/core';
+import {Device, CanvasContext, log, uid, assert} from '@luma.gl/core';
 import {isBrowser} from '@probe.gl/env';
 import {polyfillContext} from '../context/polyfill/polyfill-context';
-import {trackContextState} from '../context/state-tracker/track-context-state';
-import {ContextState} from '../context/context/context-state';
-import {createBrowserContext} from '../context/context/create-context';
+import {
+  popContextState,
+  pushContextState,
+  trackContextState
+} from '../context/state-tracker/track-context-state';
+import {createBrowserContext} from '../context/context/create-browser-context';
+import {
+  createHeadlessContext,
+  isHeadlessGLRegistered
+} from '../context/context/create-headless-context';
 import {getDeviceInfo} from './device-helpers/get-device-info';
 import {getDeviceFeatures} from './device-helpers/device-features';
 import {getDeviceLimits, getWebGLLimits, WebGLLimits} from './device-helpers/device-limits';
-import WebGLCanvasContext from './webgl-canvas-context';
+import {WebGLCanvasContext} from './webgl-canvas-context';
 import {loadSpectorJS, initializeSpectorJS} from '../context/debug/spector';
 import {loadWebGLDeveloperTools, makeDebugContext} from '../context/debug/webgl-developer-tools';
 import {
@@ -29,48 +41,52 @@ import {
 import type {
   BufferProps,
   ShaderProps,
-  Sampler,
+  // Sampler,
   SamplerProps,
   TextureProps,
   ExternalTexture,
   ExternalTextureProps,
   FramebufferProps,
-  RenderPipeline,
+  // RenderPipeline,
   RenderPipelineProps,
   ComputePipeline,
   ComputePipelineProps,
-  RenderPass,
+  // RenderPass,
   RenderPassProps,
   ComputePass,
-  ComputePassProps
-} from '@luma.gl/api';
-
-import ClassicBuffer from '../classic/buffer';
-import WEBGLBuffer from './resources/webgl-buffer';
-import WEBGLShader from './resources/webgl-shader';
-import WEBGLSampler from './resources/webgl-sampler';
-import WEBGLTexture from './resources/webgl-texture';
-import WEBGLFramebuffer from './resources/webgl-framebuffer';
-import WEBGLRenderPass from './resources/webgl-render-pass';
-import WEBGLRenderPipeline from './resources/webgl-render-pipeline';
+  ComputePassProps,
+  // CommandEncoder,
+  CommandEncoderProps
+} from '@luma.gl/core';
+
+import {BufferWithAccessor} from '../classic/buffer-with-accessor';
+import {WEBGLBuffer} from './resources/webgl-buffer';
+import {WEBGLShader} from './resources/webgl-shader';
+import {WEBGLSampler} from './resources/webgl-sampler';
+import {WEBGLTexture} from './resources/webgl-texture';
+import {WEBGLFramebuffer} from './resources/webgl-framebuffer';
+import {WEBGLRenderPass} from './resources/webgl-render-pass';
+import {WEBGLRenderPipeline} from './resources/webgl-render-pipeline';
+import {WEBGLCommandEncoder} from './resources/webgl-command-encoder';
+import {WEBGLVertexArray} from './resources/webgl-vertex-array';
 
 const LOG_LEVEL = 1;
 
-let counter = 0;
-
 /** WebGPU style Device API for a WebGL context */
-export default class WebGLDevice extends Device implements ContextState {
-  // Public API
+export class WebGLDevice extends Device {
+  //
+  // Public `Device` API
+  //
 
   static type: string = 'webgl';
 
   static isSupported(): boolean {
-    return typeof WebGLRenderingContext !== 'undefined';
+    return typeof WebGLRenderingContext !== 'undefined' || isHeadlessGLRegistered();
   }
 
   readonly info: DeviceInfo;
   readonly canvasContext: WebGLCanvasContext;
-  readonly lost: Promise<{reason: 'destroyed'; message: string}>;
+
   readonly handle: WebGLRenderingContext;
 
   get features(): Set<DeviceFeature> {
@@ -83,36 +99,15 @@ export default class WebGLDevice extends Device implements ContextState {
     return this._limits;
   }
 
-  // WebGL specific API
-
-  /** WebGL1 typed context. Can always be used. */
-  readonly gl: WebGLRenderingContext;
-  /** WebGL2 typed context. Need to check isWebGL2 or isWebGL1 before using. */
-  readonly gl2: WebGL2RenderingContext;
-  readonly debug: boolean = false;
-
-  /** `true` if this is a WebGL1 context. @note `false` if WebGL2 */
-  readonly isWebGL1: boolean;
-  /** `true` if this is a WebGL2 context. @note `false` if WebGL1 */
-  readonly isWebGL2: boolean;
-
-  get webglLimits(): WebGLLimits {
-    this._webglLimits = this._webglLimits || getWebGLLimits(this.gl);
-    return this._webglLimits;
-  }
+  readonly lost: Promise<{reason: 'destroyed'; message: string}>;
 
-  private _features: Set<DeviceFeature>;
-  private _limits: DeviceLimits;
-  private _webglLimits: WebGLLimits;
+  private _resolveContextLost?: (value: {reason: 'destroyed'; message: string}) => void;
+  private _features?: Set<DeviceFeature>;
+  private _limits?: DeviceLimits;
 
-  /** State used by luma.gl classes: TODO - move to canvasContext*/
-  readonly _canvasSizeInfo = {clientWidth: 0, clientHeight: 0, devicePixelRatio: 1};
-  /** State used by luma.gl classes */
-  readonly _extensions: Record<string, any> = {};
-  _polyfilled: boolean = false;
-
-  /** Instance of Spector.js (if initialized) */
-  spector;
+  //
+  // Static methods, expected to be present by `luma.createDevice()`
+  //
 
   /**
    * Get a device instance from a GL context
@@ -135,7 +130,7 @@ export default class WebGLDevice extends Device implements ContextState {
     return new WebGLDevice({gl: gl as WebGLRenderingContext});
   }
 
-  static async create(props?: DeviceProps): Promise<WebGLDevice> {
+  static async create(props: DeviceProps = {}): Promise<WebGLDevice> {
     log.groupCollapsed(LOG_LEVEL, 'WebGLDevice created');
 
     // Wait for page to load. Only wait when props. canvas is string
@@ -145,33 +140,66 @@ export default class WebGLDevice extends Device implements ContextState {
     }
 
     // Load webgl and spector debug scripts from CDN if requested
-    if (props.debug) {
+    if (log.get('debug') || props.debug) {
       await loadWebGLDeveloperTools();
     }
+
     // @ts-expect-error spector not on props
-    if (props.spector) {
+    const {spector} = props;
+    if (log.get('spector') || spector) {
       await loadSpectorJS();
     }
 
-    log.probe(LOG_LEVEL, 'DOM is loaded')();
+    log.probe(LOG_LEVEL + 1, 'DOM is loaded')();
+
+    // @ts-expect-error
+    if (props.gl && props.gl.device) {
+      return WebGLDevice.attach(props.gl);
+    }
+
     return new WebGLDevice(props);
   }
 
+  //
+  // Public API
+  //
+
   constructor(props: DeviceProps) {
-    super(props);
+    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
     const device: WebGLDevice | undefined = props.gl?.device;
     if (device) {
-      log.warn(`WebGL context already attached to device ${device.id}`);
-      return device;
+      throw new Error(`WebGL context already attached to device ${device.id}`);
     }
 
     // Create and instrument context
     this.canvasContext = new WebGLCanvasContext(this, props);
 
-    this.handle = props.gl || createBrowserContext(this.canvasContext.canvas, props);
+    this.lost = new Promise<{reason: 'destroyed'; message: string}>(resolve => {
+      this._resolveContextLost = resolve;
+    });
+
+    const onContextLost = (event: Event) =>
+      this._resolveContextLost?.({
+        reason: 'destroyed',
+        message: 'Computer entered sleep mode, or too many apps or browser tabs are using the GPU.'
+      });
+
+    let gl: WebGLRenderingContext | WebGL2RenderingContext | null = props.gl || null;
+    gl =
+      gl ||
+      (isBrowser()
+        ? createBrowserContext(this.canvasContext.canvas, {...props, onContextLost})
+        : null);
+    gl = gl || (!isBrowser() ? createHeadlessContext({...props, onContextLost}) : null);
+
+    if (!gl) {
+      throw new Error('WebGL context creation failed');
+    }
+
+    this.handle = gl;
     this.gl = this.handle;
     this.gl2 = this.gl as WebGL2RenderingContext;
     this.isWebGL2 = isWebGL2(this.gl);
@@ -182,13 +210,20 @@ export default class WebGLDevice extends Device implements ContextState {
 
     // @ts-expect-error Link webgl context back to device
     this.gl.device = this;
-    // @ts-expect-error Annotate webgl context to handle 
+    // @ts-expect-error Annotate webgl context to handle
     this.gl._version = this.isWebGL2 ? 2 : 1;
 
     // Add subset of WebGL2 methods to WebGL1 context
     polyfillContext(this.gl);
+
     // Install context state tracking
-    trackContextState(this.gl, {copyState: false, log: (...args: any[]) => log.log(1, ...args)()});
+    // @ts-expect-error - hidden parameters
+    const {enable = true, copyState = false} = props;
+    trackContextState(this.gl, {
+      enable,
+      copyState,
+      log: (...args: any[]) => log.log(1, ...args)()
+    });
 
     // DEBUG contexts: Add debug instrumentation to the context, force log level to at least 1
     if (isBrowser() && props.debug) {
@@ -218,16 +253,11 @@ ${this.info.vendor}, ${this.info.renderer} for canvas: ${this.canvasContext.id}`
    * Destroys the context
    * @note Has no effect for browser contexts, there is no browser API for destroying contexts
    */
-  destroy() {
-    let ext = this.gl.getExtension('STACKGL_destroy_context');
+  destroy(): void {
+    const ext = this.gl.getExtension('STACKGL_destroy_context');
     if (ext) {
       ext.destroy();
     }
-    // ext = this.gl.getExtension('WEBGL_lose_context');
-    // if (ext) {
-    //   // TODO - disconnect context lost callbacks?
-    //   ext.loseContext();
-    // }
   }
 
   get isLost(): boolean {
@@ -254,7 +284,9 @@ ${this.info.vendor}, ${this.info.renderer} for canvas: ${this.canvasContext.id}`
 
   /** Returns a WebGL2RenderingContext or throws an error */
   assertWebGL2(): WebGL2RenderingContext {
-    assert(this.isWebGL2, 'Requires WebGL2');
+    if (!this.gl2) {
+      throw new Error('Requires WebGL2');
+    }
     return this.gl2;
   }
 
@@ -264,8 +296,9 @@ ${this.info.vendor}, ${this.info.renderer} for canvas: ${this.canvasContext.id}`
     throw new Error('WebGL only supports a single canvas');
   }
 
-  _createBuffer(props: BufferProps): WEBGLBuffer {
-    return new ClassicBuffer(this, props);
+  createBuffer(props: BufferProps | ArrayBuffer | ArrayBufferView): WEBGLBuffer {
+    const newProps = this._getBufferProps(props);
+    return new BufferWithAccessor(this, newProps);
   }
 
   _createTexture(props: TextureProps): WEBGLTexture {
@@ -292,6 +325,10 @@ ${this.info.vendor}, ${this.info.renderer} for canvas: ${this.canvasContext.id}`
     return new WEBGLRenderPipeline(this, props);
   }
 
+  override createVertexArray(props: VertexArrayProps): VertexArray {
+    return new WEBGLVertexArray(this, props);
+  }
+
   beginRenderPass(props: RenderPassProps): WEBGLRenderPass {
     return new WEBGLRenderPass(this, props);
   }
@@ -304,7 +341,7 @@ ${this.info.vendor}, ${this.info.renderer} for canvas: ${this.canvasContext.id}`
     throw new Error('compute shaders not supported in WebGL');
   }
 
-  private renderPass: WEBGLRenderPass;
+  private renderPass: WEBGLRenderPass | null = null;
 
   getDefaultRenderPass(): WEBGLRenderPass {
     this.renderPass =
@@ -315,16 +352,143 @@ ${this.info.vendor}, ${this.info.renderer} for canvas: ${this.canvasContext.id}`
     return this.renderPass;
   }
 
+  override createCommandEncoder(props: CommandEncoderProps): WEBGLCommandEncoder {
+    return new WEBGLCommandEncoder(this, props);
+  }
+
   /**
    * Offscreen Canvas Support: Commit the frame
    * https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/commit
    * Chrome's offscreen canvas does not require gl.commit
    */
   submit(): void {
-    this.renderPass.endPass();
+    this.renderPass?.end();
     this.renderPass = null;
     // this.canvasContext.commit();
   }
+
+  //
+  // WebGL-only API (not part of `Device` API)
+  //
+
+  /** WebGL1 typed context. Can always be used. */
+  readonly gl: WebGLRenderingContext;
+  /** WebGL2 typed context. Need to check isWebGL2 or isWebGL1 before using. */
+  readonly gl2: WebGL2RenderingContext | null = null;
+  readonly debug: boolean = false;
+
+  /** `true` if this is a WebGL1 context. @note `false` if WebGL2 */
+  readonly isWebGL1: boolean;
+  /** `true` if this is a WebGL2 context. @note `false` if WebGL1 */
+  readonly isWebGL2: boolean;
+
+  /** 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: Record<string, any> = {};
+  _polyfilled: boolean = false;
+
+  /** Instance of Spector.js (if initialized) */
+  spector;
+
+  private _webglLimits?: WebGLLimits;
+
+  /** Return WebGL specific limits */
+  get webglLimits(): WebGLLimits {
+    this._webglLimits = this._webglLimits || getWebGLLimits(this.gl);
+    return this._webglLimits;
+  }
+
+  /**
+   * Triggers device (or WebGL context) loss.
+   * @note primarily intended for testing how application reacts to device loss
+   */
+  override loseDevice(): boolean {
+    let deviceLossTriggered = false;
+    const ext = this.gl.getExtension('WEBGL_lose_context');
+    if (ext) {
+      deviceLossTriggered = true;
+      ext.loseContext();
+      // ext.loseContext should trigger context loss callback but the platform may not do this, so do it explicitly
+    }
+    this._resolveContextLost?.({
+      reason: 'destroyed',
+      message: 'Application triggered context loss'
+    });
+    return deviceLossTriggered;
+  }
+
+  /** Save current WebGL context state onto an internal stack */
+  pushState(): void {
+    pushContextState(this.gl);
+  }
+
+  /** Restores previously saved context state */
+  popState(): void {
+    popContextState(this.gl);
+  }
+
+  /**
+   * Storing data on a special field on WebGLObjects makes that data visible in SPECTOR chrome debug extension
+   * luma.gl ids and props can be inspected
+   */
+  setSpectorMetadata(handle: unknown, props: Record<string, unknown>) {
+    // @ts-expect-error
+    // eslint-disable-next-line camelcase
+    handle.__SPECTOR_Metadata = props;
+  }
+
+  /**
+   * Returns the GL.<KEY> constant that corresponds to a numeric value of a GL constant
+   * Be aware that there are some duplicates especially for constants that are 0,
+   * so this isn't guaranteed to return the right key in all cases.
+   */
+  getGLKey(value: unknown, gl?: WebGLRenderingContext): string {
+    // @ts-ignore expect-error depends on settings
+    gl = gl || this.gl2 || this.gl;
+    const number = Number(value);
+    for (const key in gl) {
+      // @ts-ignore expect-error depends on settings
+      if (gl[key] === number) {
+        return `GL.${key}`;
+      }
+    }
+    // No constant found. Stringify the value and return it.
+    return String(value);
+  }
+
+  /** Store constants */
+  _constants: (TypedArray | null)[];
+
+  /**
+   * Set a constant value for a location. Disabled attributes at that location will read from this value
+   * @note WebGL constants are stored globally on the WebGL context, not the VertexArray
+   * so they need to be updated before every render
+   * @todo - remember/cache values to avoid setting them unnecessarily?
+   */
+  setConstantAttribute(location: number, constant: TypedArray): void {
+    this._constants = this._constants || new Array(this.limits.maxVertexAttributes).fill(null);
+    const currentConstant = this._constants[location];
+    if (currentConstant && compareConstantArrayValues(currentConstant, constant)) {
+      log.info(1, `setConstantAttribute(${location}) could have been skipped, value unchanged`)();
+    }
+    this._constants[location] = constant;
+
+    switch (constant.constructor) {
+      case Float32Array:
+        setConstantFloatArray(this, location, constant as Float32Array);
+        break;
+      case Int32Array:
+        setConstantIntArray(this, location, constant as Int32Array);
+        break;
+      case Uint32Array:
+        setConstantUintArray(this, location, constant as Uint32Array);
+        break;
+      default:
+        assert(false);
+    }
+  }
 }
 
 /** Check if supplied parameter is a WebGLRenderingContext */
@@ -339,7 +503,6 @@ function isWebGL(gl: any): boolean {
   return Boolean(gl && Number.isFinite(gl._version));
 }
 
-
 /** Check if supplied parameter is a WebGL2RenderingContext */
 function isWebGL2(gl: any): boolean {
   if (typeof WebGL2RenderingContext !== 'undefined' && gl instanceof WebGL2RenderingContext) {
@@ -348,3 +511,83 @@ function isWebGL2(gl: any): boolean {
   // Look for debug contexts, headless gl etc
   return Boolean(gl && gl._version === 2);
 }
+
+/** Set constant float array attribute */
+function setConstantFloatArray(device: WebGLDevice, location: number, array: Float32Array): void {
+  switch (array.length) {
+    case 1:
+      device.gl.vertexAttrib1fv(location, array);
+      break;
+    case 2:
+      device.gl.vertexAttrib2fv(location, array);
+      break;
+    case 3:
+      device.gl.vertexAttrib3fv(location, array);
+      break;
+    case 4:
+      device.gl.vertexAttrib4fv(location, array);
+      break;
+    default:
+      assert(false);
+  }
+}
+
+/** Set constant signed int array attribute */
+function setConstantIntArray(device: WebGLDevice, location: number, array: Int32Array): void {
+  device.assertWebGL2();
+  device.gl2?.vertexAttribI4iv(location, array);
+  // TODO - not clear if we need to use the special forms, more testing needed
+  // switch (array.length) {
+  //   case 1:
+  //     gl.vertexAttribI1iv(location, array);
+  //     break;
+  //   case 2:
+  //     gl.vertexAttribI2iv(location, array);
+  //     break;
+  //   case 3:
+  //     gl.vertexAttribI3iv(location, array);
+  //     break;
+  //   case 4:
+  //     break;
+  //   default:
+  //     assert(false);
+  // }
+}
+
+/** Set constant unsigned int array attribute */
+function setConstantUintArray(device: WebGLDevice, location: number, array: Uint32Array) {
+  device.assertWebGL2();
+  device.gl2?.vertexAttribI4uiv(location, array);
+  // TODO - not clear if we need to use the special forms, more testing needed
+  // switch (array.length) {
+  //   case 1:
+  //     gl.vertexAttribI1uiv(location, array);
+  //     break;
+  //   case 2:
+  //     gl.vertexAttribI2uiv(location, array);
+  //     break;
+  //   case 3:
+  //     gl.vertexAttribI3uiv(location, array);
+  //     break;
+  //   case 4:
+  //     gl.vertexAttribI4uiv(location, array);
+  //     break;
+  //   default:
+  //     assert(false);
+  // }
+}
+
+/**
+ *
+ */
+function compareConstantArrayValues(v1: TypedArray, v2: TypedArray): boolean {
+  if (!v1 || !v2 || v1.length !== v2.length || v1.constructor !== v2.constructor) {
+    return false;
+  }
+  for (let i = 0; i < v1.length; ++i) {
+    if (v1[i] !== v2[i]) {
+      return false;
+    }
+  }
+  return true;
+}

package/src/classic/accessor.ts

@@ -1,19 +1,9 @@
-import {assert, checkProps, Buffer, AccessorObject} from '@luma.gl/api';
-import GL from '@luma.gl/constants';
-import {getTypedArrayFromGLType} from './typed-array-utils';
-
-// export interface AccessorObject {
-//   offset?: number;
-//   stride?: number;
-//   type?: number;
-//   size?: number;
-//   divisor?: number;
-//   normalized?: boolean;
-//   integer?: boolean;
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
 
-//   buffer?: Buffer;
-//   index?: number;
-// }
+import {assert, checkProps, Buffer, AccessorObject} from '@luma.gl/core';
+import {GL} from '@luma.gl/constants';
+import {getTypedArrayFromGLType} from './typed-array-utils';
 
 const DEFAULT_ACCESSOR_VALUES = {
   offset: 0,
@@ -32,7 +22,7 @@ const PROP_CHECKS = {
   }
 };
 
-export default class Accessor implements AccessorObject {
+export class Accessor implements AccessorObject {
   offset?: number;
   stride?: number;
   type?: number;
@@ -98,7 +88,7 @@ export default class Accessor implements AccessorObject {
 
       // Auto-deduce integer type?
       if (props.type === GL.INT || props.type === GL.UNSIGNED_INT) {
-      this.integer = true;
+        this.integer = true;
       }
     }
     if (props.size !== undefined) {