@luma.gl/webgl 9.0.0-alpha.15 → 9.0.0-alpha.16

package/dist/context/polyfill/context-data.js

@@ -1,14 +1,18 @@
+/**
+ * Gets luma.gl specific state from a context
+ * @returns context state
+ */
 export function getContextData(gl) {
-  const luma = gl.luma;
-
-  if (!luma) {
-    const contextState = {
-      _polyfilled: false,
-      _extensions: {}
-    };
-    gl.luma = contextState;
-  }
-
-  return gl.luma;
+    // @ts-expect-error
+    const luma = gl.luma;
+    if (!luma) {
+        const contextState = {
+            _polyfilled: false,
+            _extensions: {}
+        };
+        // @ts-expect-error
+        gl.luma = contextState;
+    }
+    // @ts-expect-error
+    return gl.luma;
 }
-//# sourceMappingURL=context-data.js.map

package/dist/context/polyfill/get-parameter-polyfill.js

@@ -1,5 +1,6 @@
+/* eslint-disable no-inline-comments, max-len, camelcase */
 import GL from '@luma.gl/constants';
-import { isWebGL2 } from '../context/webgl-checks';
+import { isWebGL2 } from '../context/webgl-checks.js';
 const OES_element_index = 'OES_element_index';
 const WEBGL_draw_buffers = 'WEBGL_draw_buffers';
 const EXT_disjoint_timer_query = 'EXT_disjoint_timer_query';
@@ -10,82 +11,96 @@ const GL_FRAGMENT_SHADER_DERIVATIVE_HINT = 0x8b8b;
 const GL_DONT_CARE = 0x1100;
 const GL_GPU_DISJOINT_EXT = 0x8fbb;
 const GL_MAX_TEXTURE_MAX_ANISOTROPY_EXT = 0x84ff;
