@luma.gl/webgl 9.0.3 → 9.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luma.gl/webgl",
-  "version": "9.0.3",
+  "version": "9.0.5",
   "description": "WebGL2 adapter for the luma.gl core API",
   "type": "module",
   "license": "MIT",
@@ -43,8 +43,8 @@
     "@luma.gl/core": "^9.0.0"
   },
   "dependencies": {
-    "@luma.gl/constants": "9.0.3",
+    "@luma.gl/constants": "9.0.5",
     "@probe.gl/env": "^4.0.2"
   },
-  "gitHead": "543e03b2d4bd865ac86cc8927611b91cc3e0393c"
+  "gitHead": "f8224e596919b431978f87d4f0fd2382d74851b7"
 }

package/src/adapter/converters/device-parameters.ts

@@ -2,18 +2,18 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {
-  Device,
-  Parameters,
-  CompareFunction,
-  StencilOperation,
-  log,
-  isObjectEmpty,
-  BlendOperation,
-  BlendFactor
-} from '@luma.gl/core';
+import type {CompareFunction, StencilOperation, BlendOperation, BlendFactor} from '@luma.gl/core';
+import {Device, log, isObjectEmpty, Parameters, PolygonMode, ProvokingVertex} from '@luma.gl/core';
 import {GL} from '@luma.gl/constants';
-import type {GLBlendEquation, GLBlendFunction, GLParameters} from '@luma.gl/constants';
+import type {
+  GLBlendEquation,
+  GLBlendFunction,
+  GLFunction,
+  GLParameters,
+  GLPolygonMode,
+  GLProvokingVertex,
+  GLStencilOp
+} from '@luma.gl/constants';
 import {pushContextState, popContextState} from '../../context/state-tracker/track-context-state';
 import {setGLParameters} from '../../context/parameters/unified-parameter-api';
 import {WebGLDevice} from '../webgl-device';
@@ -164,10 +164,14 @@ export function setDeviceParameters(device: Device, parameters: Parameters) {
     const ext = extensions.WEBGL_provoking_vertex;
 
     if (parameters.provokingVertex) {
-      const vertex = map('provokingVertex', parameters.provokingVertex, {
-        first: GL.FIRST_VERTEX_CONVENTION_WEBGL,
-        last: GL.LAST_VERTEX_CONVENTION_WEBGL
-      });
+      const vertex = map<ProvokingVertex, GLProvokingVertex>(
+        'provokingVertex',
+        parameters.provokingVertex,
+        {
+          first: GL.FIRST_VERTEX_CONVENTION_WEBGL,
+          last: GL.LAST_VERTEX_CONVENTION_WEBGL
+        }
+      );
       ext?.provokingVertexWEBGL(vertex);
     }
   }
