@luma.gl/webgl 9.0.0-beta.1 → 9.0.0-beta.10

package/src/adapter/resources/webgl-framebuffer.ts

@@ -1,4 +1,5 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import type {FramebufferProps, TextureFormat} from '@luma.gl/core';
@@ -6,16 +7,18 @@ import {Framebuffer, Texture, assert} from '@luma.gl/core';
 import {GL} from '@luma.gl/constants';
 import {WebGLDevice} from '../webgl-device';
 import {WEBGLTexture} from './webgl-texture';
-import {WEBGLRenderbuffer} from '../objects/webgl-renderbuffer';
+import {WEBGLTextureView} from './webgl-texture-view';
 import {getDepthStencilAttachmentWebGL} from '../converters/texture-formats';
 
-export type TextureAttachment = [Texture, number?, number?];
-export type Attachment = WEBGLTexture | WEBGLRenderbuffer | TextureAttachment;
+// TODO - for now we don't see a usage for renderbuffers in WebGL 2.
+// import {WEBGLRenderbuffer} from '../objects/webgl-renderbuffer';
+
+export type Attachment = WEBGLTextureView | WEBGLTexture; // | WEBGLRenderbuffer;
 
 /** luma.gl Framebuffer, WebGL implementation  */
 export class WEBGLFramebuffer extends Framebuffer {
   device: WebGLDevice;
-  gl: WebGLRenderingContext;
+  gl: WebGL2RenderingContext;
   handle: WebGLFramebuffer;
 
   get texture() {
@@ -45,26 +48,30 @@ export class WEBGLFramebuffer extends Framebuffer {
 
       // Walk the attachments
       for (let i = 0; i < this.colorAttachments.length; ++i) {
-        const attachment = this.colorAttachments[i];
+        const attachment = this.colorAttachments[i] as WEBGLTextureView;
         const attachmentPoint = GL.COLOR_ATTACHMENT0 + i;
         if (attachment) {
-          this._attachOne(attachmentPoint, attachment as WEBGLTexture);
+          this._attachOne(attachmentPoint, attachment);
         }
       }
 
       if (this.depthStencilAttachment) {
         this._attachOne(
-          getDepthStencilAttachmentWebGL(this.depthStencilAttachment.format),
-          this.depthStencilAttachment as WEBGLTexture
+          getDepthStencilAttachmentWebGL(this.depthStencilAttachment.props.format),
+          this.depthStencilAttachment as WEBGLTextureView
         );
       }
 
-      this.gl.bindFramebuffer(GL.FRAMEBUFFER, null);
-    }
+      /** Check the status */
+      // @ts-expect-error
+      if (props.check !== false) {
+        const status = this.gl.checkFramebufferStatus(GL.FRAMEBUFFER) as GL;
+        if (status !== GL.FRAMEBUFFER_COMPLETE) {
+          throw new Error(`Framebuffer ${_getFrameBufferStatus(status)}`);
+        }
+      }
 
-    // @ts-expect-error
-    if (props.check !== false) {
-      this._checkStatus();
+      this.gl.bindFramebuffer(GL.FRAMEBUFFER, null);
     }
   }
 
@@ -79,32 +86,20 @@ export class WEBGLFramebuffer extends Framebuffer {
 
   // PRIVATE
 
-  /** Check the status */
-  protected _checkStatus(): void {
-    const {gl} = this;
-    // TODO - should we really rely on this trick? 
-    const prevHandle = gl.bindFramebuffer(GL.FRAMEBUFFER, this.handle) as unknown as WebGLFramebuffer;
-    const status = gl.checkFramebufferStatus(GL.FRAMEBUFFER);
-    gl.bindFramebuffer(GL.FRAMEBUFFER, prevHandle || null);
-    if (status !== gl.FRAMEBUFFER_COMPLETE) {
-      throw new Error(`Framebuffer ${_getFrameBufferStatus(status)}`);
-    }
-  }
-
   /** In WebGL we must use renderbuffers for depth/stencil attachments (unless we have extensions) */
   protected override createDepthStencilTexture(format: TextureFormat): Texture {
-    return new WEBGLRenderbuffer(this.device, {
-      id: `${this.id}-depth-stencil`, // TODO misleading if not depth and stencil?
+    // return new WEBGLRenderbuffer(this.device, {
+    return new WEBGLTexture(this.device, {
+      id: `${this.id}-depth-stencil`,
       format,
-      // dataFormat: GL.DEPTH_STENCIL,
-      // type: GL.UNSIGNED_INT_24_8,
       width: this.width,
-      height: this.height
-    }) as unknown as WEBGLTexture;
+      height: this.height,
+      mipmaps: false
+    });
   }
 
-  /** 
-   * Attachment resize is expected to be a noop if size is same 
+  /**
+   * Attachment resize is expected to be a noop if size is same
    */
   protected override resizeAttachments(width: number, height: number): this {
     // for default framebuffer, just update the stored size
@@ -125,47 +120,57 @@ export class WEBGLFramebuffer extends Framebuffer {
     // TODO Not clear that this is better than default destroy/create implementation
 
     for (const colorAttachment of this.colorAttachments) {
-      (colorAttachment as WEBGLTexture).resize({width, height});
+      (colorAttachment.texture as WEBGLTexture).resize({width, height});
     }
     if (this.depthStencilAttachment) {
-      (this.depthStencilAttachment as WEBGLTexture).resize({width, height});
+      (this.depthStencilAttachment.texture as WEBGLTexture).resize({width, height});
     }
     return this;
   }
 
   /** Attach one attachment */
-  protected _attachOne(
-    attachmentPoint: GL,
-    attachment: Attachment
-  ): WEBGLTexture | WEBGLRenderbuffer {
-    if (attachment instanceof WEBGLRenderbuffer) {
-      this._attachWEBGLRenderbuffer(attachmentPoint, attachment);
-      return attachment;
-    } else if (Array.isArray(attachment)) {
+  protected _attachOne(attachmentPoint: GL, attachment: Attachment): WEBGLTexture {
+    // if (attachment instanceof WEBGLRenderbuffer) {
+    //   this._attachWEBGLRenderbuffer(attachmentPoint, attachment);
+    //   return attachment;
+    // }
+    if (Array.isArray(attachment)) {
       const [texture, layer = 0, level = 0] = attachment;
       this._attachTexture(attachmentPoint, texture as unknown as WEBGLTexture, layer, level);
       return texture as unknown as WEBGLTexture;
-    } else if (attachment instanceof WEBGLTexture) {
+    }
+    if (attachment instanceof WEBGLTexture) {
       this._attachTexture(attachmentPoint, attachment, 0, 0);
       return attachment;
     }
+    if (attachment instanceof WEBGLTextureView) {
+      const textureView = attachment;
+      this._attachTexture(
+        attachmentPoint,
+        textureView.texture,
+        textureView.props.baseMipLevel,
+        textureView.props.baseArrayLayer
+      );
+      return attachment.texture;
+    }
     throw new Error('attach');
   }
 
-  protected _attachWEBGLRenderbuffer(attachment: GL, renderbuffer: WEBGLRenderbuffer): void {
-    this.gl.framebufferRenderbuffer(
-      GL.FRAMEBUFFER,
-      attachment,
-      GL.RENDERBUFFER,
-      renderbuffer.handle
-    );
-  }
+  // TODO - we do not seem to need render buffers in WebGL 2
+  // protected _attachWEBGLRenderbuffer(attachment: GL, renderbuffer: WEBGLRenderbuffer): void {
+  //   this.gl.framebufferRenderbuffer(
+  //     GL.FRAMEBUFFER,
+  //     attachment,
+  //     GL.RENDERBUFFER,
+  //     renderbuffer.handle
+  //   );
+  // }
 
   /**
    * @param attachment
    * @param texture
    * @param layer = 0 - index into WEBGLTextureArray and Texture3D or face for `TextureCubeMap`
-   * @param level  = 0 - mipmapLevel (must be 0 in WebGL1)
+   * @param level = 0 - mipmapLevel
    */
   protected _attachTexture(
     attachment: GL,
@@ -173,14 +178,14 @@ export class WEBGLFramebuffer extends Framebuffer {
     layer: number,
     level: number
   ): void {
-    const {gl, gl2} = this.device;
+    const {gl} = this.device;
+
     gl.bindTexture(texture.target, texture.handle);
 
     switch (texture.target) {
       case GL.TEXTURE_2D_ARRAY:
       case GL.TEXTURE_3D:
-        this.device.assertWebGL2();
-        gl2?.framebufferTextureLayer(GL.FRAMEBUFFER, attachment, texture.target, level, layer);
+        gl.framebufferTextureLayer(GL.FRAMEBUFFER, attachment, texture.target, level, layer);
         break;
 
       case GL.TEXTURE_CUBE_MAP:
@@ -207,7 +212,9 @@ export class WEBGLFramebuffer extends Framebuffer {
 function mapIndexToCubeMapFace(layer: number | GL): GL {
   // TEXTURE_CUBE_MAP_POSITIVE_X is a big value (0x8515)
   // if smaller assume layer is index, otherwise assume it is already a cube map face constant
-  return layer < (GL.TEXTURE_CUBE_MAP_POSITIVE_X as number) ? layer + GL.TEXTURE_CUBE_MAP_POSITIVE_X : layer;
+  return layer < (GL.TEXTURE_CUBE_MAP_POSITIVE_X as number)
+    ? layer + GL.TEXTURE_CUBE_MAP_POSITIVE_X
+    : layer;
 }
 
 // Helper METHODS

package/src/adapter/resources/webgl-query-set.ts

@@ -0,0 +1,171 @@
+// WebGL2 Query (also handles disjoint timer extensions)
+import {QuerySet, QuerySetProps} from '@luma.gl/core';
+import {GL} from '@luma.gl/constants';
+import {WebGLDevice} from '../webgl-device';
+
+/**
+ * Asynchronous queries for different kinds of information
+ */
+export class WEBGLQuerySet extends QuerySet {
+  device: WebGLDevice;
+  handle: WebGLQuery;
+
+  target: number | null = null;
+  _queryPending = false;
+  _pollingPromise: Promise<any> | null = null;
+
+  override get [Symbol.toStringTag](): string {
+    return 'Query';
+  }
+
+  // Create a query class
+  constructor(device: WebGLDevice, props: QuerySetProps) {
+    super(device, props);
+    this.device = device;
+
+    if (props.count > 1) {
+      throw new Error('WebGL QuerySet can only have one value');
+    }
+
+    this.handle = this.device.gl.createQuery();
+    Object.seal(this);
+  }
+
+  override destroy() {
+    this.device.gl.deleteQuery(this.handle);
+  }
+
+  // FOR RENDER PASS AND COMMAND ENCODER
+
+  /**
+   * Shortcut for timer query (dependent on extension in both WebGL1 and 2)
+   * Measures GPU time delta between this call and a matching `end` call in the
+   * GPU instruction stream.
+   */
+  beginTimestampQuery(): void {
+    return this._begin(GL.TIME_ELAPSED_EXT);
+  }
+
+  endTimestampQuery(): void {
+    this._end();
+  }
+
+  // Shortcut for occlusion queries
+  beginOcclusionQuery(options?: {conservative?: boolean}): void {
+    return this._begin(
+      options?.conservative ? GL.ANY_SAMPLES_PASSED_CONSERVATIVE : GL.ANY_SAMPLES_PASSED
+    );
+  }
+
+  endOcclusionQuery() {
+    this._end();
+  }
+
+  // Shortcut for transformFeedbackQuery
+  beginTransformFeedbackQuery(): void {
+    return this._begin(GL.TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN);
+  }
+
+  endTransformFeedbackQuery(): void {
+    this._end();
+  }
+
+  async resolveQuery(): Promise<bigint[]> {
+    const value = await this.pollQuery();
+    return [value];
+  }
+
+  // PRIVATE METHODS
+
+  /**
+   * Due to OpenGL API limitations, after calling `begin()` on one Query
+   * instance, `end()` must be called on that same instance before
+   * calling `begin()` on another query. While there can be multiple
+   * outstanding queries representing disjoint `begin()`/`end()` intervals.
+   * It is not possible to interleave or overlap `begin` and `end` calls.
+   */
+  protected _begin(target: number): void {
+    // Don't start a new query if one is already active.
+    if (this._queryPending) {
+      return;
+    }
+
+    this.target = target;
+    this.device.gl.beginQuery(this.target, this.handle);
+
+    return;
+  }
+
+  // ends the current query
+  protected _end(): void {
+    // Can't end a new query if the last one hasn't been resolved.
+    if (this._queryPending) {
+      return;
+    }
+
+    if (this.target) {
+      this.device.gl.endQuery(this.target);
+      this.target = null;
+      this._queryPending = true;
+    }
+    return;
+  }
+
+  // Returns true if the query result is available
+  isResultAvailable(): boolean {
+    if (!this._queryPending) {
+      return false;
+    }
+
+    const resultAvailable = this.device.gl.getQueryParameter(
+      this.handle,
+      GL.QUERY_RESULT_AVAILABLE
+    );
+    if (resultAvailable) {
+      this._queryPending = false;
+    }
+    return resultAvailable;
+  }
+
+  // Timing query is disjoint, i.e. results are invalid
+  isTimerDisjoint(): boolean {
+    return this.device.gl.getParameter(GL.GPU_DISJOINT_EXT);
+  }
+
+  // Returns query result.
+  getResult(): any {
+    return this.device.gl.getQueryParameter(this.handle, GL.QUERY_RESULT);
+  }
+
+  // Returns the query result, converted to milliseconds to match JavaScript conventions.
+  getTimerMilliseconds() {
+    return this.getResult() / 1e6;
+  }
+
+  // Polls the query
+  pollQuery(limit: number = Number.POSITIVE_INFINITY): Promise<any> {
+    if (this._pollingPromise) {
+      return this._pollingPromise;
+    }
+
+    let counter = 0;
+
+    this._pollingPromise = new Promise((resolve, reject) => {
+      const poll = () => {
+        if (this.isResultAvailable()) {
+          resolve(this.getResult());
+          this._pollingPromise = null;
+        } else if (counter++ > limit) {
+          reject('Timed out');
+          this._pollingPromise = null;
+        } else {
+          requestAnimationFrame(poll);
+        }
+      };
+
+      requestAnimationFrame(poll);
+    });
+
+    return this._pollingPromise;
+  }
+}

package/src/adapter/resources/webgl-render-pass.ts

@@ -1,4 +1,5 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {RenderPass, RenderPassProps, NumberArray, RenderPassParameters} from '@luma.gl/core';
@@ -7,6 +8,7 @@ import {GL, GLParameters} from '@luma.gl/constants';
 import {withGLParameters} from '../../context/state-tracker/with-parameters';
 import {setGLParameters} from '../../context/parameters/unified-parameter-api';
 import {pushContextState, popContextState} from '../../context/state-tracker/track-context-state';
+import {WEBGLQuerySet} from './webgl-query-set';
 
 // Should collapse during minification
 const GL_DEPTH_BUFFER_BIT = 0x00000100;
@@ -36,7 +38,7 @@ export class WEBGLRenderPass extends RenderPass {
   end(): void {
     popContextState(this.device.gl);
     if (this.props.framebuffer) {
-      setGLParameters(this.device, {framebuffer: null});
+      setGLParameters(this.device.gl, {framebuffer: null});
     }
     // should add commands to CommandEncoder.
   }
@@ -45,8 +47,6 @@ export class WEBGLRenderPass extends RenderPass {
   popDebugGroup(): void {}
   insertDebugMarker(markerLabel: string): void {}
 
-  // writeTimestamp(querySet: GPUQuerySet, queryIndex: number): void;
-
   // beginOcclusionQuery(queryIndex: number): void;
   // endOcclusionQuery(): void;
 
@@ -99,10 +99,20 @@ export class WEBGLRenderPass extends RenderPass {
 
     this.glParameters = glParameters;
 
-    setGLParameters(this.device, glParameters);
+    setGLParameters(this.device.gl, glParameters);
+  }
+
+  beginOcclusionQuery(queryIndex: number): void {
+    const webglQuerySet = this.props.occlusionQuerySet as WEBGLQuerySet;
+    webglQuerySet?.beginOcclusionQuery();
   }
 
-  // Internal
+  override endOcclusionQuery(): void {
+    const webglQuerySet = this.props.occlusionQuerySet as WEBGLQuerySet;
+    webglQuerySet?.endOcclusionQuery();
+  }
+
+  // PRIVATE
 
   /**
    * Optionally clears depth, color and stencil buffers based on parameters
@@ -127,33 +137,33 @@ export class WEBGLRenderPass extends RenderPass {
 
     if (clearMask !== 0) {
       // Temporarily set any clear "colors" and call clear
-      withGLParameters(this.device, glParameters, () => {
+      withGLParameters(this.device.gl, glParameters, () => {
         this.device.gl.clear(clearMask);
       });
 
       // TODO - clear multiple color attachments
       // for (attachment of this.framebuffer.colorAttachments) {
-      //   this.clearColorBuffer  
+      //   this.clearColorBuffer
       // }
     }
   }
 
-  /** 
-   * WebGL2 - clear a specific color buffer 
+  /**
+   * WebGL2 - clear a specific color buffer
    */
   protected clearColorBuffer(drawBuffer: number = 0, value: NumberArray = [0, 0, 0, 0]) {
-    withGLParameters(this.device.gl2, {framebuffer: this.props.framebuffer}, () => {
+    withGLParameters(this.device.gl, {framebuffer: this.props.framebuffer}, () => {
       // Method selection per OpenGL ES 3 docs
       switch (value.constructor) {
         case Int32Array:
-          this.device.gl2.clearBufferiv(GL_COLOR, drawBuffer, value);
+          this.device.gl.clearBufferiv(GL_COLOR, drawBuffer, value);
           break;
         case Uint32Array:
-          this.device.gl2.clearBufferuiv(GL_COLOR, drawBuffer, value);
+          this.device.gl.clearBufferuiv(GL_COLOR, drawBuffer, value);
           break;
         case Float32Array:
         default:
-          this.device.gl2.clearBufferfv(GL_COLOR, drawBuffer, value);
+          this.device.gl.clearBufferfv(GL_COLOR, drawBuffer, value);
           break;
       }
     });
@@ -165,16 +175,16 @@ export class WEBGLRenderPass extends RenderPass {
   // const GL_DEPTH_STENCIL = 0x84f9;
 
   //     case GL_DEPTH:
-  //       this.device.gl2.clearBufferfv(GL_DEPTH, 0, [value]);
+  //       this.device.gl.clearBufferfv(GL_DEPTH, 0, [value]);
   //       break;
 
   //     case GL_STENCIL:
-  //       this.device.gl2.clearBufferiv(GL_STENCIL, 0, [value]);
+  //       this.device.gl.clearBufferiv(GL_STENCIL, 0, [value]);
   //       break;
 
   //     case GL_DEPTH_STENCIL:
   //       const [depth, stencil] = value;
-  //       this.device.gl2.clearBufferfi(GL_DEPTH_STENCIL, 0, depth, stencil);
+  //       this.device.gl.clearBufferfi(GL_DEPTH_STENCIL, 0, depth, stencil);
   //       break;
 
   //     default:
@@ -182,4 +192,3 @@ export class WEBGLRenderPass extends RenderPass {
   //   }
   // });
 }
-