-const GL_UNMASKED_VENDOR_WEBGL = 0x9245;
-const GL_UNMASKED_RENDERER_WEBGL = 0x9246;
-
-const getWebGL2ValueOrZero = gl => !isWebGL2(gl) ? 0 : undefined;
-
+const GL_UNMASKED_VENDOR_WEBGL = 0x9245; // vendor string of the graphics driver.
+const GL_UNMASKED_RENDERER_WEBGL = 0x9246; // renderer string of the graphics driver.
+const getWebGL2ValueOrZero = (gl) => (!isWebGL2(gl) ? 0 : undefined);
+// if a function returns undefined in this table,
+// the original getParameter will be called, defeating the override
 const WEBGL_PARAMETERS = {
-  [GL.READ_BUFFER]: gl => !isWebGL2(gl) ? GL.COLOR_ATTACHMENT0 : undefined,
-  [GL_FRAGMENT_SHADER_DERIVATIVE_HINT]: gl => !isWebGL2(gl) ? GL_DONT_CARE : undefined,
-  [GL.RASTERIZER_DISCARD]: getWebGL2ValueOrZero,
-  [GL.SAMPLES]: getWebGL2ValueOrZero,
-  [GL_GPU_DISJOINT_EXT]: (gl, getParameter) => {
-    const ext = isWebGL2(gl) ? gl.getExtension(EXT_disjoint_timer_query_webgl2) : gl.getExtension(EXT_disjoint_timer_query);
-    return ext && ext.GPU_DISJOINT_EXT ? getParameter(ext.GPU_DISJOINT_EXT) : 0;
-  },
-  [GL_UNMASKED_VENDOR_WEBGL]: (gl, getParameter) => {
-    const ext = gl.getExtension(WEBGL_debug_renderer_info);
-    return getParameter(ext && ext.UNMASKED_VENDOR_WEBGL || GL.VENDOR);
-  },
-  [GL_UNMASKED_RENDERER_WEBGL]: (gl, getParameter) => {
-    const ext = gl.getExtension(WEBGL_debug_renderer_info);
-    return getParameter(ext && ext.UNMASKED_RENDERER_WEBGL || GL.RENDERER);
-  },
-  [GL_MAX_TEXTURE_MAX_ANISOTROPY_EXT]: (gl, getParameter) => {
-    var _gl$luma, _gl$luma$extensions;
-
-    const ext = ((_gl$luma = gl.luma) === null || _gl$luma === void 0 ? void 0 : (_gl$luma$extensions = _gl$luma.extensions) === null || _gl$luma$extensions === void 0 ? void 0 : _gl$luma$extensions[EXT_texture_filter_anisotropic]) || gl.getExtension('EXT_texture_filter_anisotropic');
-    return ext ? getParameter(ext.MAX_TEXTURE_MAX_ANISOTROPY_EXT) : 1.0;
-  },
-  [GL.MAX_3D_TEXTURE_SIZE]: getWebGL2ValueOrZero,
-  [GL.MAX_ARRAY_TEXTURE_LAYERS]: getWebGL2ValueOrZero,
-  [GL.MAX_CLIENT_WAIT_TIMEOUT_WEBGL]: getWebGL2ValueOrZero,
-  [GL.MAX_COLOR_ATTACHMENTS]: (gl, getParameter) => {
-    if (!isWebGL2(gl)) {
-      const ext = gl.getExtension(WEBGL_draw_buffers);
-      return ext ? getParameter(ext.MAX_COLOR_ATTACHMENTS_WEBGL) : 0;
-    }
-
-    return undefined;
-  },
-  [GL.MAX_COMBINED_FRAGMENT_UNIFORM_COMPONENTS]: getWebGL2ValueOrZero,
-  [GL.MAX_COMBINED_UNIFORM_BLOCKS]: getWebGL2ValueOrZero,
-  [GL.MAX_COMBINED_VERTEX_UNIFORM_COMPONENTS]: getWebGL2ValueOrZero,
-  [GL.MAX_DRAW_BUFFERS]: gl => {
-    if (!isWebGL2(gl)) {
-      const ext = gl.getExtension(WEBGL_draw_buffers);
-      return ext ? ext.MAX_DRAW_BUFFERS_WEBGL : 0;
-    }
-
-    return undefined;
-  },
-  [GL.MAX_ELEMENT_INDEX]: gl => gl.getExtension(OES_element_index) ? 2147483647 : 65535,
-  [GL.MAX_ELEMENTS_INDICES]: gl => gl.getExtension(OES_element_index) ? 16777216 : 65535,
-  [GL.MAX_ELEMENTS_VERTICES]: gl => 16777216,
-  [GL.MAX_FRAGMENT_INPUT_COMPONENTS]: getWebGL2ValueOrZero,
-  [GL.MAX_FRAGMENT_UNIFORM_BLOCKS]: getWebGL2ValueOrZero,
-  [GL.MAX_FRAGMENT_UNIFORM_COMPONENTS]: getWebGL2ValueOrZero,
-  [GL.MAX_SAMPLES]: getWebGL2ValueOrZero,
-  [GL.MAX_SERVER_WAIT_TIMEOUT]: getWebGL2ValueOrZero,
-  [GL.MAX_TEXTURE_LOD_BIAS]: getWebGL2ValueOrZero,
-  [GL.MAX_TRANSFORM_FEEDBACK_INTERLEAVED_COMPONENTS]: getWebGL2ValueOrZero,
-  [GL.MAX_TRANSFORM_FEEDBACK_SEPARATE_ATTRIBS]: getWebGL2ValueOrZero,
-  [GL.MAX_TRANSFORM_FEEDBACK_SEPARATE_COMPONENTS]: getWebGL2ValueOrZero,
-  [GL.MAX_UNIFORM_BLOCK_SIZE]: getWebGL2ValueOrZero,
-  [GL.MAX_UNIFORM_BUFFER_BINDINGS]: getWebGL2ValueOrZero,
-  [GL.MAX_VARYING_COMPONENTS]: getWebGL2ValueOrZero,
-  [GL.MAX_VERTEX_OUTPUT_COMPONENTS]: getWebGL2ValueOrZero,
-  [GL.MAX_VERTEX_UNIFORM_BLOCKS]: getWebGL2ValueOrZero,
-  [GL.MAX_VERTEX_UNIFORM_COMPONENTS]: getWebGL2ValueOrZero,
-  [GL.MIN_PROGRAM_TEXEL_OFFSET]: getWebGL2ValueOrZero,
-  [GL.MAX_PROGRAM_TEXEL_OFFSET]: getWebGL2ValueOrZero,
-  [GL.UNIFORM_BUFFER_OFFSET_ALIGNMENT]: getWebGL2ValueOrZero
+    [GL.READ_BUFFER]: (gl) => (!isWebGL2(gl) ? GL.COLOR_ATTACHMENT0 : undefined),
+    // WebGL2 context parameters
+    [GL_FRAGMENT_SHADER_DERIVATIVE_HINT]: (gl) => (!isWebGL2(gl) ? GL_DONT_CARE : undefined),
+    [GL.RASTERIZER_DISCARD]: getWebGL2ValueOrZero,
+    [GL.SAMPLES]: getWebGL2ValueOrZero,
+    // WebGL2 extension context parameters
+    [GL_GPU_DISJOINT_EXT]: (gl, getParameter) => {
+        const ext = isWebGL2(gl)
+            ? gl.getExtension(EXT_disjoint_timer_query_webgl2)
+            : gl.getExtension(EXT_disjoint_timer_query);
+        return ext && ext.GPU_DISJOINT_EXT ? getParameter(ext.GPU_DISJOINT_EXT) : 0;
+    },
+    // Extension fixed values
+    [GL_UNMASKED_VENDOR_WEBGL]: (gl, getParameter) => {
+        const ext = gl.getExtension(WEBGL_debug_renderer_info);
+        return getParameter((ext && ext.UNMASKED_VENDOR_WEBGL) || GL.VENDOR);
+    },
+    [GL_UNMASKED_RENDERER_WEBGL]: (gl, getParameter) => {
+        const ext = gl.getExtension(WEBGL_debug_renderer_info);
+        return getParameter((ext && ext.UNMASKED_RENDERER_WEBGL) || GL.RENDERER);
+    },
+    // Extension LIMITS
+    [GL_MAX_TEXTURE_MAX_ANISOTROPY_EXT]: (gl, getParameter) => {
+        // @ts-ignore TODO - store these on the device instance instead...
+        const ext = gl.luma?.extensions?.[EXT_texture_filter_anisotropic] ||
+            gl.getExtension('EXT_texture_filter_anisotropic');
+        return ext ? getParameter(ext.MAX_TEXTURE_MAX_ANISOTROPY_EXT) : 1.0;
+    },
+    // WebGL2 Limits
+    [GL.MAX_3D_TEXTURE_SIZE]: getWebGL2ValueOrZero,
+    [GL.MAX_ARRAY_TEXTURE_LAYERS]: getWebGL2ValueOrZero,
+    [GL.MAX_CLIENT_WAIT_TIMEOUT_WEBGL]: getWebGL2ValueOrZero,
+    [GL.MAX_COLOR_ATTACHMENTS]: (gl, getParameter) => {
+        if (!isWebGL2(gl)) {
+            const ext = gl.getExtension(WEBGL_draw_buffers);
+            return ext ? getParameter(ext.MAX_COLOR_ATTACHMENTS_WEBGL) : 0;
+        }
+        return undefined;
+    },
+    [GL.MAX_COMBINED_FRAGMENT_UNIFORM_COMPONENTS]: getWebGL2ValueOrZero,
+    [GL.MAX_COMBINED_UNIFORM_BLOCKS]: getWebGL2ValueOrZero,
+    [GL.MAX_COMBINED_VERTEX_UNIFORM_COMPONENTS]: getWebGL2ValueOrZero,
+    [GL.MAX_DRAW_BUFFERS]: (gl) => {
+        if (!isWebGL2(gl)) {
+            const ext = gl.getExtension(WEBGL_draw_buffers);
+            return ext ? ext.MAX_DRAW_BUFFERS_WEBGL : 0;
+        }
+        return undefined;
+    },
+    [GL.MAX_ELEMENT_INDEX]: 
+    // Guess: per webglstats.com 99.6% of webgl2 supports 2147483647
+    (gl) => (gl.getExtension(OES_element_index) ? 2147483647 : 65535),
+    [GL.MAX_ELEMENTS_INDICES]: 
+    // Guess: "Reasonably safe" per webglstats.com - could be higher/lower (on some mobile devices)
+    (gl) => (gl.getExtension(OES_element_index) ? 16777216 : 65535),
+    [GL.MAX_ELEMENTS_VERTICES]: 
+    // Guess: "Reasonably safe" per webglstats.com - could be higher/lower (on some mobile devices)
+    (gl) => 16777216,
+    [GL.MAX_FRAGMENT_INPUT_COMPONENTS]: getWebGL2ValueOrZero,
+    [GL.MAX_FRAGMENT_UNIFORM_BLOCKS]: getWebGL2ValueOrZero,
+    [GL.MAX_FRAGMENT_UNIFORM_COMPONENTS]: getWebGL2ValueOrZero,
+    [GL.MAX_SAMPLES]: getWebGL2ValueOrZero,
+    [GL.MAX_SERVER_WAIT_TIMEOUT]: getWebGL2ValueOrZero,
+    [GL.MAX_TEXTURE_LOD_BIAS]: getWebGL2ValueOrZero,
+    [GL.MAX_TRANSFORM_FEEDBACK_INTERLEAVED_COMPONENTS]: getWebGL2ValueOrZero,
+    [GL.MAX_TRANSFORM_FEEDBACK_SEPARATE_ATTRIBS]: getWebGL2ValueOrZero,
+    [GL.MAX_TRANSFORM_FEEDBACK_SEPARATE_COMPONENTS]: getWebGL2ValueOrZero,
+    [GL.MAX_UNIFORM_BLOCK_SIZE]: getWebGL2ValueOrZero,
+    [GL.MAX_UNIFORM_BUFFER_BINDINGS]: getWebGL2ValueOrZero,
+    [GL.MAX_VARYING_COMPONENTS]: getWebGL2ValueOrZero,
+    [GL.MAX_VERTEX_OUTPUT_COMPONENTS]: getWebGL2ValueOrZero,
+    [GL.MAX_VERTEX_UNIFORM_BLOCKS]: getWebGL2ValueOrZero,
+    [GL.MAX_VERTEX_UNIFORM_COMPONENTS]: getWebGL2ValueOrZero,
+    [GL.MIN_PROGRAM_TEXEL_OFFSET]: getWebGL2ValueOrZero,
+    [GL.MAX_PROGRAM_TEXEL_OFFSET]: getWebGL2ValueOrZero,
+    [GL.UNIFORM_BUFFER_OFFSET_ALIGNMENT]: getWebGL2ValueOrZero
 };
