@luma.gl/webgl 8.5.10 → 8.6.0-alpha.1

package/src/classes/{copy-and-blit.js → copy-and-blit.ts}

@@ -1,13 +1,34 @@
+// @ts-nocheck
 import GL from '@luma.gl/constants';
-import Buffer from './buffer';
+import Buffer from './webgl-buffer';
 import Framebuffer from './framebuffer';
 import Texture from './texture';
 import {assertWebGL2Context, withParameters, log} from '@luma.gl/gltools';
-import {flipRows, scalePixels} from '../webgl-utils/typed-array-utils';
+import {flipRows, scalePixels} from '../webgl-utils';
 import {getTypedArrayFromGLType, getGLTypeFromTypedArray} from '../webgl-utils/typed-array-utils';
 import {glFormatToComponents, glTypeToBytes} from '../webgl-utils/format-utils';
 import {toFramebuffer} from '../webgl-utils/texture-utils';
-import {assert} from '../utils/assert';
+import {assert} from '../utils';
+
+// NOTE: Slow requires roundtrip to GPU
+// Copies data from a Framebuffer or a Texture object into ArrayBuffer object.
+// App can provide targetPixelArray or have it auto allocated by this method
+// @returns {Uint8Array|Uint16Array|FloatArray} - pixel array,
+//  newly allocated by this method unless provided by app.
+export function readPixelsToArray(
+  source: Framebuffer | Texture,
+  options?: {
+    sourceX?: number;
+    sourceY?: number;
+    sourceFormat?: number;
+    sourceAttachment?: number;
+    target?: Uint8Array | Uint16Array | Float32Array;
+    // following parameters are auto deduced if not provided
+    sourceWidth?: number;
+    sourceHeight?: number;
+    sourceType?: number;
+  }
+): Uint8Array | Uint16Array | Float32Array;
 
 // NOTE: Slow requires roundtrip to GPU
 // Copies data from a Framebuffer or a Texture object into ArrayBuffer object.
@@ -57,6 +78,23 @@ export function readPixelsToArray(source, options = {}) {
   return target;
 }
 
