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

package/dist/classic/copy-and-blit.js

@@ -1,192 +1,192 @@
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { assert, Texture, Framebuffer } from '@luma.gl/core';
+import { GL } from '@luma.gl/constants';
 import { getGLTypeFromTypedArray, getTypedArrayFromGLType } from "./typed-array-utils.js";
 import { glFormatToComponents, glTypeToBytes } from "./format-utils.js";
+/**
+ * Copies data from a type  or a Texture object into ArrayBuffer object.
+ * App can provide targetPixelArray or have it auto allocated by this method
+ *  newly allocated by this method unless provided by app.
+ * @deprecated Use CommandEncoder.copyTextureToBuffer and Buffer.read
+ * @note Slow requires roundtrip to GPU
+ *
+ * @param source
+ * @param options
+ * @returns pixel array,
+ */
 export function readPixelsToArray(source, options) {
-  var _framebuffer$colorAtt;
-  const {
-    sourceX = 0,
-    sourceY = 0,
-    sourceFormat = 6408,
-    sourceAttachment = 36064
-  } = options || {};
-  let {
-    target = null,
-    sourceWidth,
-    sourceHeight,
-    sourceType
-  } = options || {};
-  const {
-    framebuffer,
-    deleteFramebuffer
-  } = getFramebuffer(source);
-  assert(framebuffer);
-  const {
-    gl,
-    handle
-  } = framebuffer;
-  sourceWidth = sourceWidth || framebuffer.width;
-  sourceHeight = sourceHeight || framebuffer.height;
-  const attachment = sourceAttachment - 36064;
-  sourceType = sourceType || ((_framebuffer$colorAtt = framebuffer.colorAttachments[attachment]) === null || _framebuffer$colorAtt === void 0 ? void 0 : _framebuffer$colorAtt.type) || 5121;
-  target = getPixelArray(target, sourceType, sourceFormat, sourceWidth, sourceHeight);
-  sourceType = sourceType || getGLTypeFromTypedArray(target);
-  const prevHandle = gl.bindFramebuffer(36160, handle);
-  gl.readPixels(sourceX, sourceY, sourceWidth, sourceHeight, sourceFormat, sourceType, target);
-  gl.bindFramebuffer(36160, prevHandle || null);
-  if (deleteFramebuffer) {
-    framebuffer.destroy();
-  }
-  return target;
+    const { sourceX = 0, sourceY = 0, sourceFormat = GL.RGBA, sourceAttachment = GL.COLOR_ATTACHMENT0 // TODO - support gl.readBuffer
+     } = options || {};
+    let { target = null, 
+    // following parameters are auto deduced if not provided
+    sourceWidth, sourceHeight, sourceType } = options || {};
+    const { framebuffer, deleteFramebuffer } = getFramebuffer(source);
+    assert(framebuffer);
+    const { gl, handle } = framebuffer;
+    sourceWidth = sourceWidth || framebuffer.width;
+    sourceHeight = sourceHeight || framebuffer.height;
+    // TODO - Set and unset gl.readBuffer
+    // if (sourceAttachment === GL.COLOR_ATTACHMENT0 && handle === null) {
+    //   sourceAttachment = GL.FRONT;
+    // }
+    const attachment = sourceAttachment - GL.COLOR_ATTACHMENT0;
+    // assert(attachments[sourceAttachment]);
+    // Deduce the type from color attachment if not provided.
+    sourceType =
+        sourceType ||
+            framebuffer.colorAttachments[attachment]?.texture?.type ||
+            GL.UNSIGNED_BYTE;
+    // Deduce type and allocated pixelArray if needed
+    target = getPixelArray(target, sourceType, sourceFormat, sourceWidth, sourceHeight);
+    // Pixel array available, if necessary, deduce type from it.
+    sourceType = sourceType || getGLTypeFromTypedArray(target);
+    const prevHandle = gl.bindFramebuffer(GL.FRAMEBUFFER, handle);
+    gl.readPixels(sourceX, sourceY, sourceWidth, sourceHeight, sourceFormat, sourceType, target);
+    // @ts-expect-error
+    gl.bindFramebuffer(GL.FRAMEBUFFER, prevHandle || null);
+    if (deleteFramebuffer) {
+        framebuffer.destroy();
+    }
+    return target;
 }