+// A "replacement" gl.getParameter that accepts "enums" from extensions and WebGL2
+// and returns reasonably safe defaults
 export function getParameterPolyfill(gl, originalGetParameter, pname) {
-  const limit = WEBGL_PARAMETERS[pname];
-  const value = typeof limit === 'function' ? limit(gl, originalGetParameter, pname) : limit;
-  const result = value !== undefined ? value : originalGetParameter(pname);
-  return result;
+    // Return mock limits (usually 0) for WebGL2 constants to ensure these
+    // can be queries without error
+    const limit = WEBGL_PARAMETERS[pname];
+    const value = typeof limit === 'function' ? limit(gl, originalGetParameter, pname) : limit;
+    const result = value !== undefined ? value : originalGetParameter(pname);
+    return result;
 }
-//# sourceMappingURL=get-parameter-polyfill.js.map

package/dist/context/polyfill/polyfill-context.js

@@ -1,91 +1,86 @@
+// WebGL1/WebGL2 extension polyfill support
+//
+// Provides a function that creates polyfills for WebGL2 functions based
+// on available extensions and installs them on a supplied target (could be
+// the WebGLContext or its prototype, or a separate object).
+//
+// This is intended to be a stand-alone file with minimal dependencies,
+// easy to reuse or repurpose in other projects.
 import { assert } from '@luma.gl/api';
