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

package/dist/adapter/objects/webgl-resource.js

@@ -1,159 +1,209 @@
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
 import { Resource, assert, uid, stubRemovedMethods } from '@luma.gl/core';
-import { isWebGL2, assertWebGLContext } from "../../context/context/webgl-checks.js";
-import { WebGLDevice } from "../webgl-device.js";
-import { getKeyValue } from "./constants-to-keys.js";
+import { WebGLDevice } from '../webgl-device';
+// Requires full GL enum to be bundled... Make these bindings dependent on dynamic import (debug)?
+import { getKeyValue } from './constants-to-keys';
 const ERR_RESOURCE_METHOD_UNDEFINED = 'Resource subclass must define virtual methods';
+/**
+ * Base class for WebGL object wrappers
+ */
 export class WebGLResource extends Resource {
-  constructor(device, props, defaultProps) {
-    super(device, props, defaultProps);
-    this.device = void 0;
-    this.gl = void 0;
-    this.gl2 = void 0;
-    this._handle = void 0;
-    this._bound = false;
-    this.byteLength = 0;
-    this.device = WebGLDevice.attach(device);
-    const gl = this.device.gl;
-    assertWebGLContext(gl);
-    const {
-      id
-    } = props || {};
-    this.gl = gl;
-    this.gl2 = gl;
-    this.id = id || uid(this.constructor.name);
-    this._handle = props === null || props === void 0 ? void 0 : props.handle;
-    if (this._handle === undefined) {
-      this._handle = this._createHandle();
-    }
-    this.byteLength = 0;
-  }
-  toString() {
-    return `${this.constructor.name}(${this.id})`;
-  }
-  get handle() {
-    return this._handle;
-  }
-  delete() {
-    let {
-      deleteChildren = false
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    const children = this._handle && this._deleteHandle(this._handle);
-    if (this._handle) {
-      this.removeStats();
-    }
-    this._handle = null;
-    if (children && deleteChildren) {
-      children.filter(Boolean).forEach(child => child.destroy());
-    }
-    return this;
-  }
-  bind() {
-    let funcOrHandle = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.handle;
-    if (typeof funcOrHandle !== 'function') {
-      this._bindHandle(funcOrHandle);
-      return this;
-    }
-    let value;
-    if (!this._bound) {
-      this._bindHandle(this.handle);
-      this._bound = true;
-      value = funcOrHandle();
-      this._bound = false;
-      this._bindHandle(null);
-    } else {
-      value = funcOrHandle();
-    }
-    return value;
-  }
-  unbind() {
-    this.bind(null);
-  }
-  getParameter(pname) {
-    let props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    pname = getKeyValue(this.gl, pname);
-    assert(pname);
-    const parameters = this.constructor.PARAMETERS || {};
-    const parameter = parameters[pname];
-    if (parameter) {
-      const isWebgl2 = isWebGL2(this.gl);
-      const parameterAvailable = (!('webgl2' in parameter) || isWebgl2) && (!('extension' in parameter) || this.gl.getExtension(parameter.extension));
-      if (!parameterAvailable) {
-        const webgl1Default = parameter.webgl1;
-        const webgl2Default = 'webgl2' in parameter ? parameter.webgl2 : parameter.webgl1;
-        const defaultValue = isWebgl2 ? webgl2Default : webgl1Default;
-        return defaultValue;
-      }
-    }
-    return this._getParameter(pname, props);
-  }
-  getParameters() {
-    let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    const {
-      parameters,
-      keys
-    } = options;
-    const PARAMETERS = this.constructor.PARAMETERS || {};
-    const isWebgl2 = isWebGL2(this.gl);
-    const values = {};
-    const parameterKeys = parameters || Object.keys(PARAMETERS);
-    for (const pname of parameterKeys) {
-      const parameter = PARAMETERS[pname];
-      const parameterAvailable = parameter && (!('webgl2' in parameter) || isWebgl2) && (!('extension' in parameter) || this.gl.getExtension(parameter.extension));
-      if (parameterAvailable) {
-        const key = keys ? this.device.getGLKey(pname) : pname;
-        values[key] = this.getParameter(pname, options);
-        if (keys && parameter.type === 'GLenum') {
-          values[key] = this.device.getGLKey(values[key]);
+    device;
+    gl;
+    gl2;
+    _handle;
+    _bound = false;
+    // Only meaningful for resources that allocate GPU memory
+    byteLength = 0;
+    constructor(device, props, defaultProps) {
+        super(device, props, defaultProps);
+        this.device = WebGLDevice.attach(device);
+        const gl = this.device.gl;
+        // extends 
+        const { id } = props || {};
+        this.gl = gl;
+        this.gl2 = gl;
+        this.id = id || uid(this.constructor.name);
+        // Set the handle
+        // If handle was provided, use it, otherwise create a new handle
+        // TODO - Stores the handle with context loss information
+        // this.glCount = glGetContextLossCount(this.gl);
+        // Default VertexArray needs to be created with null handle, so compare against undefined
+        this._handle = props?.handle;
+        if (this._handle === undefined) {
+            this._handle = this._createHandle();
         }
-      }
-    }
-    return values;
-  }
-  setParameter(pname, value) {
-    pname = getKeyValue(this.gl, pname);
-    assert(pname);
-    const parameters = this.constructor.PARAMETERS || {};
-    const parameter = parameters[pname];
-    if (parameter) {
-      const isWebgl2 = isWebGL2(this.gl);
-      const parameterAvailable = (!('webgl2' in parameter) || isWebgl2) && (!('extension' in parameter) || this.gl.getExtension(parameter.extension));
-      if (!parameterAvailable) {
-        throw new Error('Parameter not available on this platform');
-      }
-      if (parameter.type === 'GLenum') {
-        value = getKeyValue(value);
-      }
-    }
-    this._setParameter(pname, value);
-    return this;
-  }
-  setParameters(parameters) {
-    for (const pname in parameters) {
-      this.setParameter(pname, parameters[pname]);
-    }
-    return this;
-  }
-  stubRemovedMethods(className, version, methodNames) {
-    return stubRemovedMethods(this, className, version, methodNames);
-  }
-  initialize(props) {}
-  _createHandle() {
-    throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
-  }
-  _deleteHandle() {
-    throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
-  }
-  _bindHandle(handle) {
-    throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
-  }
-  _getOptsFromHandle() {
-    throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
-  }
-  _getParameter(pname, props) {
-    throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
-  }
-  _setParameter(pname, value) {
-    throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
-  }
+        this.byteLength = 0;
+    }
+    toString() {
+        return `${this.constructor.name}(${this.id})`;
+    }
+    get handle() {
+        // TODO - Add context loss handling
+        // Will regenerate and reinitialize the handle if necessary
+        // const glCount = glGetContextLossCount(this.gl);
+        // if (this.glCount !== glCount) {
+        //   this._handle = this._createHandle(this.props);
+        //   this._glCount = glCount;
+        //   // Reinitialize object
+        //   this.initialize(this.props);
+        // }
+        return this._handle;
+    }
+    delete({ deleteChildren = false } = {}) {
+        // Delete this object, and get refs to any children
+        // @ts-expect-error
+        const children = this._handle && this._deleteHandle(this._handle);
+        if (this._handle) {
+            this.removeStats();
+        }
+        this._handle = null;
+        // Optionally, recursively delete the children
+        // @ts-expect-error
+        if (children && deleteChildren) {
+            // @ts-expect-error
+            children.filter(Boolean).forEach((child) => child.destroy());
+        }
+        return this;
+    }
+    bind(funcOrHandle = this.handle) {
+        if (typeof funcOrHandle !== 'function') {
+            this._bindHandle(funcOrHandle);
+            return this;
+        }
+        let value;
+        if (!this._bound) {
+            this._bindHandle(this.handle);
+            this._bound = true;
+            value = funcOrHandle();
+            this._bound = false;
+            this._bindHandle(null);
+        }
+        else {
+            value = funcOrHandle();
+        }
+        return value;
+    }
+    unbind() {
+        this.bind(null);
+    }
+    /**
+     * Query a Resource parameter
+     *
+     * @param name
+     * @return param
+     */
+    getParameter(pname, props = {}) {
+        pname = getKeyValue(this.gl, pname);
+        assert(pname);
+        // @ts-expect-error
+        const parameters = this.constructor.PARAMETERS || {};
+        // Use parameter definitions to handle unsupported parameters
+        const parameter = parameters[pname];
+        if (parameter) {
+            // Check if we can query for this parameter
+            const parameterAvailable = (!('extension' in parameter) || this.gl.getExtension(parameter.extension));
+            if (!parameterAvailable) {
+                return parameter.webgl2;
+            }
+        }
+        // If unknown parameter - Could be a valid parameter not covered by PARAMS
+        // Attempt to query for it and let WebGL report errors
+        return this._getParameter(pname, props);
+    }
+    // Many resources support a getParameter call -
+    // getParameters will get all parameters - slow but useful for debugging
+    // eslint-disable-next-line complexity
+    getParameters(options = {}) {
+        const { parameters, keys } = options;
+        // Get parameter definitions for this Resource
+        // @ts-expect-error
+        const PARAMETERS = this.constructor.PARAMETERS || {};
+        const values = {};
+        // Query all parameters if no list provided
+        const parameterKeys = parameters || Object.keys(PARAMETERS);
+        // WEBGL limits
+        for (const pname of parameterKeys) {
+            const parameter = PARAMETERS[pname];
+            // Check if this parameter is available on this platform
+            const parameterAvailable = parameter &&
+                (!('extension' in parameter) || this.gl.getExtension(parameter.extension));
+            if (parameterAvailable) {
+                const key = keys ? this.device.getGLKey(pname) : pname;
+                values[key] = this.getParameter(pname, options);
+                if (keys && parameter.type === 'GLenum') {
+                    values[key] = this.device.getGLKey(values[key]);
+                }
+            }
+        }
+        return values;
+    }
+    /**
+     * Update a Resource setting
+     *
+     * @todo - cache parameter to avoid issuing WebGL calls?
+     *
+     * @param pname - parameter (GL constant, value or key)
+     * @param value {GLint|GLfloat|GLenum}
+     * @return returns self to enable chaining
+     */
+    setParameter(pname, value) {
+        pname = getKeyValue(this.gl, pname);
+        assert(pname);
+        // @ts-expect-error
+        const parameters = this.constructor.PARAMETERS || {};
+        const parameter = parameters[pname];
+        if (parameter) {
+            // Check if this parameter is available on this platform
+            const parameterAvailable = (!('extension' in parameter) || this.gl.getExtension(parameter.extension));
+            if (!parameterAvailable) {
+                throw new Error('Parameter not available on this platform');
+            }
+            // Handle string keys
+            if (parameter.type === 'GLenum') {
+                // @ts-expect-error
+                value = getKeyValue(value);
+            }
+        }
+        // If unknown parameter - Could be a valid parameter not covered by PARAMS
+        // attempt to set it and let WebGL report errors
+        this._setParameter(pname, value);
+        return this;
+    }
+    /*
+     * Batch update resource parameters
+     * Assumes the subclass supports a setParameter call
+     */
+    setParameters(parameters) {
+        for (const pname in parameters) {
+            this.setParameter(pname, parameters[pname]);
+        }
+        return this;
+    }
+    // Install stubs for removed methods
+    stubRemovedMethods(className, version, methodNames) {
+        return stubRemovedMethods(this, className, version, methodNames);
+    }
+    // PUBLIC VIRTUAL METHODS
+    initialize(props) { }
+    // PROTECTED METHODS - These must be overridden by subclass
+    _createHandle() {
+        throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
+    }
+    _deleteHandle() {
+        throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
+    }
+    _bindHandle(handle) {
+        throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
+    }
+    _getOptsFromHandle() {
+        throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
+    }
+    _getParameter(pname, props) {
+        throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
+    }
+    _setParameter(pname, value) {
+        throw new Error(ERR_RESOURCE_METHOD_UNDEFINED);
+    }
 }
-//# sourceMappingURL=webgl-resource.js.map

package/dist/adapter/resources/webgl-buffer.d.ts

@@ -5,8 +5,7 @@ import { WebGLDevice } from '../webgl-device';
 /** WebGL Buffer interface */
 export declare class WEBGLBuffer extends Buffer {
     readonly device: WebGLDevice;
-    readonly gl: WebGLRenderingContext;
-    readonly gl2: WebGL2RenderingContext | null;
+    readonly gl: WebGL2RenderingContext;
     readonly handle: WebGLBuffer;
     /** Target in OpenGL defines the type of buffer */
     readonly glTarget: GL.ARRAY_BUFFER | GL.ELEMENT_ARRAY_BUFFER | GL.UNIFORM_BUFFER;
@@ -27,6 +26,6 @@ export declare class WEBGLBuffer extends Buffer {
     /** Asynchronously read data from the buffer */
     readAsync(byteOffset?: number, byteLength?: number): Promise<Uint8Array>;
     /** Synchronously read data from the buffer. WebGL only. */
-    readSyncWebGL2(byteOffset?: number, byteLength?: number): Uint8Array;
+    readSyncWebGL(byteOffset?: number, byteLength?: number): Uint8Array;
 }
 //# sourceMappingURL=webgl-buffer.d.ts.map

package/dist/adapter/resources/webgl-buffer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webgl-buffer.d.ts","sourceRoot":"","sources":["../../../src/adapter/resources/webgl-buffer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAC,MAAM,EAAS,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAC,EAAE,EAAC,MAAM,oBAAoB,CAAC;AACtC,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAE5C,6BAA6B;AAC7B,qBAAa,WAAY,SAAQ,MAAM;IACrC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,EAAE,EAAE,qBAAqB,CAAC;IACnC,QAAQ,CAAC,GAAG,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC5C,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAE7B,kDAAkD;IAClD,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,GAAG,EAAE,CAAC,oBAAoB,GAAG,EAAE,CAAC,cAAc,CAAC;IACjF,mEAAmE;IACnE,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC;IACnD,yEAAyE;IACzE,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,cAAc,GAAG,EAAE,CAAC,YAAY,CAAqB;IAE9E,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;gBAEN,MAAM,EAAE,WAAW,EAAE,KAAK,GAAE,WAAgB;IA4BxD,sEAAsE;IACtE,aAAa,CACX,IAAI,EAAE,WAAW,GAAG,eAAe,EACnC,UAAU,GAAE,MAAU,EACtB,UAAU,GAAE,MAAqC,GAChD,IAAI;IAgBP,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IA2BpC,OAAO,IAAI,IAAI;IAWf,KAAK,CAAC,IAAI,EAAE,eAAe,EAAE,UAAU,GAAE,MAAU,GAAG,IAAI;IAoBnE,+CAA+C;IAChC,SAAS,CAAC,UAAU,SAAI,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAIlF,2DAA2D;IAClD,cAAc,CAAC,UAAU,SAAI,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU;CAiBzE"}
+{"version":3,"file":"webgl-buffer.d.ts","sourceRoot":"","sources":["../../../src/adapter/resources/webgl-buffer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAC,MAAM,EAAS,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAC,EAAE,EAAC,MAAM,oBAAoB,CAAC;AACtC,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAE5C,6BAA6B;AAC7B,qBAAa,WAAY,SAAQ,MAAM;IACrC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,EAAE,EAAE,sBAAsB,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAE7B,kDAAkD;IAClD,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,GAAG,EAAE,CAAC,oBAAoB,GAAG,EAAE,CAAC,cAAc,CAAC;IACjF,mEAAmE;IACnE,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC;IACnD,yEAAyE;IACzE,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,cAAc,GAAG,EAAE,CAAC,YAAY,CAAqB;IAE9E,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;gBAEN,MAAM,EAAE,WAAW,EAAE,KAAK,GAAE,WAAgB;IA2BxD,sEAAsE;IACtE,aAAa,CACX,IAAI,EAAE,WAAW,GAAG,eAAe,EACnC,UAAU,GAAE,MAAU,EACtB,UAAU,GAAE,MAAqC,GAChD,IAAI;IAgBP,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IA2BpC,OAAO,IAAI,IAAI;IAWf,KAAK,CAAC,IAAI,EAAE,eAAe,EAAE,UAAU,GAAE,MAAU,GAAG,IAAI;IAmBnE,+CAA+C;IAChC,SAAS,CAAC,UAAU,SAAI,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAIlF,2DAA2D;IAClD,aAAa,CAAC,UAAU,SAAI,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,UAAU;CAexE"}