+// NOTE: doesn't wait for copy to be complete, it programs GPU to perform a DMA transffer.
+// Copies data from a Framebuffer or a Texture object into a Buffer object.
+export function readPixelsToBuffer(
+  source: Framebuffer | Texture,
+  options?: {
+    sourceX?: number;
+    sourceY?: number;
+    sourceFormat?: number;
+    target?: Buffer; // A new Buffer object is created when not provided.
+    targetByteOffset?: number; // byte offset in buffer object
+    // following parameters are auto deduced if not provided
+    sourceWidth?: number;
+    sourceHeight?: number;
+    sourceType?: number;
+  }
+): Buffer;
+
 // NOTE: doesn't wait for copy to be complete, it programs GPU to perform a DMA transffer.
 // Copies data from a Framebuffer or a Texture object into a Buffer object.
 export function readPixelsToBuffer(
@@ -89,10 +127,12 @@ export function readPixelsToBuffer(
     const components = glFormatToComponents(sourceFormat);
     const byteCount = glTypeToBytes(sourceType);
     const byteLength = targetByteOffset + sourceWidth * sourceHeight * components * byteCount;
+    // @ts-expect-error TODO why is WebGL2 context not compatible
     target = new Buffer(gl2, {byteLength, accessor: {type: sourceType, size: components}});
   }
 
   target.bind({target: GL.PIXEL_PACK_BUFFER});
+  // @ts-expect-error TODO why is WebGL2 context not compatible
   withParameters(gl2, {framebuffer}, () => {
     gl2.readPixels(
       sourceX,
@@ -112,6 +152,15 @@ export function readPixelsToBuffer(
   return target;
 }
 
+// Reads pixels from a Framebuffer or Texture object to a dataUrl
+export function copyToDataUrl(
+  source,
+  options?: {
+    sourceAttachment?: number; // TODO - support gl.readBuffer
+    targetMaxHeight?: number;
+  }
+): string;
+
 // Reads pixels from a Framebuffer or Texture object to a dataUrl
 export function copyToDataUrl(
   source,
@@ -144,23 +193,43 @@ export function copyToDataUrl(
   return canvas.toDataURL();
 }
 
+// Reads pixels from a Framebuffer or Texture object into an HTML Image
 // Reads pixels from a Framebuffer or Texture object into an HTML Image
 export function copyToImage(
-  source,
-  {
-    sourceAttachment = GL.COLOR_ATTACHMENT0, // TODO - support gl.readBuffer
-    targetImage = null
-  } = {}
-) {
-  const dataUrl = copyToDataUrl(source, {sourceAttachment});
-  targetImage = targetImage || new Image();
+  source: Framebuffer | Texture,
+  options?: {
+    sourceAttachment?: number; // TODO - support gl.readBuffer
+    targetImage?: typeof Image;
+  }
+): typeof Image {
+  const dataUrl = copyToDataUrl(source, {sourceAttachment: options?.sourceAttachment || GL.COLOR_ATTACHMENT0});
+  const targetImage = options?.targetImage || new Image();
   targetImage.src = dataUrl;
+  // @ts-expect-error
   return targetImage;
 }
 
-// Copy a rectangle from a Framebuffer or Texture object into a texture (at an offset)
+/**
+ * Copy a rectangle from a Framebuffer or Texture object into a texture (at an offset)
+ */
 // eslint-disable-next-line complexity, max-statements
-export function copyToTexture(source, target, options = {}) {
+export function copyToTexture(
+  source: Framebuffer | Texture,
+  target: Texture,
+  options?: {
+    sourceX?: number;
+    sourceY?: number;
+
+    targetX?: number;
+    targetY?: number;
+    targetZ?: number;
+    targetMipmaplevel?: number;
+    targetInternalFormat?: number;
+
+    width?: number; // defaults to target width
+    height?: number; // defaults to target height
+  }
+): Texture {
   const {
     sourceX = 0,
     sourceY = 0,
@@ -254,10 +323,34 @@ export function copyToTexture(source, target, options = {}) {
   return texture;
 }
 
-// NOTE: WEBLG2 only
-// Copies a rectangle of pixels between Framebuffer or Texture objects
+/**
+ * Copies a rectangle of pixels between Framebuffer or Texture objects
+ * @note NOTE: WEBLG2 only
+ * @param source
+ * @param target
+ * @param options
+ */
 // eslint-disable-next-line max-statements, complexity
-export function blit(source, target, options = {}) {
+export function blit(
+  source,
+  target,
+  options: {
+    sourceAttachment?: number;
+    sourceX0?: number;
+    sourceY0?: number;
+    sourceX1?: number;
+    sourceY1?: number;
+    targetX0?: number;
+    targetY0?: number;
+    targetX1?: number;
+    targetY1?: number;
+    color?: boolean;
+    depth?: boolean;
+    stencil?: boolean;
+    mask?: number;
+    filter?: number;
+  }
+): void {
   const {
     sourceX0 = 0,
     sourceY0 = 0,
@@ -278,12 +371,10 @@ export function blit(source, target, options = {}) {
     mask = 0
   } = options;
 
-  const {framebuffer: srcFramebuffer, deleteFramebuffer: deleteSrcFramebuffer} = getFramebuffer(
-    source
-  );
-  const {framebuffer: dstFramebuffer, deleteFramebuffer: deleteDstFramebuffer} = getFramebuffer(
-    target
-  );
+  const {framebuffer: srcFramebuffer, deleteFramebuffer: deleteSrcFramebuffer} =
+    getFramebuffer(source);
+  const {framebuffer: dstFramebuffer, deleteFramebuffer: deleteDstFramebuffer} =
+    getFramebuffer(target);
 
   assert(srcFramebuffer);
   assert(dstFramebuffer);