@luma.gl/webgl 9.0.0-alpha.10 → 9.0.0-alpha.12

package/src/adapter/webgl-device.ts

@@ -7,11 +7,10 @@ import type {
   CanvasContextProps,
   TextureFormat
 } from '@luma.gl/api';
-import {Device, CanvasContext, log, assert} from '@luma.gl/api';
+import {Device, CanvasContext, log, uid} from '@luma.gl/api';
 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 {popContextState, pushContextState, trackContextState} from '../context/state-tracker/track-context-state';
 import {createBrowserContext} from '../context/context/create-browser-context';
 import {
   createHeadlessContext,
@@ -33,17 +32,17 @@ import {
 import type {
   BufferProps,
   ShaderProps,
-  Sampler,
+  // Sampler,
   SamplerProps,
   TextureProps,
   ExternalTexture,
   ExternalTextureProps,
   FramebufferProps,
-  RenderPipeline,
+  // RenderPipeline,
   RenderPipelineProps,
   ComputePipeline,
   ComputePipelineProps,
-  RenderPass,
+  // RenderPass,
   RenderPassProps,
   ComputePass,
   ComputePassProps
@@ -60,10 +59,8 @@ import WEBGLRenderPipeline from './resources/webgl-render-pipeline';
 
 const LOG_LEVEL = 1;
 
-let counter = 0;
-
 /** WebGPU style Device API for a WebGL context */
-export default class WebGLDevice extends Device implements ContextState {
+export default class WebGLDevice extends Device {
   //
   // Public `Device` API
   //
@@ -95,37 +92,6 @@ export default class WebGLDevice extends Device implements ContextState {
   private _features?: Set<DeviceFeature>;
   private _limits?: DeviceLimits;
 
-  //
-  // 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;
-
-  get webglLimits(): WebGLLimits {
-    this._webglLimits = this._webglLimits || getWebGLLimits(this.gl);
-    return this._webglLimits;
-  }
-
-  private _webglLimits?: WebGLLimits;
-
-  /** 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()`
   //
@@ -184,7 +150,7 @@ export default class WebGLDevice extends Device implements ContextState {
   //
 
   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
@@ -206,7 +172,7 @@ export default class WebGLDevice extends Device implements ContextState {
         message: 'Computer entered sleep mode, or too many apps or browser tabs are using the GPU.'
       });
 
-    let gl: WebGLRenderingContext | WebGL2RenderingContext | null = props.gl;
+    let gl: WebGLRenderingContext | WebGL2RenderingContext | null = props.gl || null;
     gl =
       gl ||
       (isBrowser() ? createBrowserContext(this.canvasContext.canvas, {...props, onContextLost}) : null);
@@ -270,29 +236,13 @@ ${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() {
+  destroy(): void {
     const ext = this.gl.getExtension('STACKGL_destroy_context');
     if (ext) {
       ext.destroy();
     }
   }
 
-  /**
-   * Loses the context
-   * @note Triggers context loss, mainly for testing
-   */
-  loseDevice() {
-    const ext = this.gl.getExtension('WEBGL_lose_context');
-    if (ext) {
-      ext.loseContext();
-    }
-    // loseContext should trigger context loss callback but 
-    this._resolveContextLost?.({
-      reason: 'destroyed',
-      message: 'Application triggered context loss'
-    });
-  }
-
   get isLost(): boolean {
     return this.gl.isContextLost();
   }
@@ -390,6 +340,66 @@ ${this.info.vendor}, ${this.info.renderer} for canvas: ${this.canvasContext.id}`
     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;
+  }
+
+  /**
+   * Loses the context
+   * @note Triggers context loss, mainly for testing
+   * @todo Promote to `Device` API?
+   */
+   loseDevice(): void {
+    const ext = this.gl.getExtension('WEBGL_lose_context');
+    if (ext) {
+      ext.loseContext();
+    }
+    // loseContext should trigger context loss callback but 
+    this._resolveContextLost?.({
+      reason: 'destroyed',
+      message: 'Application triggered context loss'
+    });
+  }
+
+  /** Save current WebGL context state onto an internal stack */
+  pushState(): void {
+    pushContextState(this.gl);
+  }
+
+  /** Restores previously saved context state */
+  popState(): void {
+    popContextState(this.gl);
+  }
 }
 
 /** Check if supplied parameter is a WebGLRenderingContext */

package/src/classic/buffer.ts

@@ -1,5 +1,7 @@
+// luma.gl, MIT license
+
 import type {Device, BufferProps, TypedArray} from '@luma.gl/api';
-import {Buffer, log, assert, checkProps} from '@luma.gl/api';
+import {assert, checkProps} from '@luma.gl/api';
 import GL from '@luma.gl/constants';
 import {assertWebGL2Context} from '../context/context/webgl-checks';
 import {AccessorObject} from '../types';
@@ -106,7 +108,7 @@ export default class ClassicBuffer extends WEBGLBuffer {
     Object.seal(this);
   }
 
-  destroy(): void {
+  override destroy(): void {
     if (this.handle) {
       this.removeStats();
       this.trackDeallocatedMemory();
@@ -116,9 +118,10 @@ export default class ClassicBuffer extends WEBGLBuffer {
     }
   }
 
-  write(data: TypedArray, byteOffset?: number): void {
+  override write(data: TypedArray, byteOffset?: number): void {
     this.subData({data, offset: byteOffset});
   }
+
   // returns number of elements in the buffer (assuming that the full buffer is used)
   getElementCount(accessor: AccessorObject = this.accessor): number {
     return Math.round(this.byteLength / Accessor.getBytesPerElement(accessor));
@@ -278,7 +281,7 @@ export default class ClassicBuffer extends WEBGLBuffer {
    * Reads data from buffer into an ArrayBufferView or SharedArrayBuffer.
    * @note WEBGL2 ONLY
    */
-  getData(options?: {
+  override getData(options?: {
     dstData?: any;
     srcByteOffset?: number;
     dstOffset?: number;

package/src/context/debug/webgl-developer-tools.ts

@@ -1,5 +1,5 @@
 // luma.gl, MIT license
-import {log, loadScript} from '@luma.gl/api/';
+import {log, loadScript} from '@luma.gl/api';
 import GL from '@luma.gl/constants';
 
 const WEBGL_DEBUG_CDN_URL = 'https://unpkg.com/webgl-debug@2.0.1/index.js';
@@ -11,12 +11,12 @@ type DebugContextProps = {
   webgl2?: boolean;
 };
 
-const DEFAULT_DEBUG_CONTEXT_PROPS: Required<DebugContextProps> = {
-  debug: true,
-  throwOnError: false,
-  break: [],
-  webgl2: false,
-}
+// const DEFAULT_DEBUG_CONTEXT_PROPS: Required<DebugContextProps> = {
+//   debug: true,
+//   throwOnError: false,
+//   break: [],
+//   webgl2: false,
+// }
 
 // Helper to get shared context data
 function getContextData(gl: any) {

package/src/context/parameters/unified-parameter-api.ts

@@ -10,7 +10,6 @@ import {
   GL_PARAMETER_GETTERS
 } from './webgl-parameter-tables';
 
-import {isWebGL} from '../context/webgl-checks';
 import WebGLDevice from '../../adapter/webgl-device';
 
 export type {GLParameters};
@@ -129,6 +128,7 @@ export function resetParameters(device: Device | WebGLRenderingContext): void {
 
 // Returns true if given object is empty, false otherwise.
 function isObjectEmpty(object) {
+  // @ts-ignore dummy key variable
   for (const key in object) {
     return false;
   }