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

package/dist/adapter/resources/webgl-buffer.js

@@ -1,130 +1,171 @@
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
 import { Buffer, assert } from '@luma.gl/core';
+import { GL } from '@luma.gl/constants';
+/** WebGL Buffer interface */
 export class WEBGLBuffer extends Buffer {
-  constructor(device) {
-    let props = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    super(device, props);
-    this.device = void 0;
-    this.gl = void 0;
-    this.gl2 = void 0;
-    this.handle = void 0;
-    this.glTarget = void 0;
-    this.glUsage = void 0;
-    this.glIndexType = 5123;
-    this.byteLength = void 0;
-    this.bytesUsed = void 0;
-    this.device = device;
-    this.gl = this.device.gl;
-    this.gl2 = this.device.gl2;
-    const handle = typeof props === 'object' ? props.handle : undefined;
-    this.handle = handle || this.gl.createBuffer();
-    device.setSpectorMetadata(this.handle, {
-      ...this.props,
-      data: typeof this.props.data
-    });
-    this.glTarget = getWebGLTarget(this.props.usage);
-    this.glUsage = getWebGLUsage(this.props.usage);
-    this.glIndexType = this.props.indexType === 'uint32' ? 5125 : 5123;
-    if (props.data) {
-      this._initWithData(props.data, props.byteOffset, props.byteLength);
-    } else {
-      this._initWithByteLength(props.byteLength || 0);
+    device;
+    gl;
+    handle;
+    /** Target in OpenGL defines the type of buffer */
+    glTarget;
+    /** Usage is a hint on how frequently the buffer will be updates */
+    glUsage;
+    /** Index type is needed when issuing draw calls, so we pre-compute it */
+    glIndexType = GL.UNSIGNED_SHORT;
+    /** Number of bytes allocated on the GPU for this buffer */
+    byteLength;
+    /** Number of bytes used */
+    bytesUsed;
+    constructor(device, props = {}) {
+        super(device, props);
+        this.device = device;
+        this.gl = this.device.gl;
+        const handle = typeof props === 'object' ? props.handle : undefined;
+        this.handle = handle || this.gl.createBuffer();
+        device.setSpectorMetadata(this.handle, { ...this.props, data: typeof this.props.data });
+        // - In WebGL1, need to make sure we use GL.ELEMENT_ARRAY_BUFFER when initializing element buffers
+        //   otherwise buffer type will lock to generic (non-element) buffer
+        // - In WebGL2, we can use GL.COPY_READ_BUFFER which avoids locking the type here
+        this.glTarget = getWebGLTarget(this.props.usage);
+        this.glUsage = getWebGLUsage(this.props.usage);
+        this.glIndexType = this.props.indexType === 'uint32' ? GL.UNSIGNED_INT : GL.UNSIGNED_SHORT;
+        // Set data: (re)initializes the buffer
+        if (props.data) {
+            this._initWithData(props.data, props.byteOffset, props.byteLength);
+        }
+        else {
+            this._initWithByteLength(props.byteLength || 0);
+        }
     }
-  }
-  _initWithData(data) {
-    let byteOffset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    let byteLength = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : data.byteLength + byteOffset;
-    const glTarget = this.glTarget;
-    this.gl.bindBuffer(glTarget, this.handle);
-    this.gl.bufferData(glTarget, byteLength, this.glUsage);
-    this.gl.bufferSubData(glTarget, byteOffset, data);
-    this.gl.bindBuffer(glTarget, null);
-    this.bytesUsed = byteLength;
-    this.byteLength = byteLength;
-    this._setDebugData(data, byteOffset, byteLength);
-    this.trackAllocatedMemory(byteLength);
-  }
-  _initWithByteLength(byteLength) {
-    assert(byteLength >= 0);
-    let data = byteLength;
-    if (byteLength === 0) {
-      data = new Float32Array(0);
+    // PRIVATE METHODS
+    /** Allocate a new buffer and initialize to contents of typed array */
+    _initWithData(data, byteOffset = 0, byteLength = data.byteLength + byteOffset) {
+        // const glTarget = this.device.isWebGL2 ? GL.COPY_WRITE_BUFFER : this.glTarget;
+        const glTarget = this.glTarget;
+        this.gl.bindBuffer(glTarget, this.handle);
+        this.gl.bufferData(glTarget, byteLength, this.glUsage);
+        this.gl.bufferSubData(glTarget, byteOffset, data);
+        this.gl.bindBuffer(glTarget, null);
+        this.bytesUsed = byteLength;
+        this.byteLength = byteLength;
+        this._setDebugData(data, byteOffset, byteLength);
+        this.trackAllocatedMemory(byteLength);
     }
-    const glTarget = this.glTarget;
-    this.gl.bindBuffer(glTarget, this.handle);
-    this.gl.bufferData(glTarget, data, this.glUsage);
-    this.gl.bindBuffer(glTarget, null);
-    this.bytesUsed = byteLength;
-    this.byteLength = byteLength;
-    this._setDebugData(null, 0, byteLength);
-    this.trackAllocatedMemory(byteLength);
-    return this;
-  }
-  destroy() {
-    if (!this.destroyed && this.handle) {
-      this.removeStats();
-      this.trackDeallocatedMemory();
-      this.gl.deleteBuffer(this.handle);
-      this.destroyed = true;
-      this.handle = null;
+    // Allocate a GPU buffer of specified size.
+    _initWithByteLength(byteLength) {
+        assert(byteLength >= 0);
+        // Workaround needed for Safari (#291):
+        // gl.bufferData with size equal to 0 crashes. Instead create zero sized array.
+        let data = byteLength;
+        if (byteLength === 0) {
+            // @ts-expect-error
+            data = new Float32Array(0);
+        }
+        // const glTarget = this.device.isWebGL2 ? GL.COPY_WRITE_BUFFER : this.glTarget;
+        const glTarget = this.glTarget;
+        this.gl.bindBuffer(glTarget, this.handle);
+        this.gl.bufferData(glTarget, data, this.glUsage);
+        this.gl.bindBuffer(glTarget, null);
+        this.bytesUsed = byteLength;
+        this.byteLength = byteLength;
+        this._setDebugData(null, 0, byteLength);
+        this.trackAllocatedMemory(byteLength);
+        return this;
     }
-  }
-  write(data) {
-    let byteOffset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-    const srcOffset = 0;
-    const byteLength = undefined;
-    const glTarget = this.device.isWebGL2 ? 36663 : this.glTarget;
-    this.gl.bindBuffer(glTarget, this.handle);
-    if (srcOffset !== 0 || byteLength !== undefined) {
-      this.device.assertWebGL2();
-      this.gl2.bufferSubData(glTarget, byteOffset, data, srcOffset, byteLength);
-    } else {
-      this.gl.bufferSubData(glTarget, byteOffset, data);
+    destroy() {
+        if (!this.destroyed && this.handle) {
+            this.removeStats();
+            this.trackDeallocatedMemory();
+            this.gl.deleteBuffer(this.handle);
+            this.destroyed = true;
+            // @ts-expect-error
+            this.handle = null;
+        }
+    }
+    write(data, byteOffset = 0) {
+        const srcOffset = 0;
+        const byteLength = undefined; // data.byteLength;
+        // Create the buffer - binding it here for the first time locks the type
+        // In WebGL2, use GL.COPY_WRITE_BUFFER to avoid locking the type
+        const glTarget = GL.COPY_WRITE_BUFFER;
+        this.gl.bindBuffer(glTarget, this.handle);
+        // WebGL2: subData supports additional srcOffset and length parameters
+        if (srcOffset !== 0 || byteLength !== undefined) {
+            this.gl.bufferSubData(glTarget, byteOffset, data, srcOffset, byteLength);
+        }
+        else {
+            this.gl.bufferSubData(glTarget, byteOffset, data);
+        }
+        this.gl.bindBuffer(glTarget, null);
+        this._setDebugData(data, byteOffset, data.byteLength);
+    }
+    /** Asynchronously read data from the buffer */
+    async readAsync(byteOffset = 0, byteLength) {
+        return this.readSyncWebGL(byteOffset, byteLength);
+    }
+    /** Synchronously read data from the buffer. WebGL only. */
+    readSyncWebGL(byteOffset = 0, byteLength) {
+        byteLength = byteLength ?? this.byteLength - byteOffset;
+        const data = new Uint8Array(byteLength);
+        const dstOffset = 0;
+        // Use GL.COPY_READ_BUFFER to avoid disturbing other targets and locking type
+        this.gl.bindBuffer(GL.COPY_READ_BUFFER, this.handle);
+        this.gl.getBufferSubData(GL.COPY_READ_BUFFER, byteOffset, data, dstOffset, byteLength);
+        this.gl.bindBuffer(GL.COPY_READ_BUFFER, null);
+        // Update local `data` if offsets are 0
+        this._setDebugData(data, byteOffset, byteLength);
+        return data;
     }
-    this.gl.bindBuffer(glTarget, null);
-    this._setDebugData(data, byteOffset, data.byteLength);
-  }
-  async readAsync() {
-    let byteOffset = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
-    let byteLength = arguments.length > 1 ? arguments[1] : undefined;
-    return this.readSyncWebGL2(byteOffset, byteLength);
-  }
-  readSyncWebGL2() {
-    var _byteLength;
-    let byteOffset = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
-    let byteLength = arguments.length > 1 ? arguments[1] : undefined;
-    this.device.assertWebGL2();
-    byteLength = (_byteLength = byteLength) !== null && _byteLength !== void 0 ? _byteLength : this.byteLength - byteOffset;
-    const data = new Uint8Array(byteLength);
-    const dstOffset = 0;
-    this.gl.bindBuffer(36662, this.handle);
-    this.gl2.getBufferSubData(36662, byteOffset, data, dstOffset, byteLength);
-    this.gl.bindBuffer(36662, null);
-    this._setDebugData(data, byteOffset, byteLength);
-    return data;
-  }
 }
+/**
+ * Returns a WebGL buffer target
+ *
+ * @param usage
+ * static MAP_READ = 0x01;
+ * static MAP_WRITE = 0x02;
+ * static COPY_SRC = 0x0004;
+ * static COPY_DST = 0x0008;
+ * static INDEX = 0x0010;
+ * static VERTEX = 0x0020;
+ * static UNIFORM = 0x0040;
+ * static STORAGE = 0x0080;
+ * static INDIRECT = 0x0100;
+ * static QUERY_RESOLVE = 0x0200;
+ *
+ * @returns WebGL buffer targe
+ *
+ * Buffer bind points in WebGL2
+ * gl.COPY_READ_BUFFER: Buffer for copying from one buffer object to another.
+ * gl.COPY_WRITE_BUFFER: Buffer for copying from one buffer object to another.
+ * gl.TRANSFORM_FEEDBACK_BUFFER: Buffer for transform feedback operations.
+ * gl.PIXEL_PACK_BUFFER: Buffer used for pixel transfer operations.
+ * gl.PIXEL_UNPACK_BUFFER: Buffer used for pixel transfer operations.
+ */
 function getWebGLTarget(usage) {
-  if (usage & Buffer.INDEX) {
-    return 34963;
-  }
-  if (usage & Buffer.VERTEX) {
-    return 34962;
-  }
-  if (usage & Buffer.UNIFORM) {
-    return 35345;
-  }
-  return 34962;
+    if (usage & Buffer.INDEX) {
+        return GL.ELEMENT_ARRAY_BUFFER;
+    }
+    if (usage & Buffer.VERTEX) {
+        return GL.ARRAY_BUFFER;
+    }
+    if (usage & Buffer.UNIFORM) {
+        return GL.UNIFORM_BUFFER;
+    }
+    // Binding a buffer for the first time locks the type
+    // In WebGL2, we can use GL.COPY_WRITE_BUFFER to avoid locking the type
+    return GL.ARRAY_BUFFER;
 }
+/** @todo usage is not passed correctly */
 function getWebGLUsage(usage) {
-  if (usage & Buffer.INDEX) {
-    return 35044;
-  }
-  if (usage & Buffer.VERTEX) {
-    return 35044;
-  }
-  if (usage & Buffer.UNIFORM) {
-    return 35048;
-  }
-  return 35044;
+    if (usage & Buffer.INDEX) {
+        return GL.STATIC_DRAW;
+    }
+    if (usage & Buffer.VERTEX) {
+        return GL.STATIC_DRAW;
+    }
+    if (usage & Buffer.UNIFORM) {
+        return GL.DYNAMIC_DRAW;
+    }
+    return GL.STATIC_DRAW;
 }
-//# sourceMappingURL=webgl-buffer.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"webgl-command-buffer.d.ts","sourceRoot":"","sources":["../../../src/adapter/resources/webgl-command-buffer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,0BAA0B,EAC1B,2BAA2B,EAC5B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAC,aAAa,EAAuB,MAAM,eAAe,CAAC;AAClE,OAAO,EAAC,EAAE,EAAC,MAAM,oBAAoB,CAAC;AAEtC,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAU5C,KAAK,yBAAyB,GAAG;IAC/B,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,yBAAyB,CAAC;CACpC,CAAC;AAEF,KAAK,0BAA0B,GAAG;IAChC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,0BAA0B,CAAC;CACrC,CAAC;AAEF,KAAK,0BAA0B,GAAG;IAChC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,0BAA0B,CAAC;CACrC,CAAC;AAEF,KAAK,2BAA2B,GAAG;IACjC,IAAI,EAAE,yBAAyB,CAAC;IAChC,OAAO,EAAE,2BAA2B,CAAC;CACtC,CAAC;AAEF,KAAK,OAAO,GACR,yBAAyB,GACzB,0BAA0B,GAC1B,0BAA0B,GAC1B,2BAA2B,CAAC;AAEhC,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,MAAM,EAAE,WAAW,CAAC;IACpB,QAAQ,EAAE,OAAO,EAAE,CAAM;gBAEb,MAAM,EAAE,WAAW;IAK/B,cAAc,CAAC,QAAQ,GAAE,OAAO,EAAkB;CAkBnD;AAwQD,wBAAgB,oBAAoB,CAAC,MAAM,KAAA,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAmB1D;AAGD,wBAAgB,aAAa,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAcjD"}
+{"version":3,"file":"webgl-command-buffer.d.ts","sourceRoot":"","sources":["../../../src/adapter/resources/webgl-command-buffer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,0BAA0B,EAC1B,2BAA2B,EAC5B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAC,aAAa,EAAuB,MAAM,eAAe,CAAC;AAClE,OAAO,EAAC,EAAE,EAAC,MAAM,oBAAoB,CAAC;AAEtC,OAAO,EAAC,WAAW,EAAC,MAAM,iBAAiB,CAAC;AAU5C,KAAK,yBAAyB,GAAG;IAC/B,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,yBAAyB,CAAC;CACpC,CAAC;AAEF,KAAK,0BAA0B,GAAG;IAChC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,0BAA0B,CAAC;CACrC,CAAC;AAEF,KAAK,0BAA0B,GAAG;IAChC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,0BAA0B,CAAC;CACrC,CAAC;AAEF,KAAK,2BAA2B,GAAG;IACjC,IAAI,EAAE,yBAAyB,CAAC;IAChC,OAAO,EAAE,2BAA2B,CAAC;CACtC,CAAC;AAEF,KAAK,OAAO,GACR,yBAAyB,GACzB,0BAA0B,GAC1B,0BAA0B,GAC1B,2BAA2B,CAAC;AAEhC,qBAAa,kBAAmB,SAAQ,aAAa;IACnD,MAAM,EAAE,WAAW,CAAC;IACpB,QAAQ,EAAE,OAAO,EAAE,CAAM;gBAEb,MAAM,EAAE,WAAW;IAK/B,cAAc,CAAC,QAAQ,GAAE,OAAO,EAAkB;CAkBnD;AA8PD,wBAAgB,oBAAoB,CAAC,MAAM,KAAA,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAmB1D;AAGD,wBAAgB,aAAa,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAcjD"}