-import { polyfillVertexArrayObject } from './polyfill-vertex-array-object';
-import { WEBGL2_CONTEXT_POLYFILLS, WEBGL2_CONTEXT_OVERRIDES } from './polyfill-table';
-import { getContextData } from './context-data';
+import { polyfillVertexArrayObject } from './polyfill-vertex-array-object.js';
+import { WEBGL2_CONTEXT_POLYFILLS, WEBGL2_CONTEXT_OVERRIDES } from './polyfill-table.js';
+import { getContextData } from './context-data.js';
+/**
+ * Registers extensions, polyfills or mock functions for extensions in the polyfills list
+ */
 export function polyfillContext(gl) {
-  const contextState = getContextData(gl);
-
-  if (!contextState._polyfilled) {
-    polyfillVertexArrayObject(gl);
-    initializeExtensions(gl);
-    installPolyfills(gl, WEBGL2_CONTEXT_POLYFILLS);
-    installOverrides(gl, {
-      target: contextState,
-      target2: gl
-    });
-    contextState._polyfilled = true;
-  }
-
-  return gl;
+    const contextState = getContextData(gl);
+    if (!contextState._polyfilled) {
+        polyfillVertexArrayObject(gl);
+        initializeExtensions(gl);
+        installPolyfills(gl, WEBGL2_CONTEXT_POLYFILLS);
+        installOverrides(gl, { target: contextState, target2: gl });
+        contextState._polyfilled = true;
+    }
+    // Note - only supports a subset of WebGL2
+    return gl;
 }
