@luma.gl/webgl 9.0.0-alpha.5 → 9.0.0-alpha.50

package/src/adapter/resources/webgl-command-buffer.ts

@@ -1,12 +1,20 @@
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
+
 import type {
   CopyBufferToBufferOptions,
   CopyBufferToTextureOptions,
   CopyTextureToBufferOptions,
   CopyTextureToTextureOptions
-} from '@luma.gl/api';
-import GL from '@luma.gl/constants';
-import WebGLDevice from '../webgl-device';
-import WEBGLBuffer from './webgl-buffer';
+} from '@luma.gl/core';
+import {CommandBuffer, Texture, Framebuffer} from '@luma.gl/core';
+import {GL} from '@luma.gl/constants';
+
+import {WebGLDevice} from '../webgl-device';
+import {WEBGLBuffer} from './webgl-buffer';
+import {WEBGLTexture} from './webgl-texture';
+import {WEBGLFramebuffer} from './webgl-framebuffer';
+import {getWebGLTextureParameters} from '../converters/texture-formats';
 
 function cast<T>(value: unknown): T {
   return value as T;
@@ -38,25 +46,31 @@ type Command =
   | CopyTextureToBufferCommand
   | CopyTextureToTextureCommand;
 
-export default class CommandBuffer {
+export class WEBGLCommandBuffer extends CommandBuffer {
+  device: WebGLDevice;
   commands: Command[] = [];
-}
 
-export function submitCommands(device: WebGLDevice, commands: Command[] = []) {
-  for (const command of commands) {
-    switch (command.name) {
-      case 'copy-buffer-to-buffer':
-        _copyBufferToBuffer(device, command.options);
-        break;
-      case 'copy-buffer-to-texture':
-        _copyBufferToTexture(device, command.options);
-        break;
-      case 'copy-texture-to-buffer':
-        _copyTextureToBuffer(device, command.options);
-        break;
-      case 'copy-texture-to-texture':
-        _copyTextureToTexture(device, command.options);
-        break;
+  constructor(device: WebGLDevice) {
+    super(device, {});
+    this.device = device;
+  }
+
+  submitCommands(commands: Command[] = this.commands) {
+    for (const command of commands) {
+      switch (command.name) {
+        case 'copy-buffer-to-buffer':
+          _copyBufferToBuffer(this.device, command.options);
+          break;
+        case 'copy-buffer-to-texture':
+          _copyBufferToTexture(this.device, command.options);
+          break;
+        case 'copy-texture-to-buffer':
+          _copyTextureToBuffer(this.device, command.options);
+          break;
+        case 'copy-texture-to-texture':
+          _copyTextureToTexture(this.device, command.options);
+          break;
+      }
     }
   }
 }
@@ -65,7 +79,7 @@ function _copyBufferToBuffer(device: WebGLDevice, options: CopyBufferToBufferOpt
   const source = cast<WEBGLBuffer>(options.source);
   const destination = cast<WEBGLBuffer>(options.destination);
 
-  const {gl2} = device;
+  const gl2 = device.assertWebGL2();
   if (gl2) {
     // In WebGL2 we can perform the copy on the GPU
     // Use GL.COPY_READ_BUFFER+GL.COPY_WRITE_BUFFER avoid disturbing other targets and locking type
@@ -87,8 +101,296 @@ function _copyBufferToBuffer(device: WebGLDevice, options: CopyBufferToBufferOpt
   }
 }
 
-function _copyBufferToTexture(device: WebGLDevice, options: CopyBufferToTextureOptions): void {}
+/**
+ * Copies data from a Buffer object into a Texture object
+ * NOTE: doesn't wait for copy to be complete
+ */
+function _copyBufferToTexture(device: WebGLDevice, options: CopyBufferToTextureOptions): void {
+  throw new Error('Not implemented');
+}
+
+/**
+ * Copies data from a Texture object into a Buffer object.
+ * NOTE: doesn't wait for copy to be complete
+ */
+function _copyTextureToBuffer(device: WebGLDevice, options: CopyTextureToBufferOptions): void {
+  const {
+    /** Texture to copy to/from. */
+    source,
+    /**  Mip-map level of the texture to copy to/from. (Default 0) */
+    mipLevel = 0,
+    /** Defines which aspects of the texture to copy to/from. */
+    aspect = 'all',
+
+    /** Width to copy */
+    width = options.source.width,
+    /** Height to copy */
+    height = options.source.height,
+    depthOrArrayLayers = 0,
+    /** Defines the origin of the copy - the minimum corner of the texture sub-region to copy to/from. */
+    origin = [0, 0],
+
+    /** Destination buffer */
+    destination,
+    /** Offset, in bytes, from the beginning of the buffer to the start of the image data (default 0) */
+    byteOffset = 0,
+    /**
+     * The stride, in bytes, between the beginning of each block row and the subsequent block row.
+     * Required if there are multiple block rows (i.e. the copy height or depth is more than one block).
+     */
+    bytesPerRow,
+    /**
+     * Number of block rows per single image of the texture.
+     * rowsPerImage &times; bytesPerRow is the stride, in bytes, between the beginning of each image of data and the subsequent image.
+     * Required if there are multiple images (i.e. the copy depth is more than one).
+     */
+    rowsPerImage
+  } = options;
+
+  // TODO - Not possible to read just stencil or depth part in WebGL?
+  if (aspect !== 'all') {
+    throw new Error('not supported');
+  }
+
+  // TODO - mipLevels are set when attaching texture to framebuffer
+  if (mipLevel !== 0 || depthOrArrayLayers !== 0 || bytesPerRow || rowsPerImage) {
+    throw new Error('not implemented');
+  }
+
+  // Asynchronous read (PIXEL_PACK_BUFFER) is WebGL2 only feature
+  const gl2 = device.assertWebGL2();
+
+  const {framebuffer, destroyFramebuffer} = getFramebuffer(source);
+  try {
+    const webglBuffer = destination as WEBGLBuffer;
+    const sourceWidth = width || framebuffer.width;
+    const sourceHeight = height || framebuffer.height;
+    const sourceParams = getWebGLTextureParameters(framebuffer.texture.format, true);
+    const sourceFormat = sourceParams.dataFormat;
+    const sourceType = sourceParams.type;
+
+    // if (!target) {
+    //   // Create new buffer with enough size
+    //   const components = glFormatToComponents(sourceFormat);
+    //   const byteCount = glTypeToBytes(sourceType);
+    //   const byteLength = byteOffset + sourceWidth * sourceHeight * components * byteCount;
+    //   target = device.createBuffer({byteLength});
+    // }
+
+    gl2.bindBuffer(GL.PIXEL_PACK_BUFFER, webglBuffer.handle);
+    gl2.bindFramebuffer(GL.FRAMEBUFFER, framebuffer.handle);
+
+    gl2.readPixels(
+      origin[0],
+      origin[1],
+      sourceWidth,
+      sourceHeight,
+      sourceFormat,
+      sourceType,
+      byteOffset
+    );
+  } finally {
+    gl2.bindBuffer(GL.PIXEL_PACK_BUFFER, null);
+    gl2.bindFramebuffer(GL.FRAMEBUFFER, null);
+
+    if (destroyFramebuffer) {
+      framebuffer.destroy();
+    }
+  }
+}
+
+/**
+ * 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 transfer.
+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
+ */
+
+/**
+ * Copy a rectangle from a Framebuffer or Texture object into a texture (at an offset)
+ */
+// eslint-disable-next-line complexity, max-statements
+function _copyTextureToTexture(device: WebGLDevice, options: CopyTextureToTextureOptions): void {
+  const {
+    /** Texture to copy to/from. */
+    source,
+    /**  Mip-map level of the texture to copy to/from. (Default 0) */
+    // mipLevel = 0,
+    /** Defines which aspects of the texture to copy to/from. */
+    // aspect = 'all',
+    /** Defines the origin of the copy - the minimum corner of the texture sub-region to copy to/from. */
+    origin = [0, 0],
+
+    /** Texture to copy to/from. */
+    destination,
+    /**  Mip-map level of the texture to copy to/from. (Default 0) */
+    // destinationMipLevel = options.mipLevel,
+    /** Defines the origin of the copy - the minimum corner of the texture sub-region to copy to/from. */
+    // destinationOrigin = [0, 0],
+    /** Defines which aspects of the texture to copy to/from. */
+    // destinationAspect = options.aspect,
+
+  } = options;
+
+  let {
+    width = options.destination.width,
+    height = options.destination.width,
+    // depthOrArrayLayers = 0
+  } = options;
+
+  const destinationMipmaplevel = 0;
+  const destinationInternalFormat = GL.RGBA;
+
+  const {framebuffer, destroyFramebuffer} = getFramebuffer(source);
+  const [sourceX, sourceY] = origin;
+
+  const isSubCopy = false;
+  // typeof destinationX !== 'undefined' ||
+  // typeof destinationY !== 'undefined' ||
+  // typeof destinationZ !== 'undefined';
+
+  // destinationX = destinationX || 0;
+  // destinationY = destinationY || 0;
+  // destinationZ = destinationZ || 0;
+  device.gl.bindFramebuffer(GL.FRAMEBUFFER, framebuffer.handle);
+  // TODO - support gl.readBuffer (WebGL2 only)
+  // const prevBuffer = gl.readBuffer(attachment);
+
+  let texture = null;
+  let textureTarget: GL;
+  if (destination instanceof WEBGLTexture) {
+    texture = destination;
+    width = Number.isFinite(width) ? width : texture.width;
+    height = Number.isFinite(height) ? height : texture.height;
+    texture.bind(0);
+    textureTarget = texture.destination;
+  } else {
+    throw new Error('whoops');
+    //  textureTarget = destination;
+  }
+
+  if (!isSubCopy) {
+    device.gl.copyTexImage2D(
+      textureTarget,
+      destinationMipmaplevel,
+      destinationInternalFormat,
+      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,
+    //       destinationMipmaplevel,
+    //       destinationX,
+    //       destinationY,
+    //       sourceX,
+    //       sourceY,
+    //       width,
+    //       height
+    //     );
+    //     break;
+    //   case GL.TEXTURE_2D_ARRAY:
+    //   case GL.TEXTURE_3D:
+    //     const gl2 = device.assertWebGL2();
+    //     gl2.copyTexSubImage3D(
+    //       textureTarget,
+    //       destinationMipmaplevel,
+    //       destinationX,
+    //       destinationY,
+    //       destinationZ,
+    //       sourceX,
+    //       sourceY,
+    //       width,
+    //       height
+    //     );
+    //     break;
+    //   default:
+    // }
+  }
+  if (texture) {
+    texture.unbind();
+  }
+  // ts-expect-error
+  // device.gl.bindFramebuffer(GL.FRAMEBUFFER, prevHandle || null);
+  if (destroyFramebuffer) {
+    framebuffer.destroy();
+  }
+  return texture;
+}
+
+// Returns number of components in a specific readPixels WebGL format
+export function glFormatToComponents(format): 1 | 2 | 3 | 4 {
+  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:
+      throw new Error('GLFormat');
+  }
+}
 
-function _copyTextureToBuffer(device: WebGLDevice, options: CopyTextureToBufferOptions): void {}
+// Return byte count for given readPixels WebGL type
+export function glTypeToBytes(type: GL): 1 | 2 | 4 {
+  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:
+      throw new Error('GLType');
+  }
+}
+
+// Helper methods
 
-function _copyTextureToTexture(device: WebGLDevice, options: CopyTextureToTextureOptions): void {}
+function getFramebuffer(source: Texture | Framebuffer): {
+  framebuffer: WEBGLFramebuffer;
+  destroyFramebuffer: boolean;
+} {
+  if (source instanceof Texture) {
+    const {width, height, id} = source;
+    const framebuffer = source.device.createFramebuffer({
+      id: `framebuffer-for-${id}`,
+      width,
+      height,
+      colorAttachments: [source]
+    }) as unknown as WEBGLFramebuffer;
+
+    return {framebuffer, destroyFramebuffer: true};
+  }
+  return {framebuffer: source as unknown as WEBGLFramebuffer, destroyFramebuffer: false};
+}

package/src/adapter/resources/webgl-command-encoder.ts

@@ -1,25 +1,33 @@
-import {CommandEncoder, CommandEncoderProps} from '@luma.gl/api';
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
+
+import {CommandEncoder, CommandEncoderProps} from '@luma.gl/core';
 import type {
   CopyBufferToBufferOptions,
   CopyBufferToTextureOptions,
   CopyTextureToBufferOptions,
   CopyTextureToTextureOptions
-} from '@luma.gl/api';
+} from '@luma.gl/core';
 
-import CommandBuffer from './webgl-command-buffer';
-import WebGLDevice from '../webgl-device';
+import {WEBGLCommandBuffer} from './webgl-command-buffer';
+import {WebGLDevice} from '../webgl-device';
 
-export default class WEBGLCommandEncoder extends CommandEncoder {
+export class WEBGLCommandEncoder extends CommandEncoder {
   readonly device: WebGLDevice;
 
-  readonly commandBuffer = new CommandBuffer();
+  readonly commandBuffer: WEBGLCommandBuffer;
 
   constructor(device: WebGLDevice, props: CommandEncoderProps) {
-    super(props);
+    super(device, props);
     this.device = device;
+    this.commandBuffer = new WEBGLCommandBuffer(device);
   }
 
-  destroy() {}
+  override destroy(): void {}
+
+  override finish(): void {
+    this.commandBuffer.submitCommands();
+  }
 
   // beginRenderPass(GPURenderPassDescriptor descriptor): GPURenderPassEncoder;
   // beginComputePass(optional GPUComputePassDescriptor descriptor = {}): GPUComputePassEncoder;
@@ -41,10 +49,10 @@ export default class WEBGLCommandEncoder extends CommandEncoder {
     this.commandBuffer.commands.push({name: 'copy-texture-to-texture', options});
   }
 
-  pushDebugGroup(groupLabel: string): void {}
-  popDebugGroup() {}
+  override pushDebugGroup(groupLabel: string): void {}
+  override popDebugGroup() {}
 
-  insertDebugMarker(markerLabel: string): void {}
+  override insertDebugMarker(markerLabel: string): void {}
 
   // writeTimestamp(querySet: Query, queryIndex: number): void {}
 
@@ -55,4 +63,4 @@ export default class WEBGLCommandEncoder extends CommandEncoder {
   //   destination: Buffer,
   //   destinationOffset?: number;
   // }): void;
-};
+}

package/src/adapter/resources/webgl-external-texture.ts

@@ -1,5 +1,8 @@
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
+
 /*
-export default class WEBGLExternalTexture extends WEBGLTexture {
+export class WEBGLExternalTexture extends WEBGLTexture {
   readonly device: WebGLDevice;
   readonly gl: WebGLRenderingContext;
   readonly gl2: WebGL2RenderingContext | null;
@@ -53,7 +56,7 @@ export default class WEBGLExternalTexture extends WEBGLTexture {
   constructor(device: Device | WebGLRenderingContext, props: TextureProps) {
     super(WebGLDevice.attach(device), {id: uid('texture'), ...props});
 
-    this.target = getWebGLTextureTarget(props);
+    this.glTarget = getWebGLTextureTarget(props);
 
     this.device = WebGLDevice.attach(device);
     this.gl = this.device.gl;