+/**
+ * Copies data from a Framebuffer or a Texture object into a Buffer object.
+ * NOTE: doesn't wait for copy to be complete, it programs GPU to perform a DMA transffer.
+ * @deprecated Use CommandEncoder
+ * @param source
+ * @param options
+ */
 export function readPixelsToBuffer(source, options) {
-  const {
-    target,
-    sourceX = 0,
-    sourceY = 0,
-    sourceFormat = 6408,
-    targetByteOffset = 0
-  } = options || {};
-  let {
-    sourceWidth,
-    sourceHeight,
-    sourceType
-  } = options || {};
-  const {
-    framebuffer,
-    deleteFramebuffer
-  } = getFramebuffer(source);
-  assert(framebuffer);
-  sourceWidth = sourceWidth || framebuffer.width;
-  sourceHeight = sourceHeight || framebuffer.height;
-  const webglFramebuffer = framebuffer;
-  sourceType = sourceType || 5121;
-  let webglBufferTarget = target;
-  if (!webglBufferTarget) {
-    const components = glFormatToComponents(sourceFormat);
-    const byteCount = glTypeToBytes(sourceType);
-    const byteLength = targetByteOffset + sourceWidth * sourceHeight * components * byteCount;
-    webglBufferTarget = webglFramebuffer.device.createBuffer({
-      byteLength
+    const { target, sourceX = 0, sourceY = 0, sourceFormat = GL.RGBA, targetByteOffset = 0 } = options || {};
+    // following parameters are auto deduced if not provided
+    let { sourceWidth, sourceHeight, sourceType } = options || {};
+    const { framebuffer, deleteFramebuffer } = getFramebuffer(source);
+    assert(framebuffer);
+    sourceWidth = sourceWidth || framebuffer.width;
+    sourceHeight = sourceHeight || framebuffer.height;
+    // Asynchronous read (PIXEL_PACK_BUFFER) is WebGL2 only feature
+    const webglFramebuffer = framebuffer;
+    // deduce type if not available.
+    sourceType = sourceType || GL.UNSIGNED_BYTE;
+    let webglBufferTarget = target;
+    if (!webglBufferTarget) {
+        // Create new buffer with enough size
+        const components = glFormatToComponents(sourceFormat);
+        const byteCount = glTypeToBytes(sourceType);
+        const byteLength = targetByteOffset + sourceWidth * sourceHeight * components * byteCount;
+        webglBufferTarget = webglFramebuffer.device.createBuffer({ byteLength });
+    }
+    // TODO(donmccurdy): Do we have tests to confirm this is working?
+    const commandEncoder = source.device.createCommandEncoder();
+    commandEncoder.copyTextureToBuffer({
+        source: source,
+        width: sourceWidth,
+        height: sourceHeight,
+        origin: [sourceX, sourceY],
+        destination: webglBufferTarget,
+        byteOffset: targetByteOffset
     });
-  }
-  const commandEncoder = source.device.createCommandEncoder();
-  commandEncoder.copyTextureToBuffer({
-    source: source,
-    width: sourceWidth,
-    height: sourceHeight,
-    origin: [sourceX, sourceY],
-    destination: webglBufferTarget,
-    byteOffset: targetByteOffset
-  });
-  commandEncoder.destroy();
-  if (deleteFramebuffer) {
-    framebuffer.destroy();
-  }
-  return webglBufferTarget;
+    commandEncoder.destroy();
+    if (deleteFramebuffer) {
+        framebuffer.destroy();
+    }
+    return webglBufferTarget;
 }
+/**
+ * Copy a rectangle from a Framebuffer or Texture object into a texture (at an offset)
+ * @deprecated Use CommandEncoder
+ */
+// eslint-disable-next-line complexity, max-statements
 export function copyToTexture(source, target, options) {
-  const {
-    sourceX = 0,
-    sourceY = 0,
-    targetMipmaplevel = 0,
-    targetInternalFormat = 6408
-  } = options || {};
-  let {
-    targetX,
-    targetY,
-    targetZ,
-    width,
-    height
-  } = options || {};
-  const {
-    framebuffer,
-    deleteFramebuffer
-  } = getFramebuffer(source);
-  assert(framebuffer);
-  const webglFramebuffer = framebuffer;
-  const {
-    device,
-    handle
-  } = webglFramebuffer;
-  const isSubCopy = typeof targetX !== 'undefined' || typeof targetY !== 'undefined' || typeof targetZ !== 'undefined';
-  targetX = targetX || 0;
-  targetY = targetY || 0;
-  targetZ = targetZ || 0;
-  const prevHandle = device.gl.bindFramebuffer(36160, handle);
-  assert(target);
-  let texture = null;
-  let textureTarget;
-  if (target instanceof Texture) {
-    texture = target;
-    width = Number.isFinite(width) ? width : texture.width;
-    height = Number.isFinite(height) ? height : texture.height;
-    texture.bind(0);
-    textureTarget = texture.target;
-  } else {
-    textureTarget = target;
-  }
-  if (!isSubCopy) {
-    device.gl.copyTexImage2D(textureTarget, targetMipmaplevel, targetInternalFormat, sourceX, sourceY, width, height, 0);
-  } else {
-    switch (textureTarget) {
-      case 3553:
-      case 34067:
-        device.gl.copyTexSubImage2D(textureTarget, targetMipmaplevel, targetX, targetY, sourceX, sourceY, width, height);
-        break;
-      case 35866:
-      case 32879:
-        device.assertWebGL2();
-        device.gl2.copyTexSubImage3D(textureTarget, targetMipmaplevel, targetX, targetY, targetZ, sourceX, sourceY, width, height);
-        break;
-      default:
+    const { sourceX = 0, sourceY = 0, 
+    // attachment = GL.COLOR_ATTACHMENT0, // TODO - support gl.readBuffer
+    targetMipmaplevel = 0, targetInternalFormat = GL.RGBA } = options || {};
+    let { targetX, targetY, targetZ, width, // defaults to target width
+    height // defaults to target height
+     } = options || {};
+    const { framebuffer, deleteFramebuffer } = getFramebuffer(source);
+    assert(framebuffer);
+    const webglFramebuffer = framebuffer;
+    const { device, handle } = webglFramebuffer;
+    const isSubCopy = typeof targetX !== 'undefined' ||
+        typeof targetY !== 'undefined' ||
+        typeof targetZ !== 'undefined';
+    targetX = targetX || 0;
+    targetY = targetY || 0;
+    targetZ = targetZ || 0;
+    const prevHandle = device.gl.bindFramebuffer(GL.FRAMEBUFFER, handle);
+    // TODO - support gl.readBuffer (WebGL2 only)
+    // const prevBuffer = gl.readBuffer(attachment);
+    assert(target);
+    let texture = null;
+    let textureTarget;
+    if (target instanceof Texture) {
+        texture = target;
+        width = Number.isFinite(width) ? width : texture.width;
+        height = Number.isFinite(height) ? height : texture.height;
+        texture.bind(0);
+        textureTarget = texture.target;
+    }
+    else {
+        textureTarget = target;
+    }
+    if (!isSubCopy) {
+        device.gl.copyTexImage2D(textureTarget, targetMipmaplevel, targetInternalFormat, sourceX, sourceY, width, height, 0 /* border must be 0 */);
+    }
+    else {
+        switch (textureTarget) {
+            case GL.TEXTURE_2D:
+            case GL.TEXTURE_CUBE_MAP:
+                device.gl.copyTexSubImage2D(textureTarget, targetMipmaplevel, targetX, targetY, sourceX, sourceY, width, height);
+                break;
+            case GL.TEXTURE_2D_ARRAY:
+            case GL.TEXTURE_3D:
+                device.gl.copyTexSubImage3D(textureTarget, targetMipmaplevel, targetX, targetY, targetZ, sourceX, sourceY, width, height);
+                break;
+            default:
+        }
     }
-  }
-  if (texture) {
-    texture.unbind();
-  }
-  device.gl.bindFramebuffer(36160, prevHandle || null);
-  if (deleteFramebuffer) {
-    framebuffer.destroy();
-  }
-  return texture;
+    if (texture) {
+        texture.unbind();
+    }
+    // @ts-expect-error
+    device.gl.bindFramebuffer(GL.FRAMEBUFFER, prevHandle || null);
+    if (deleteFramebuffer) {
+        framebuffer.destroy();
+    }
+    return texture;
 }
 function getFramebuffer(source) {
-  if (!(source instanceof Framebuffer)) {
-    return {
-      framebuffer: toFramebuffer(source),
-      deleteFramebuffer: true
-    };
-  }
-  return {
-    framebuffer: source,
-    deleteFramebuffer: false
-  };
+    if (!(source instanceof Framebuffer)) {
+        return { framebuffer: toFramebuffer(source), deleteFramebuffer: true };
+    }
+    return { framebuffer: source, deleteFramebuffer: false };
 }
+/**
+ * Wraps a given texture into a framebuffer object, that can be further used
+ * to read data from the texture object.
+ */
 export function toFramebuffer(texture, props) {
-  const {
-    device,
-    width,
-    height,
-    id
-  } = texture;
-  const framebuffer = device.createFramebuffer({
-    ...props,
-    id: `framebuffer-for-${id}`,
-    width,
-    height,
-    colorAttachments: [texture]
-  });
-  return framebuffer;
+    const { device, width, height, id } = texture;
+    const framebuffer = device.createFramebuffer({
+        ...props,
+        id: `framebuffer-for-${id}`,
+        width,
+        height,
+        colorAttachments: [texture]
+    });
+    return framebuffer;
 }
 function getPixelArray(pixelArray, type, format, width, height) {
-  if (pixelArray) {
-    return pixelArray;
-  }
-  type = type || 5121;
-  const ArrayType = getTypedArrayFromGLType(type, {
-    clamped: false
-  });
-  const components = glFormatToComponents(format);
-  return new ArrayType(width * height * components);
+    if (pixelArray) {
+        return pixelArray;
+    }
+    // Allocate pixel array if not already available, using supplied type
+    type = type || GL.UNSIGNED_BYTE;
+    const ArrayType = getTypedArrayFromGLType(type, { clamped: false });
+    const components = glFormatToComponents(format);
+    // TODO - check for composite type (components = 1).
+    return new ArrayType(width * height * components);
 }
-//# sourceMappingURL=copy-and-blit.js.map

package/dist/classic/format-utils.d.ts

@@ -1,3 +1,3 @@
-export declare function glFormatToComponents(format: any): 2 | 0 | 1 | 4 | 3;
-export declare function glTypeToBytes(type: any): 2 | 0 | 1 | 4;
+export declare function glFormatToComponents(format: any): 1 | 2 | 3 | 4 | 0;
+export declare function glTypeToBytes(type: any): 1 | 2 | 4 | 0;
 //# sourceMappingURL=format-utils.d.ts.map

package/dist/classic/format-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"format-utils.d.ts","sourceRoot":"","sources":["../../src/classic/format-utils.ts"],"names":[],"mappings":"AAOA,wBAAgB,oBAAoB,CAAC,MAAM,KAAA,qBAoB1C;AAGD,wBAAgB,aAAa,CAAC,IAAI,KAAA,iBAejC"}
+{"version":3,"file":"format-utils.d.ts","sourceRoot":"","sources":["../../src/classic/format-utils.ts"],"names":[],"mappings":"AAQA,wBAAgB,oBAAoB,CAAC,MAAM,KAAA,qBAoB1C;AAGD,wBAAgB,aAAa,CAAC,IAAI,KAAA,iBAejC"}

package/dist/classic/format-utils.js

@@ -1,37 +1,44 @@
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { assert } from '@luma.gl/core';
+import { GL } from '@luma.gl/constants';
+// Returns number of components in a specific readPixels WebGL format
 export function glFormatToComponents(format) {
-  switch (format) {
-    case 6406:
-    case 33326:
-    case 6403:
-      return 1;
-    case 33328:
-    case 33319:
-      return 2;
-    case 6407:
-    case 34837:
-      return 3;
-    case 6408:
-    case 34836:
-      return 4;
-    default:
-      assert(false);
-      return 0;
-  }
+    switch (format) {
+        case GL.ALPHA:
+        case GL.R32F:
+        case GL.RED:
+            return 1;
+        case GL.RG32F:
+        case GL.RG:
+            return 2;
+        case GL.RGB:
+        case GL.RGB32F:
+            return 3;
+        case GL.RGBA:
+        case GL.RGBA32F:
+            return 4;
+        // TODO: Add support for additional WebGL2 formats
+        default:
+            assert(false);
+            return 0;
+    }
 }
+// Return byte count for given readPixels WebGL type
 export function glTypeToBytes(type) {
-  switch (type) {
-    case 5121:
-      return 1;
-    case 33635:
-    case 32819:
-    case 32820:
-      return 2;
-    case 5126:
-      return 4;
-    default:
-      assert(false);
-      return 0;
-  }
+    switch (type) {
+        case GL.UNSIGNED_BYTE:
+            return 1;
+        case GL.UNSIGNED_SHORT_5_6_5:
+        case GL.UNSIGNED_SHORT_4_4_4_4:
+        case GL.UNSIGNED_SHORT_5_5_5_1:
+            return 2;
+        case GL.FLOAT:
+            return 4;
+        // TODO: Add support for additional WebGL2 types
+        default:
+            assert(false);
+            return 0;
+    }
 }
-//# sourceMappingURL=format-utils.js.map

package/dist/classic/typed-array-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typed-array-utils.d.ts","sourceRoot":"","sources":["../../src/classic/typed-array-utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,UAAU,EAAE,qBAAqB,EAAC,MAAM,eAAe,CAAC;AAChE,OAAO,EAAK,UAAU,EAAE,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAI/D;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,UAAU,GAAG,UAAU,CAuB3E;AAED;;;;;;;GAOG;AAEH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,UAAU,GAAG,WAAW,EAChC,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACA,qBAAqB,CAwBvB;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE;IAChC,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,GAAG,IAAI,CAgBP;AAGD,wBAAgB,WAAW,CAAC,OAAO,EAAE;IACnC,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG;IACF,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAaA"}
+{"version":3,"file":"typed-array-utils.d.ts","sourceRoot":"","sources":["../../src/classic/typed-array-utils.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,UAAU,EAAE,qBAAqB,EAAC,MAAM,eAAe,CAAC;AAChE,OAAO,EAAK,UAAU,EAAE,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAI/D;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,UAAU,GAAG,UAAU,CAuB3E;AAED;;;;;;;GAOG;AAEH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,UAAU,GAAG,WAAW,EAChC,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACA,qBAAqB,CAwBvB;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE;IAChC,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,GAAG,IAAI,CAgBP;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE;IAAC,IAAI,EAAE,UAAU,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,GAAG;IACvF,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAaA"}