@@ -177,9 +181,9 @@ export function setDeviceParameters(device: Device, parameters: Parameters) {
     const ext = extensions.WEBGL_polygon_mode;
 
     if (parameters.polygonMode) {
-      const mode = map('polygonMode', parameters.provokingVertex, {
+      const mode = map<PolygonMode, GLPolygonMode>('polygonMode', parameters.polygonMode, {
         fill: GL.FILL_WEBGL,
-        lint: GL.LINE_WEBGL
+        line: GL.LINE_WEBGL
       });
       ext?.polygonModeWEBGL(GL.FRONT, mode);
       ext?.polygonModeWEBGL(GL.BACK, mode);
@@ -331,8 +335,8 @@ export function setDeviceParameters(device: Device, parameters: Parameters) {
     });
 */
 
-export function convertCompareFunction(parameter: string, value: CompareFunction): GL {
-  return map(parameter, value, {
+export function convertCompareFunction(parameter: string, value: CompareFunction): GLFunction {
+  return map<CompareFunction, GLFunction>(parameter, value, {
     never: GL.NEVER,
     less: GL.LESS,
     equal: GL.EQUAL,
@@ -344,8 +348,8 @@ export function convertCompareFunction(parameter: string, value: CompareFunction
   });
 }
 
-export function convertToCompareFunction(parameter: string, value: GL): CompareFunction {
-  return map(parameter, value, {
+export function convertToCompareFunction(parameter: string, value: GLFunction): CompareFunction {
+  return map<GLFunction, CompareFunction>(parameter, value, {
     [GL.NEVER]: 'never',
     [GL.LESS]: 'less',
     [GL.EQUAL]: 'equal',
@@ -358,7 +362,7 @@ export function convertToCompareFunction(parameter: string, value: GL): CompareF
 }
 
 function convertStencilOperation(parameter: string, value: StencilOperation): GL {
-  return map(parameter, value, {
+  return map<StencilOperation, GLStencilOp>(parameter, value, {
     keep: GL.KEEP,
     zero: GL.ZERO,
     replace: GL.REPLACE,
@@ -374,17 +378,17 @@ function convertBlendOperationToEquation(
   parameter: string,
   value: BlendOperation
 ): GLBlendEquation {
-  return map(parameter, value, {
+  return map<BlendOperation, GLBlendEquation>(parameter, value, {
     add: GL.FUNC_ADD,
     subtract: GL.FUNC_SUBTRACT,
     'reverse-subtract': GL.FUNC_REVERSE_SUBTRACT,
     min: GL.MIN,
     max: GL.MAX
-  } as Record<BlendOperation, GLBlendEquation>);
+  });
 }
 
 function convertBlendFactorToFunction(parameter: string, value: BlendFactor): GLBlendFunction {
-  return map(parameter, value, {
+  return map<BlendFactor, GLBlendFunction>(parameter, value, {
     one: GL.ONE,
     zero: GL.ZERO,
     'src-color': GL.SRC_COLOR,
@@ -394,15 +398,20 @@ function convertBlendFactorToFunction(parameter: string, value: BlendFactor): GL
     'src-alpha': GL.SRC_ALPHA,
     'one-minus-src-alpha': GL.ONE_MINUS_SRC_ALPHA,
     'dst-alpha': GL.DST_ALPHA,
-    'one-minus-dst-alpha': GL.ONE_MINUS_DST_ALPHA
-  } as Record<BlendFactor, GLBlendFunction>);
+    'one-minus-dst-alpha': GL.ONE_MINUS_DST_ALPHA,
+    'src-alpha-saturated': GL.SRC_ALPHA_SATURATE,
+    'constant-color': GL.CONSTANT_COLOR,
+    'one-minus-constant-color': GL.ONE_MINUS_CONSTANT_COLOR,
+    'constant-alpha': GL.CONSTANT_ALPHA,
+    'one-minus-constant-alpha': GL.ONE_MINUS_CONSTANT_ALPHA
+  });
 }
 
 function message(parameter: string, value: any): string {
   return `Illegal parameter ${value} for ${parameter}`;
 }
 
-function map(parameter: string, value: any, valueMap: Record<string, any>): any {
+function map<K extends string | number, V>(parameter: string, value: K, valueMap: Record<K, V>): V {
   if (!(value in valueMap)) {
     throw new Error(message(parameter, value));
   }

package/src/adapter/resources/webgl-command-buffer.ts

@@ -153,6 +153,7 @@ function _copyTextureToBuffer(device: WebGLDevice, options: CopyTextureToBufferO
 
   // Asynchronous read (PIXEL_PACK_BUFFER) is WebGL2 only feature
   const {framebuffer, destroyFramebuffer} = getFramebuffer(source);
+  let prevHandle: WebGLFramebuffer | null | undefined;
   try {
     const webglBuffer = destination as WEBGLBuffer;
     const sourceWidth = width || framebuffer.width;
@@ -170,7 +171,8 @@ function _copyTextureToBuffer(device: WebGLDevice, options: CopyTextureToBufferO
     // }
 
     device.gl.bindBuffer(GL.PIXEL_PACK_BUFFER, webglBuffer.handle);
-    device.gl.bindFramebuffer(GL.FRAMEBUFFER, framebuffer.handle);
+    // @ts-expect-error native bindFramebuffer is overridden by our state tracker
+    prevHandle = device.gl.bindFramebuffer(GL.FRAMEBUFFER, framebuffer.handle);
 
     device.gl.readPixels(
       origin[0],
@@ -183,7 +185,10 @@ function _copyTextureToBuffer(device: WebGLDevice, options: CopyTextureToBufferO
     );
   } finally {
     device.gl.bindBuffer(GL.PIXEL_PACK_BUFFER, null);
-    device.gl.bindFramebuffer(GL.FRAMEBUFFER, null);
+    // prevHandle may be unassigned if the try block failed before binding
+    if (prevHandle !== undefined) {
+      device.gl.bindFramebuffer(GL.FRAMEBUFFER, prevHandle);
+    }
 
     if (destroyFramebuffer) {
       framebuffer.destroy();
@@ -218,13 +223,16 @@ function _copyTextureToTexture(device: WebGLDevice, options: CopyTextureToTextur
   const {
     /** Texture to copy to/from. */
     source,
-    /**  Mip-map level of the texture to copy to/from. (Default 0) */
-    // mipLevel = 0,
+    /**  Mip-map level of the texture to copy to (Default 0) */
+    destinationMipLevel = 0,
     /** Defines which aspects of the texture to copy to/from. */
     // aspect = 'all',
-    /** Defines the origin of the copy - the minimum corner of the texture sub-region to copy to/from. */
+    /** Defines the origin of the copy - the minimum corner of the texture sub-region to copy from. */
     origin = [0, 0],
 
+    /** Defines the origin of the copy - the minimum corner of the texture sub-region to copy to. */
+    destinationOrigin = [0, 0],
+
     /** Texture to copy to/from. */
     destination
     /**  Mip-map level of the texture to copy to/from. (Default 0) */
@@ -237,93 +245,72 @@ function _copyTextureToTexture(device: WebGLDevice, options: CopyTextureToTextur
 
   let {
     width = options.destination.width,
-    height = options.destination.width
+    height = options.destination.height
     // depthOrArrayLayers = 0
   } = options;
 
-  const destinationMipmaplevel = 0;
-  const destinationInternalFormat = GL.RGBA;
-
   const {framebuffer, destroyFramebuffer} = getFramebuffer(source);
   const [sourceX, sourceY] = origin;
+  const [destinationX, destinationY, destinationZ] = destinationOrigin;
 
-  const isSubCopy = false;
-  // typeof destinationX !== 'undefined' ||
-  // typeof destinationY !== 'undefined' ||
-  // typeof destinationZ !== 'undefined';
-
-  // destinationX = destinationX || 0;
-  // destinationY = destinationY || 0;
-  // destinationZ = destinationZ || 0;
-  device.gl.bindFramebuffer(GL.FRAMEBUFFER, framebuffer.handle);
+  // @ts-expect-error native bindFramebuffer is overridden by our state tracker
+  const prevHandle: WebGLFramebuffer | null = device.gl.bindFramebuffer(
+    GL.FRAMEBUFFER,
+    framebuffer.handle
+  );
   // TODO - support gl.readBuffer (WebGL2 only)
   // const prevBuffer = gl.readBuffer(attachment);
 
-  let texture = null;
+  let texture: WEBGLTexture = null;
   let textureTarget: GL;
   if (destination instanceof WEBGLTexture) {
     texture = destination;
     width = Number.isFinite(width) ? width : texture.width;
     height = Number.isFinite(height) ? height : texture.height;
     texture.bind(0);
-    textureTarget = texture.destination;
+    textureTarget = texture.target;
   } else {
-    throw new Error('whoops');
-    //  textureTarget = destination;
+    throw new Error('invalid destination');
   }
 
-  if (!isSubCopy) {
-    device.gl.copyTexImage2D(
-      textureTarget,
-      destinationMipmaplevel,
-      destinationInternalFormat,
-      sourceX,
-      sourceY,
-      width,
-      height,
-      0 /* border must be 0 */
-    );
-  } else {
-    // switch (textureTarget) {
-    //   case GL.TEXTURE_2D:
-    //   case GL.TEXTURE_CUBE_MAP:
-    //     device.gl.copyTexSubImage2D(
-    //       textureTarget,
-    //       destinationMipmaplevel,
-    //       destinationX,
-    //       destinationY,
-    //       sourceX,
-    //       sourceY,
-    //       width,
-    //       height
-    //     );
-    //     break;
-    //   case GL.TEXTURE_2D_ARRAY:
-    //   case GL.TEXTURE_3D:
-    //     device.gl.copyTexSubImage3D(
-    //       textureTarget,
-    //       destinationMipmaplevel,
-    //       destinationX,
-    //       destinationY,
-    //       destinationZ,
-    //       sourceX,
-    //       sourceY,
-    //       width,
-    //       height
-    //     );
-    //     break;
-    //   default:
-    // }
+  switch (textureTarget) {
+    case GL.TEXTURE_2D:
+    case GL.TEXTURE_CUBE_MAP:
+      device.gl.copyTexSubImage2D(
+        textureTarget,
+        destinationMipLevel,
+        destinationX,
+        destinationY,
+        sourceX,
+        sourceY,
+        width,
+        height
+      );
+      break;
+    case GL.TEXTURE_2D_ARRAY:
+    case GL.TEXTURE_3D:
+      device.gl.copyTexSubImage3D(
+        textureTarget,
+        destinationMipLevel,
+        destinationX,
+        destinationY,
+        destinationZ,
+        sourceX,
+        sourceY,
+        width,
+        height
+      );
+      break;
+    default:
   }
+
   if (texture) {
     texture.unbind();
   }
-  // ts-expect-error
-  // device.gl.bindFramebuffer(GL.FRAMEBUFFER, prevHandle || null);
+  device.gl.bindFramebuffer(GL.FRAMEBUFFER, prevHandle);
   if (destroyFramebuffer) {
     framebuffer.destroy();
   }
-  return texture;
 }
 
 // Returns number of components in a specific readPixels WebGL format

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

@@ -44,7 +44,11 @@ export class WEBGLFramebuffer extends Framebuffer {
       this.autoCreateAttachmentTextures();
 
       /** Attach from a map of attachments */
-      this.gl.bindFramebuffer(GL.FRAMEBUFFER, this.handle);
+      // @ts-expect-error native bindFramebuffer is overridden by our state tracker
+      const prevHandle: WebGLFramebuffer | null = this.gl.bindFramebuffer(
+        GL.FRAMEBUFFER,
+        this.handle
+      );
 
       // Walk the attachments
       for (let i = 0; i < this.colorAttachments.length; ++i) {
@@ -71,7 +75,7 @@ export class WEBGLFramebuffer extends Framebuffer {
         }
       }
 
-      this.gl.bindFramebuffer(GL.FRAMEBUFFER, null);
+      this.gl.bindFramebuffer(GL.FRAMEBUFFER, prevHandle);
     }
   }
 

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

@@ -82,8 +82,8 @@ export class WEBGLRenderPass extends RenderPass {
         glParameters.viewport = parameters.viewport;
       }
     }
-    glParameters.scissorTest = Boolean(parameters.scissorRect);
     if (parameters.scissorRect) {
+      glParameters.scissorTest = true;
       glParameters.scissor = parameters.scissorRect;
     }
     if (parameters.blendConstant) {

package/src/adapter/webgl-device.ts

@@ -71,7 +71,11 @@ import {WEBGLTransformFeedback} from './resources/webgl-transform-feedback';
 import {WEBGLQuerySet} from './resources/webgl-query-set';
 
 import {readPixelsToArray, readPixelsToBuffer} from '../classic/copy-and-blit';
-import {setGLParameters, getGLParameters} from '../context/parameters/unified-parameter-api';
+import {
+  setGLParameters,
+  getGLParameters,
+  resetGLParameters
+} from '../context/parameters/unified-parameter-api';
 import {withGLParameters} from '../context/state-tracker/with-parameters';
 import {clear} from '../classic/clear';
 import {getWebGLExtension} from '../context/helpers/webgl-extensions';
@@ -408,7 +412,7 @@ ${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContex
   }
 
   override withParametersWebGL(parameters: any, func: any): any {
-    withGLParameters(this.gl, parameters, func);
+    return withGLParameters(this.gl, parameters, func);
   }
 
   override clearWebGL(options?: {
@@ -420,6 +424,11 @@ ${device.info.vendor}, ${device.info.renderer} for canvas: ${device.canvasContex
     clear(this, options);
   }
 
+  override resetWebGL(): void {
+    log.warn('WebGLDevice.resetWebGL is deprecated, use only for debugging')();
+    resetGLParameters(this.gl);
+  }
+
   //
   // WebGL-only API (not part of `Device` API)
   //