@luma.gl/webgl 9.0.0-beta.5 → 9.0.0-beta.6

package/src/context/{context → helpers}/create-browser-context.ts

@@ -1,4 +1,5 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 /**
@@ -64,7 +65,7 @@ export function createBrowserContext(
   // Software GPU
 
   // props.failIfMajorPerformanceCaveat = false;
-  
+
   // if (!gl && props.webgl1) {
   //   gl = canvas.getContext('webgl', props);
   // }

package/src/context/helpers/webgl-context-data.ts

@@ -0,0 +1,31 @@
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+/**
+ * Stores luma.gl specific state associated with a context
+ */
+export interface WebGLContextData {
+  _polyfilled: boolean;
+  _extensions: Record<string, any>;
+}
+
+/**
+ * Gets luma.gl specific state from a context
+ * @returns context state
+ */
+export function getWebGLContextData(gl: WebGL2RenderingContext): WebGLContextData {
+  // @ts-expect-error
+  const luma = gl.luma as WebGLContextData | null;
+  if (!luma) {
+    const contextState: WebGLContextData = {
+      _polyfilled: false,
+      _extensions: {}
+    };
+    // @ts-expect-error
+    gl.luma = contextState;
+  }
+
+  // @ts-expect-error
+  return gl.luma;
+}

package/src/context/helpers/webgl-extensions.ts

@@ -0,0 +1,17 @@
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {GLExtensions} from '@luma.gl/constants';
+
+/** Ensure extensions are only requested once */
+export function getWebGLExtension(
+  gl: WebGL2RenderingContext,
+  name: string,
+  extensions: GLExtensions
+): unknown {
+  if (extensions[name] === undefined) {
+    extensions[name] = gl.getExtension(name) || null;
+  }
+  return extensions[name];
+}

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

@@ -1,4 +1,5 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // Provides a unified API for getting and setting any WebGL parameter

package/src/context/parameters/webgl-parameter-tables.ts

