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

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

@@ -1,94 +1,75 @@
+/* eslint-disable no-inline-comments */
 import { assert } from '@luma.gl/api';
 import GL from '@luma.gl/constants';
-import WebGLResource from './webgl-resource';
-import { isRenderbufferFormatSupported, getRenderbufferFormatBytesPerPixel } from '../converters/renderbuffer-formats';
+import WebGLResource from './webgl-resource.js';
+import { isRenderbufferFormatSupported, getRenderbufferFormatBytesPerPixel } from '../converters/renderbuffer-formats.js';
 const DEFAULT_RENDERBUFFER_PROPS = {
-  id: undefined,
-  handle: undefined,
-  userData: undefined,
-  format: 0,
-  width: 1,
-  height: 1,
-  samples: 0
+    id: undefined,
+    handle: undefined,
+    userData: undefined,
+    format: 0,
+    width: 1,
+    height: 1,
+    samples: 0
 };
+/**
+ * Renderbuffers are GPU objects that contain images.
+ * In contrast to Textures they are optimized for use as render targets, with Framebuffers.
+ * while Textures may not be, and are the logical choice when
+ * you do not need to sample (i.e. in a post-pass shader)
+ * from the produced image. If you need to resample
+ * (such as when reading depth back in a second shader pass),
+ * use Textures instead.
+ * Renderbuffer objects also natively accommodate Multisampling (MSAA).
+ */
 export default class WEBGLRenderbuffer extends WebGLResource {
-  get [Symbol.toStringTag]() {
-    return 'Renderbuffer';
-  }
-
-  get width() {
-    return this.props.width;
-  }
-
-  get height() {
-    return this.props.height;
-  }
-
-  get format() {
-    return this.props.format;
-  }
-
-  get samples() {
-    return this.props.samples;
-  }
-
-  static isSupported(gl, options) {
-    return !(options !== null && options !== void 0 && options.format) || isRenderbufferFormatSupported(gl, options.format);
-  }
-
-  constructor(device, props) {
-    super(device, props, DEFAULT_RENDERBUFFER_PROPS);
-
-    this._initialize(this.props);
-  }
-
-  resize(size) {
-    if (size.width !== this.width || size.height !== this.height) {
-      Object.assign(this.props, { ...size,
-        format: this.format,
-        samples: this.samples
-      });
-
-      this._initialize(this.props);
+    get [Symbol.toStringTag]() { return 'Renderbuffer'; }
+    get width() { return this.props.width; }
+    get height() { return this.props.height; }
+    get format() { return this.props.format; }
+    get samples() { return this.props.samples; }
+    static isSupported(gl, options) {
+        return !options?.format || isRenderbufferFormatSupported(gl, options.format);
     }
-
-    return this;
-  }
-
-  _initialize(props) {
-    const {
-      format,
-      width,
-      height,
-      samples
-    } = props;
-    assert(format, 'Needs format');
-    this.trackDeallocatedMemory();
-    this.gl.bindRenderbuffer(GL.RENDERBUFFER, this.handle);
-
-    if (samples !== 0 && this.device.isWebGL2) {
-      this.gl.renderbufferStorageMultisample(GL.RENDERBUFFER, samples, format, width, height);
-    } else {
-      this.gl.renderbufferStorage(GL.RENDERBUFFER, format, width, height);
+    constructor(device, props) {
+        super(device, props, DEFAULT_RENDERBUFFER_PROPS);
+        this._initialize(this.props);
+    }
+    resize(size) {
+        // Don't resize if width/height haven't changed
+        if (size.width !== this.width || size.height !== this.height) {
+            Object.assign(this.props, { ...size, format: this.format, samples: this.samples });
+            this._initialize(this.props);
+        }
+        return this;
+    }
+    // PRIVATE METHODS
+    /** Creates and initializes a renderbuffer object's data store */
+    _initialize(props) {
+        const { format, width, height, samples } = props;
+        assert(format, 'Needs format');
+        this.trackDeallocatedMemory();
+        this.gl.bindRenderbuffer(GL.RENDERBUFFER, this.handle);
+        if (samples !== 0 && this.device.isWebGL2) {
+            // @ts-expect-error
+            this.gl.renderbufferStorageMultisample(GL.RENDERBUFFER, samples, format, width, height);
+        }
+        else {
+            this.gl.renderbufferStorage(GL.RENDERBUFFER, format, width, height);
+        }
+        this.gl.bindRenderbuffer(GL.RENDERBUFFER, null);
+        this.trackAllocatedMemory(width * height * (samples || 1) * getRenderbufferFormatBytesPerPixel(format));
+        return this;
+    }
+    // RESOURCE IMPLEMENTATION
+    _createHandle() {
+        return this.gl.createRenderbuffer();
+    }
+    _deleteHandle() {
+        this.gl.deleteRenderbuffer(this.handle);
+        this.trackDeallocatedMemory();
+    }
+    _bindHandle(handle) {
+        this.gl.bindRenderbuffer(GL.RENDERBUFFER, handle);
     }
-
-    this.gl.bindRenderbuffer(GL.RENDERBUFFER, null);
-    this.trackAllocatedMemory(width * height * (samples || 1) * getRenderbufferFormatBytesPerPixel(format));
-    return this;
-  }
-
-  _createHandle() {
-    return this.gl.createRenderbuffer();
-  }
-
-  _deleteHandle() {
-    this.gl.deleteRenderbuffer(this.handle);
-    this.trackDeallocatedMemory();
-  }
-
-  _bindHandle(handle) {
-    this.gl.bindRenderbuffer(GL.RENDERBUFFER, handle);
-  }
-
 }
-//# sourceMappingURL=webgl-renderbuffer.js.map

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

@@ -1,210 +1,218 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+// luma.gl, MIT license
 import { Resource, assert, uid, stubRemovedMethods } from '@luma.gl/api';
-import { isWebGL2, assertWebGLContext } from '../../context/context/webgl-checks';
-import WebGLDevice from '../webgl-device';
-import { getKey, getKeyValue } from './constants-to-keys';
+import { isWebGL2, assertWebGLContext } from '../../context/context/webgl-checks.js';
+import WebGLDevice from '../webgl-device.js';
+// Requires full GL enum to be bundled... Make these bindings dependent on dynamic import (debug)?
+import { getKey, getKeyValue } from './constants-to-keys.js';
 const ERR_RESOURCE_METHOD_UNDEFINED = 'Resource subclass must define virtual methods';
+/**
+ * Base class for WebGL object wrappers
+ */
 export default class WebGLResource extends Resource {
-  constructor(device, props, defaultProps) {
-    super(device, props, defaultProps);
-
-    _defineProperty(this, "device", void 0);
-
-    _defineProperty(this, "gl", void 0);
-
-    _defineProperty(this, "gl2", void 0);
-
-    _defineProperty(this, "_handle", void 0);
-
-    _defineProperty(this, "_bound", false);
-
-    _defineProperty(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 "".concat(this.constructor.name, "(").concat(this.id, ")");
-  }
-
-  get handle() {
-    return this._handle;
-  }
-
-  destroy() {
-    this.delete();
-  }
-
-  delete({
-    deleteChildren = false
-  } = {}) {
-    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.delete());
-    }
-
-    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);
-  }
-
-  getParameter(pname, props = {}) {
-    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(options = {}) {
-    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 ? getKey(this.gl, pname) : pname;
-        values[key] = this.getParameter(pname, options);
-
-        if (keys && parameter.type === 'GLenum') {
-          values[key] = getKey(this.gl, values[key]);
+    constructor(device, props, defaultProps) {
+        super(device, props, defaultProps);
+        this._bound = false;
+        // Only meaningful for resources that allocate GPU memory
+        this.byteLength = 0;
+        this.device = WebGLDevice.attach(device);
+        const gl = this.device.gl;
+        assertWebGLContext(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;
+    }
+    destroy() {
+        this.delete();
+    }
+    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.delete());
+        }
+        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) {
+            const isWebgl2 = isWebGL2(this.gl);
+            // Check if we can query for this parameter
+            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;
+            }
+        }
+        // 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 isWebgl2 = isWebGL2(this.gl);
+        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 &&
+                (!('webgl2' in parameter) || isWebgl2) &&
+                (!('extension' in parameter) || this.gl.getExtension(parameter.extension));
+            if (parameterAvailable) {
+                const key = keys ? getKey(this.gl, pname) : pname;
+                values[key] = this.getParameter(pname, options);
+                if (keys && parameter.type === 'GLenum') {
+                    values[key] = getKey(this.gl, 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) {
+            const isWebgl2 = isWebGL2(this.gl);
+            // Check if this parameter is available on this platform
+            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');
+            }
+            // 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/objects/webgl-vertex-array-object.d.ts

@@ -5,7 +5,7 @@ import Buffer from '../resources/webgl-buffer';
 /**
  * VertexArrayObject properties
  */
-export declare type VertexArrayObjectProps = ResourceProps & {};
+export type VertexArrayObjectProps = ResourceProps & {};
 /** VertexArrayObject wrapper */
 export default class WEBGLVertexArrayObject extends WebGLResource<VertexArrayObjectProps> {
     get [Symbol.toStringTag](): string;

package/dist/adapter/objects/webgl-vertex-array-object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webgl-vertex-array-object.d.ts","sourceRoot":"","sources":["../../../src/adapter/objects/webgl-vertex-array-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,aAAa,EAAC,MAAM,cAAc,CAAC;AAInD,OAAO,WAAW,MAAM,iBAAiB,CAAC;AAC1C,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAE7C,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAI/C;;GAEG;AACH,oBAAY,sBAAsB,GAAG,aAAa,GAAG,EACpD,CAAC;AAEF,gCAAgC;AAChC,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,aAAa,CAAC,sBAAsB,CAAC;IACxF,IAAa,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEzC;gBAEW,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,sBAAsB;IAKtD,aAAa;IAIb,aAAa,IAAI,IAAI;IAOrB,WAAW,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAM1D,gBAAgB,CAAC,aAAa,GAAE,MAAM,GAAG,IAAW,EAAE,IAAI,KAAK;IAW/D,gGAAgG;IAChG,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,IAAI;IAgChE;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAO,GAAG,IAAI;CAe9C"}
+{"version":3,"file":"webgl-vertex-array-object.d.ts","sourceRoot":"","sources":["../../../src/adapter/objects/webgl-vertex-array-object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,aAAa,EAAC,MAAM,cAAc,CAAC;AAInD,OAAO,WAAW,MAAM,iBAAiB,CAAC;AAC1C,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAE7C,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAI/C;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG,EACpD,CAAC;AAEF,gCAAgC;AAChC,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,aAAa,CAAC,sBAAsB,CAAC;IACxF,IAAa,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEzC;gBAEW,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,sBAAsB;IAKtD,aAAa;IAIb,aAAa,IAAI,IAAI;IAOrB,WAAW,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAM1D,gBAAgB,CAAC,aAAa,GAAE,MAAM,GAAG,IAAW,EAAE,IAAI,KAAK;IAW/D,gGAAgG;IAChG,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,IAAI;IAgChE;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAO,GAAG,IAAI;CAe9C"}