-
 function initializeExtensions(gl) {
-  const contextState = getContextData(gl);
-  const EXTENSIONS = gl.getSupportedExtensions() || [];
-
-  for (const extensionName of EXTENSIONS) {
-    const extension = gl.getExtension(extensionName);
-    contextState._extensions[extensionName] = extension;
-  }
+    const contextState = getContextData(gl);
+    // `getSupportedExtensions` can return null when context is lost.
+    const EXTENSIONS = gl.getSupportedExtensions() || [];
+    for (const extensionName of EXTENSIONS) {
+        const extension = gl.getExtension(extensionName);
+        contextState._extensions[extensionName] = extension;
+    }
 }
-
 function installPolyfills(gl, polyfills) {
-  const contextState = getContextData(gl);
-
-  for (const extension of Object.getOwnPropertyNames(polyfills)) {
-    if (extension !== 'overrides') {
-      polyfillExtension(gl, {
-        extension,
-        target: contextState,
-        target2: gl
-      });
+    const contextState = getContextData(gl);
+    for (const extension of Object.getOwnPropertyNames(polyfills)) {
+        if (extension !== 'overrides') {
+            polyfillExtension(gl, { extension, target: contextState, target2: gl });
+        }
     }
-  }
 }
-
-function polyfillExtension(gl, {
-  extension,
-  target,
-  target2
-}) {
-  const defaults = WEBGL2_CONTEXT_POLYFILLS[extension];
-  assert(defaults);
-  const {
-    meta = {}
-  } = defaults;
-  const {
-    suffix = ''
-  } = meta;
-  const ext = gl.getExtension(extension);
-
-  for (const key of Object.keys(defaults)) {
-    const extKey = "".concat(key).concat(suffix);
-    let polyfill = null;
-
-    if (key === 'meta') {} else if (typeof gl[key] === 'function') {} else if (ext && typeof ext[extKey] === 'function') {
-      polyfill = (...args) => ext[extKey](...args);
-    } else if (typeof defaults[key] === 'function') {
-      polyfill = defaults[key].bind(target);
+/** Polyfills a single WebGL extension into the `target` object */
+function polyfillExtension(gl, { extension, target, target2 }) {
+    const defaults = WEBGL2_CONTEXT_POLYFILLS[extension];
+    assert(defaults);
+    const { meta = {} } = defaults;
+    const { suffix = '' } = meta;
+    const ext = gl.getExtension(extension);
+    for (const key of Object.keys(defaults)) {
+        const extKey = `${key}${suffix}`;
+        let polyfill = null;
+        if (key === 'meta') {
+            // ignore
+        }
+        else if (typeof gl[key] === 'function') {
+            // WebGL2 implementation is already
+        }
+        else if (ext && typeof ext[extKey] === 'function') {
+            // pick extension implementation,if available
+            polyfill = (...args) => ext[extKey](...args);
+        }
+        else if (typeof defaults[key] === 'function') {
+            // pick the mock implementation, if no implementation was detected
+            polyfill = defaults[key].bind(target);
+        }
+        if (polyfill) {
+            target[key] = polyfill;
+            target2[key] = polyfill;
+        }
     }
-
-    if (polyfill) {
-      target[key] = polyfill;
-      target2[key] = polyfill;
-    }
-  }
 }
-
-function installOverrides(gl, {
-  target,
-  target2
-}) {
-  Object.keys(WEBGL2_CONTEXT_OVERRIDES).forEach(key => {
-    if (typeof WEBGL2_CONTEXT_OVERRIDES[key] === 'function') {
-      const originalFunc = gl[key] ? gl[key].bind(gl) : () => {};
-      const polyfill = WEBGL2_CONTEXT_OVERRIDES[key].bind(null, gl, originalFunc);
-      target[key] = polyfill;
-      target2[key] = polyfill;
-    }
-  });
+/** Install simple overrides (mostly get* functions) */
+function installOverrides(gl, { target, target2 }) {
+    Object.keys(WEBGL2_CONTEXT_OVERRIDES).forEach((key) => {
+        if (typeof WEBGL2_CONTEXT_OVERRIDES[key] === 'function') {
+            // install an override, if no implementation was detected
+            const originalFunc = gl[key] ? gl[key].bind(gl) : () => { };
+            const polyfill = WEBGL2_CONTEXT_OVERRIDES[key].bind(null, gl, originalFunc);
+            target[key] = polyfill;
+            target2[key] = polyfill;
+        }
+    });
 }
-//# sourceMappingURL=polyfill-context.js.map