@@ -1,4 +1,5 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // Tables describing WebGL parameters
@@ -64,15 +65,7 @@ export const GL_PARAMETER_DEFAULTS: GLParameters = {
   [GL.STENCIL_BACK_PASS_DEPTH_PASS]: GL.KEEP,
   // Dynamic value: We use [0, 0, 1024, 1024] as default, but usually this is updated in each frame.
   [GL.VIEWPORT]: [0, 0, 1024, 1024],
-  // WEBGL1 PIXEL PACK/UNPACK MODES
-  [GL.PACK_ALIGNMENT]: 4,
-  [GL.UNPACK_ALIGNMENT]: 4,
-  [GL.UNPACK_FLIP_Y_WEBGL]: false,
-  [GL.UNPACK_PREMULTIPLY_ALPHA_WEBGL]: false,
-  [GL.UNPACK_COLORSPACE_CONVERSION_WEBGL]: GL.BROWSER_DEFAULT_WEBGL,
 
-  // WEBGL2 / EXTENSIONS
-  // gl1: 'OES_standard_derivatives'
   [GL.TRANSFORM_FEEDBACK_BINDING]: null,
   [GL.COPY_READ_BUFFER_BINDING]: null,
   [GL.COPY_WRITE_BUFFER_BINDING]: null,
@@ -81,6 +74,12 @@ export const GL_PARAMETER_DEFAULTS: GLParameters = {
   [GL.FRAGMENT_SHADER_DERIVATIVE_HINT]: GL.DONT_CARE,
   [GL.READ_FRAMEBUFFER_BINDING]: null,
   [GL.RASTERIZER_DISCARD]: false,
+
+  [GL.PACK_ALIGNMENT]: 4,
+  [GL.UNPACK_ALIGNMENT]: 4,
+  [GL.UNPACK_FLIP_Y_WEBGL]: false,
+  [GL.UNPACK_PREMULTIPLY_ALPHA_WEBGL]: false,
+  [GL.UNPACK_COLORSPACE_CONVERSION_WEBGL]: GL.BROWSER_DEFAULT_WEBGL,
   [GL.PACK_ROW_LENGTH]: 0,
   [GL.PACK_SKIP_PIXELS]: 0,
   [GL.PACK_SKIP_ROWS]: 0,
@@ -100,7 +99,7 @@ const pixelStorei = (gl: WebGL2RenderingContext, value: number | boolean, key: G
   gl.pixelStorei(key, value);
 
 const bindFramebuffer = (gl: WebGL2RenderingContext, value: unknown, key: GL) => {
-  const target = (key === GL.FRAMEBUFFER_BINDING) ? GL.DRAW_FRAMEBUFFER : GL.READ_FRAMEBUFFER;
+  const target = key === GL.FRAMEBUFFER_BINDING ? GL.DRAW_FRAMEBUFFER : GL.READ_FRAMEBUFFER;
   return gl.bindFramebuffer(target, value);
 };
 
@@ -137,13 +136,15 @@ export const GL_PARAMETER_SETTERS = {
   [GL.BLEND_DST_ALPHA]: 'blendFunc',
   [GL.COLOR_CLEAR_VALUE]: (gl: WebGL2RenderingContext, value: [number, number, number, number]) =>
     gl.clearColor(...value),
-  [GL.COLOR_WRITEMASK]: (gl: WebGL2RenderingContext, value: [boolean, boolean, boolean, boolean]) => gl.colorMask(...value),
+  [GL.COLOR_WRITEMASK]: (gl: WebGL2RenderingContext, value: [boolean, boolean, boolean, boolean]) =>
+    gl.colorMask(...value),
   [GL.CULL_FACE]: enable,
   [GL.CULL_FACE_MODE]: (gl: WebGL2RenderingContext, value) => gl.cullFace(value),
   [GL.DEPTH_TEST]: enable,
   [GL.DEPTH_CLEAR_VALUE]: (gl: WebGL2RenderingContext, value) => gl.clearDepth(value),
   [GL.DEPTH_FUNC]: (gl: WebGL2RenderingContext, value) => gl.depthFunc(value),
-  [GL.DEPTH_RANGE]: (gl: WebGL2RenderingContext, value: [number, number]) => gl.depthRange(...value),
+  [GL.DEPTH_RANGE]: (gl: WebGL2RenderingContext, value: [number, number]) =>
+    gl.depthRange(...value),
   [GL.DEPTH_WRITEMASK]: (gl: WebGL2RenderingContext, value) => gl.depthMask(value),
   [GL.DITHER]: enable,
   [GL.FRAGMENT_SHADER_DERIVATIVE_HINT]: hint,
@@ -152,9 +153,8 @@ export const GL_PARAMETER_SETTERS = {
   [GL.RENDERBUFFER_BINDING]: (gl: WebGL2RenderingContext, value) =>
     gl.bindRenderbuffer(GL.RENDERBUFFER, value),
   [GL.TRANSFORM_FEEDBACK_BINDING]: (gl: WebGL2RenderingContext, value) =>
-    (gl ).bindTransformFeedback?.(GL.TRANSFORM_FEEDBACK, value),
-  [GL.VERTEX_ARRAY_BINDING]: (gl: WebGL2RenderingContext, value) =>
-    (gl ).bindVertexArray(value),
+    gl.bindTransformFeedback?.(GL.TRANSFORM_FEEDBACK, value),
+  [GL.VERTEX_ARRAY_BINDING]: (gl: WebGL2RenderingContext, value) => gl.bindVertexArray(value),
   // NOTE: FRAMEBUFFER_BINDING and DRAW_FRAMEBUFFER_BINDING(WebGL2) refer same state.
   [GL.FRAMEBUFFER_BINDING]: bindFramebuffer,
   [GL.READ_FRAMEBUFFER_BINDING]: bindFramebuffer,
@@ -178,7 +178,8 @@ export const GL_PARAMETER_SETTERS = {
   [GL.SAMPLE_COVERAGE_VALUE]: 'sampleCoverage',
   [GL.SAMPLE_COVERAGE_INVERT]: 'sampleCoverage',
   [GL.SCISSOR_TEST]: enable,
-  [GL.SCISSOR_BOX]: (gl: WebGL2RenderingContext, value: [number, number, number, number]) => gl.scissor(...value),
+  [GL.SCISSOR_BOX]: (gl: WebGL2RenderingContext, value: [number, number, number, number]) =>
+    gl.scissor(...value),
   [GL.STENCIL_TEST]: enable,
   [GL.STENCIL_CLEAR_VALUE]: (gl: WebGL2RenderingContext, value) => gl.clearStencil(value),
   [GL.STENCIL_WRITEMASK]: (gl: WebGL2RenderingContext, value) =>
@@ -197,17 +198,41 @@ export const GL_PARAMETER_SETTERS = {
   [GL.STENCIL_BACK_FAIL]: 'stencilOpBack',
   [GL.STENCIL_BACK_PASS_DEPTH_FAIL]: 'stencilOpBack',
   [GL.STENCIL_BACK_PASS_DEPTH_PASS]: 'stencilOpBack',
-  [GL.VIEWPORT]: (gl: WebGL2RenderingContext, value: [number, number, number, number]) => gl.viewport(...value),
+  [GL.VIEWPORT]: (gl: WebGL2RenderingContext, value: [number, number, number, number]) =>
+    gl.viewport(...value),
+
+  // WEBGL2 EXTENSIONS
 
-  // WEBGL1 PIXEL PACK/UNPACK MODES
+  // EXT_depth_clamp https://registry.khronos.org/webgl/extensions/EXT_depth_clamp/
+
+  [GL.DEPTH_CLAMP_EXT]: enable,
+
+  // WEBGL_provoking_vertex https://registry.khronos.org/webgl/extensions/WEBGL_provoking_vertex/
+
+  // [GL.PROVOKING_VERTEX_WEBL]: TODO - extension function needed
+
+  // WEBGL_polygon_mode https://registry.khronos.org/webgl/extensions/WEBGL_polygon_mode/
+
+  // POLYGON_MODE_WEBGL  TODO - extension function needed
+  [GL.POLYGON_OFFSET_LINE_WEBGL]: enable,
+
+  // WEBGL_clip_cull_distance https://registry.khronos.org/webgl/extensions/WEBGL_clip_cull_distance/
+
+  [GL.CLIP_DISTANCE0_WEBGL]: enable,
+  [GL.CLIP_DISTANCE1_WEBGL]: enable,
+  [GL.CLIP_DISTANCE2_WEBGL]: enable,
+  [GL.CLIP_DISTANCE3_WEBGL]: enable,
+  [GL.CLIP_DISTANCE4_WEBGL]: enable,
+  [GL.CLIP_DISTANCE5_WEBGL]: enable,
+  [GL.CLIP_DISTANCE6_WEBGL]: enable,
+  [GL.CLIP_DISTANCE7_WEBGL]: enable,
+
+  // PIXEL PACK/UNPACK MODES
   [GL.PACK_ALIGNMENT]: pixelStorei,
   [GL.UNPACK_ALIGNMENT]: pixelStorei,
   [GL.UNPACK_FLIP_Y_WEBGL]: pixelStorei,
   [GL.UNPACK_PREMULTIPLY_ALPHA_WEBGL]: pixelStorei,
   [GL.UNPACK_COLORSPACE_CONVERSION_WEBGL]: pixelStorei,
-
-  // WEBGL2 PIXEL PACK/UNPACK MODES
-  // RASTERIZER_DISCARD ...
   [GL.PACK_ROW_LENGTH]: pixelStorei,
   [GL.PACK_SKIP_PIXELS]: pixelStorei,
   [GL.PACK_SKIP_ROWS]: pixelStorei,
@@ -224,22 +249,30 @@ export const GL_PARAMETER_SETTERS = {
     const handle = framebuffer && 'handle' in framebuffer ? framebuffer.handle : framebuffer;
     return gl.bindFramebuffer(GL.FRAMEBUFFER, handle);
   },
-  blend: (gl: WebGL2RenderingContext, value) => (value ? gl.enable(GL.BLEND) : gl.disable(GL.BLEND)),
-  blendColor: (gl: WebGL2RenderingContext, value: [number, number, number, number]) => gl.blendColor(...value),
+  blend: (gl: WebGL2RenderingContext, value) =>
+    value ? gl.enable(GL.BLEND) : gl.disable(GL.BLEND),
+  blendColor: (gl: WebGL2RenderingContext, value: [number, number, number, number]) =>
+    gl.blendColor(...value),
   blendEquation: (gl: WebGL2RenderingContext, args: number | [number, number]) => {
-    const separateModes = typeof args === 'number' ? [args, args] as [number, number]: args;
+    const separateModes = typeof args === 'number' ? ([args, args] as [number, number]) : args;
     gl.blendEquationSeparate(...separateModes);
   },
-  blendFunc: (gl: WebGL2RenderingContext, args: [number, number] | [number, number, number, number]) => {
-    const separateFuncs = args?.length === 2 ? [...args, ...args] as [number, number, number, number] : args;
+  blendFunc: (
+    gl: WebGL2RenderingContext,
+    args: [number, number] | [number, number, number, number]
+  ) => {
+    const separateFuncs =
+      args?.length === 2 ? ([...args, ...args] as [number, number, number, number]) : args;
     gl.blendFuncSeparate(...separateFuncs);
   },
 
-  clearColor: (gl: WebGL2RenderingContext, value: [number, number, number, number]) => gl.clearColor(...value),
+  clearColor: (gl: WebGL2RenderingContext, value: [number, number, number, number]) =>
+    gl.clearColor(...value),
   clearDepth: (gl: WebGL2RenderingContext, value) => gl.clearDepth(value),
   clearStencil: (gl: WebGL2RenderingContext, value) => gl.clearStencil(value),
 
-  colorMask: (gl: WebGL2RenderingContext, value: [boolean, boolean, boolean, boolean]) => gl.colorMask(...value),
+  colorMask: (gl: WebGL2RenderingContext, value: [boolean, boolean, boolean, boolean]) =>
+    gl.colorMask(...value),
 
   cull: (gl: WebGL2RenderingContext, value) =>
     value ? gl.enable(GL.CULL_FACE) : gl.disable(GL.CULL_FACE),
@@ -267,13 +300,16 @@ export const GL_PARAMETER_SETTERS = {
 
   polygonOffsetFill: (gl: WebGL2RenderingContext, value) =>
     value ? gl.enable(GL.POLYGON_OFFSET_FILL) : gl.disable(GL.POLYGON_OFFSET_FILL),
-  polygonOffset: (gl: WebGL2RenderingContext, value: [number, number]) => gl.polygonOffset(...value),
+  polygonOffset: (gl: WebGL2RenderingContext, value: [number, number]) =>
+    gl.polygonOffset(...value),
 
-  sampleCoverage: (gl: WebGL2RenderingContext, value: [number, boolean?]) => gl.sampleCoverage(...value),
+  sampleCoverage: (gl: WebGL2RenderingContext, value: [number, boolean?]) =>
+    gl.sampleCoverage(...value),
 
   scissorTest: (gl: WebGL2RenderingContext, value) =>
     value ? gl.enable(GL.SCISSOR_TEST) : gl.disable(GL.SCISSOR_TEST),
-  scissor: (gl: WebGL2RenderingContext, value: [number, number, number, number]) => gl.scissor(...value),
+  scissor: (gl: WebGL2RenderingContext, value: [number, number, number, number]) =>
+    gl.scissor(...value),
 
   stencilTest: (gl: WebGL2RenderingContext, value) =>
     value ? gl.enable(GL.STENCIL_TEST) : gl.disable(GL.STENCIL_TEST),
@@ -296,7 +332,8 @@ export const GL_PARAMETER_SETTERS = {
     gl.stencilOpSeparate(GL.BACK, backSfail, backDpfail, backDppass);
   },
 
-  viewport: (gl: WebGL2RenderingContext, value: [number, number, number, number]) => gl.viewport(...value)
+  viewport: (gl: WebGL2RenderingContext, value: [number, number, number, number]) =>
+    gl.viewport(...value)
 };
 
 function getValue(glEnum, values, cache) {

package/src/context/state-tracker/deep-array-equal.ts

@@ -1,4 +1,5 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 /** deeply compare two arrays */

package/src/context/state-tracker/track-context-state.ts

@@ -1,10 +1,15 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // Support for listening to context state changes and intercepting state queries
 // NOTE: this system does not handle buffer bindings
 import {assert} from '@luma.gl/core';
-import {GL_PARAMETER_DEFAULTS, GL_HOOKED_SETTERS, NON_CACHE_PARAMETERS} from '../parameters/webgl-parameter-tables';
+import {
+  GL_PARAMETER_DEFAULTS,
+  GL_HOOKED_SETTERS,
+  NON_CACHE_PARAMETERS
+} from '../parameters/webgl-parameter-tables';
 import {setGLParameters, getGLParameters} from '../parameters/unified-parameter-api';
 import {deepArrayEqual} from './deep-array-equal';
 
@@ -57,7 +62,8 @@ class GLState {
     let valueChanged = false;
     let oldValue; // = undefined
 
-    const oldValues: {[key: number | string]: any} | null = this.stateStack.length > 0 ? this.stateStack[this.stateStack.length - 1] : null;
+    const oldValues: {[key: number | string]: any} | null =
+      this.stateStack.length > 0 ? this.stateStack[this.stateStack.length - 1] : null;
 
     for (const key in values) {
       assert(key !== undefined);
@@ -152,7 +158,6 @@ export function pushContextState(gl: WebGL2RenderingContext): void {
   glState.push();
 }
 
-
 /**
  * Restores previously saved WebGL context state
  */
@@ -190,9 +195,9 @@ function installGetterOverride(gl: WebGL2RenderingContext, functionName: string)
     // Optionally call the original function to do a "hard" query from the WebGL2RenderingContext
     return glState.enable
       ? // Call the getter the params so that it can e.g. serve from a cache
-      glState.cache[pname]
+        glState.cache[pname]
       : // Optionally call the original function to do a "hard" query from the WebGL2RenderingContext
-      originalGetterFunc(pname);
+        originalGetterFunc(pname);
   };
 
   // Set the name of this anonymous function to help in debugging and profiling

package/src/context/state-tracker/with-parameters.ts

@@ -1,4 +1,5 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import type {Device} from '@luma.gl/core';
@@ -14,7 +15,11 @@ import {pushContextState, popContextState} from './track-context-state';
  * - Restores parameters
  * - Returns the return value of the supplied function
  */
-export function withGLParameters(device: Device | WebGL2RenderingContext, parameters: GLParameters & {nocatch?: boolean}, func: any): any {
+export function withGLParameters(
+  device: Device | WebGL2RenderingContext,
+  parameters: GLParameters & {nocatch?: boolean},
+  func: any
+): any {
   const webglDevice = WebGLDevice.attach(device);
   const gl = webglDevice.gl;
 

package/src/index.ts

@@ -1,4 +1,5 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // luma.gl Base WebGL wrapper library
@@ -8,7 +9,7 @@
 // Higher level abstractions can be built on these classes
 
 // Types
-export type {WebGLLimits} from './adapter/device-helpers/webgl-device-limits';
+export type {WebGLDeviceLimits} from './adapter/device-helpers/webgl-device-limits';
 
 // WebGL adapter classes
 export {WebGLDevice} from './adapter/webgl-device';

package/src/types.ts

@@ -1,4 +1,5 @@
-// luma.gl, MIT license
+// luma.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 export type AccessorObject = {

package/src/context/context/context-data.ts

@@ -1,44 +0,0 @@
-// luma.gl, MIT license
-// Copyright (c) vis.gl contributors
-
-/**
- * Stores luma.gl specific state associated with a context
- */
-export interface WebGLContextData {
-  _polyfilled: boolean;
-  _extensions: Record<string, any>;
-}
-
-/**
- * Gets luma.gl specific state from a context
- * @returns context state
- */
-export function getContextData(gl: WebGL2RenderingContext): WebGLContextData {
-  // @ts-expect-error
-  const luma = gl.luma as WebGLContextData | null;
-  if (!luma) {
-    const contextState: WebGLContextData = {
-      _polyfilled: false,
-      _extensions: {}
-    };
-    // @ts-expect-error
-    gl.luma = contextState;
-  }
-
-  // @ts-expect-error
-  return gl.luma;
-}
-
-export function initializeExtensions(gl: WebGL2RenderingContext): void {
-  const contextState = getContextData(gl);
-  // `getSupportedExtensions` can return null when context is lost.
-  const EXTENSIONS = gl.getSupportedExtensions() || [];
-  // Generates warnings in Chrome
-  const IGNORE_EXTENSIONS = ['WEBGL_polygon_mode'];
-  for (const extensionName of EXTENSIONS) {
-    if (!IGNORE_EXTENSIONS.includes(extensionName)) {
-      const extension = gl.getExtension(extensionName);
-      contextState._extensions[extensionName] = extension;
-    }
-  }
-}