@luma.gl/webgpu 9.3.0-alpha.4 → 9.3.0-alpha.6

package/src/adapter/helpers/get-bind-group.ts

@@ -4,6 +4,7 @@
 
 import type {ComputeShaderLayout, BindingDeclaration, Binding} from '@luma.gl/core';
 import {Buffer, Sampler, Texture, TextureView, log} from '@luma.gl/core';
+import type {WebGPUDevice} from '../webgpu-device';
 import type {WebGPUBuffer} from '../resources/webgpu-buffer';
 import type {WebGPUSampler} from '../resources/webgpu-sampler';
 import type {WebGPUTexture} from '../resources/webgpu-texture';
@@ -29,21 +30,19 @@ export function makeBindGroupLayout(
  * Create a WebGPU "bind group" from an array of luma.gl bindings
  */
 export function getBindGroup(
-  device: GPUDevice,
+  device: WebGPUDevice,
   bindGroupLayout: GPUBindGroupLayout,
   shaderLayout: ComputeShaderLayout,
   bindings: Record<string, Binding>
 ): GPUBindGroup {
   const entries = getBindGroupEntries(bindings, shaderLayout);
   device.pushErrorScope('validation');
-  const bindGroup = device.createBindGroup({
+  const bindGroup = device.handle.createBindGroup({
     layout: bindGroupLayout,
     entries
   });
-  device.popErrorScope().then((error: GPUError | null) => {
-    if (error) {
-      log.error(`bindGroup creation: ${error.message}`, bindGroup)();
-    }
+  device.popErrorScope((error: GPUError) => {
+    log.error(`bindGroup creation: ${error.message}`, bindGroup)();
   });
   return bindGroup;
 }
@@ -75,28 +74,31 @@ function getBindGroupEntries(
   const entries: GPUBindGroupEntry[] = [];
 
   for (const [bindingName, value] of Object.entries(bindings)) {
-    let bindingLayout = getShaderLayoutBinding(shaderLayout, bindingName);
-    if (bindingLayout) {
-      const entry = getBindGroupEntry(value, bindingLayout.location, undefined, bindingName);
+    const exactBindingLayout = shaderLayout.bindings.find(binding => binding.name === bindingName);
+    const bindingLayout = exactBindingLayout || getShaderLayoutBinding(shaderLayout, bindingName);
+    const isShadowedAlias =
+      !exactBindingLayout && bindingLayout ? bindingLayout.name in bindings : false;
+
+    // Mirror the WebGL path: when both `foo` and `fooUniforms` exist in the bindings map,
+    // prefer the exact shader binding name and ignore the alias entry.
+    if (!isShadowedAlias) {
+      const entry = bindingLayout
+        ? getBindGroupEntry(value, bindingLayout.location, undefined, bindingName)
+        : null;
       if (entry) {
         entries.push(entry);
       }
-    }
 
-    // TODO - hack to automatically bind samplers to supplied texture default samplers
-    if (value instanceof Texture) {
-      bindingLayout = getShaderLayoutBinding(shaderLayout, `${bindingName}Sampler`, {
-        ignoreWarnings: true
-      });
-      if (bindingLayout) {
-        const entry = getBindGroupEntry(
-          value,
-          bindingLayout.location,
-          {sampler: true},
-          bindingName
-        );
-        if (entry) {
-          entries.push(entry);
+      // TODO - hack to automatically bind samplers to supplied texture default samplers
+      if (value instanceof Texture) {
+        const samplerBindingLayout = getShaderLayoutBinding(shaderLayout, `${bindingName}Sampler`, {
+          ignoreWarnings: true
+        });
+        const samplerEntry = samplerBindingLayout
+          ? getBindGroupEntry(value, samplerBindingLayout.location, {sampler: true}, bindingName)
+          : null;
+        if (samplerEntry) {
+          entries.push(samplerEntry);
         }
       }
     }

package/src/adapter/resources/webgpu-buffer.ts

@@ -67,12 +67,27 @@ export class WebGPUBuffer extends Buffer {
       this.device.reportError(new Error(`${this} creation failed ${error.message}`), this)();
       this.device.debug();
     });
+
+    if (!this.props.handle) {
+      this.trackAllocatedMemory(size);
+    } else {
+      this.trackReferencedMemory(size, 'Buffer');
+    }
   }
 
   override destroy(): void {
-    this.handle?.destroy();
-    // @ts-expect-error readonly
-    this.handle = null;
+    if (!this.destroyed && this.handle) {
+      this.removeStats();
+      if (!this.props.handle) {
+        this.trackDeallocatedMemory();
+        this.handle.destroy();
+      } else {
+        this.trackDeallocatedReferencedMemory('Buffer');
+      }
+      this.destroyed = true;
+      // @ts-expect-error readonly
+      this.handle = null;
+    }
   }
 
   write(data: ArrayBufferLike | ArrayBufferView | SharedArrayBuffer, byteOffset = 0) {

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

@@ -13,7 +13,7 @@ export class WebGPUCommandBuffer extends CommandBuffer {
   readonly handle: GPUCommandBuffer;
 
   constructor(commandEncoder: WebGPUCommandEncoder, props: CommandBufferProps) {
-    super(commandEncoder.device, {});
+    super(commandEncoder.device, props);
     this.device = commandEncoder.device;
     this.handle =
       this.props.handle ||

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

@@ -3,6 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 import type {
+  CommandBufferProps,
   RenderPassProps,
   ComputePassProps,
   CopyTextureToTextureOptions,
@@ -34,9 +35,11 @@ export class WebGPUCommandEncoder extends CommandEncoder {
     this.handle.label = this.props.id;
   }
 
-  override destroy(): void {}
+  override destroy(): void {
+    this.destroyResource();
+  }
 
-  finish(props?: CommandEncoderProps): WebGPUCommandBuffer {
+  finish(props?: CommandBufferProps): WebGPUCommandBuffer {
     this.device.pushErrorScope('validation');
     const commandBuffer = new WebGPUCommandBuffer(this, {
       id: props?.id || 'unnamed-command-buffer'
@@ -46,6 +49,7 @@ export class WebGPUCommandEncoder extends CommandEncoder {
       this.device.reportError(new Error(message), this)();
       this.device.debug();
     });
+    this.destroy();
     return commandBuffer;
   }
 
@@ -53,12 +57,12 @@ export class WebGPUCommandEncoder extends CommandEncoder {
    * Allows a render pass to begin against a canvas context
    * @todo need to support a "Framebuffer" equivalent (aka preconfigured RenderPassDescriptors?).
    */
-  beginRenderPass(props: RenderPassProps): WebGPURenderPass {
-    return new WebGPURenderPass(this.device, props);
+  beginRenderPass(props: RenderPassProps = {}): WebGPURenderPass {
+    return new WebGPURenderPass(this.device, this._applyTimeProfilingToPassProps(props));
   }
 
-  beginComputePass(props: ComputePassProps): WebGPUComputePass {
-    return new WebGPUComputePass(this.device, props);
+  beginComputePass(props: ComputePassProps = {}): WebGPUComputePass {
+    return new WebGPUComputePass(this.device, this._applyTimeProfilingToPassProps(props));
   }
 
   // beginRenderPass(GPURenderPassDescriptor descriptor): GPURenderPassEncoder;
@@ -174,6 +178,28 @@ export class WebGPUCommandEncoder extends CommandEncoder {
       options?.destinationOffset || 0
     );
   }
+
+  writeTimestamp(querySet: WebGPUQuerySet, queryIndex: number): void {
+    querySet._invalidateResults();
+    const writeTimestamp = (
+      this.handle as GPUCommandEncoder & {
+        writeTimestamp?: (querySet: GPUQuerySet, queryIndex: number) => void;
+      }
+    ).writeTimestamp;
+
+    if (writeTimestamp) {
+      writeTimestamp.call(this.handle, querySet.handle, queryIndex);
+      return;
+    }
+
+    const computePass = this.handle.beginComputePass({
+      timestampWrites: {
+        querySet: querySet.handle,
+        beginningOfPassWriteIndex: queryIndex
+      }
+    });
+    computePass.end();
+  }
 }
 
 /*

package/src/adapter/resources/webgpu-compute-pass.ts

@@ -14,19 +14,21 @@ export class WebGPUComputePass extends ComputePass {
 
   _webgpuPipeline: WebGPUComputePipeline | null = null;
 
-  constructor(device: WebGPUDevice, props: ComputePassProps) {
+  constructor(device: WebGPUDevice, props: ComputePassProps = {}) {
     super(device, props);
     this.device = device;
+    const {props: computePassProps} = this;
 
     // Set up queries
     let timestampWrites: GPUComputePassTimestampWrites | undefined;
-    if (device.features.has('timestamp-query')) {
-      const webgpuQuerySet = props.timestampQuerySet as WebGPUQuerySet;
+    if (computePassProps.timestampQuerySet) {
+      const webgpuQuerySet = computePassProps.timestampQuerySet as WebGPUQuerySet;
       if (webgpuQuerySet) {
+        webgpuQuerySet._invalidateResults();
         timestampWrites = {
           querySet: webgpuQuerySet.handle,
-          beginningOfPassWriteIndex: props.beginTimestampIndex,
-          endOfPassWriteIndex: props.endTimestampIndex
+          beginningOfPassWriteIndex: computePassProps.beginTimestampIndex,
+          endOfPassWriteIndex: computePassProps.endTimestampIndex
         };
       }
     }
@@ -40,10 +42,16 @@ export class WebGPUComputePass extends ComputePass {
   }
 
   /** @note no WebGPU destroy method, just gc */
-  override destroy(): void {}
+  override destroy(): void {
+    this.destroyResource();
+  }
 
   end(): void {
+    if (this.destroyed) {
+      return;
+    }
     this.handle.end();
+    this.destroy();
   }
 
   setPipeline(pipeline: ComputePipeline): void {

package/src/adapter/resources/webgpu-compute-pipeline.ts

@@ -7,6 +7,8 @@ import {getBindGroup} from '../helpers/get-bind-group';
 import {WebGPUDevice} from '../webgpu-device';
 import {WebGPUShader} from './webgpu-shader';
 
+const EMPTY_BINDINGS: Record<string, Binding> = {};
+
 // COMPUTE PIPELINE
 
 /** Creates a new compute pipeline when parameters change */
@@ -18,7 +20,7 @@ export class WebGPUComputePipeline extends ComputePipeline {
   private _bindGroupLayout: GPUBindGroupLayout | null = null;
   private _bindGroup: GPUBindGroup | null = null;
   /** For internal use to create BindGroups */
-  private _bindings: Record<string, Binding> = {};
+  private _bindings: Record<string, Binding>;
 
   constructor(device: WebGPUDevice, props: ComputePipelineProps) {
     super(device, props);
@@ -37,6 +39,8 @@ export class WebGPUComputePipeline extends ComputePipeline {
         },
         layout: 'auto'
       });
+
+    this._bindings = EMPTY_BINDINGS;
   }
 
   /**
@@ -44,7 +48,21 @@ export class WebGPUComputePipeline extends ComputePipeline {
    * @todo Do we want to expose BindGroups in the API and remove this?
    */
   setBindings(bindings: Record<string, Binding>): void {
-    Object.assign(this._bindings, bindings);
+    let bindingsChanged = false;
+    for (const [name, binding] of Object.entries(bindings)) {
+      if (this._bindings[name] !== binding) {
+        if (!bindingsChanged) {
+          if (this._bindings === EMPTY_BINDINGS) {
+            this._bindings = {};
+          }
+          bindingsChanged = true;
+        }
+        this._bindings[name] = binding;
+      }
+    }
+    if (bindingsChanged) {
+      this._bindGroup = null;
+    }
   }
 
   /** Return a bind group created by setBindings */
@@ -55,7 +73,7 @@ export class WebGPUComputePipeline extends ComputePipeline {
     // Set up the bindings
     this._bindGroup =
       this._bindGroup ||
-      getBindGroup(this.device.handle, this._bindGroupLayout, this.shaderLayout, this._bindings);
+      getBindGroup(this.device, this._bindGroupLayout, this.shaderLayout, this._bindings);
 
     return this._bindGroup;
   }

package/src/adapter/resources/webgpu-framebuffer.ts

@@ -29,4 +29,25 @@ export class WebGPUFramebuffer extends Framebuffer {
   protected updateAttachments(): void {
     // WebGPU framebuffers are JS only objects, nothing to update
   }
+
+  /**
+   * Internal-only hook for the cached CanvasContext/PresentationContext swapchain path.
+   * Rebinds the long-lived default framebuffer wrapper to the current per-frame color view
+   * and optional depth attachment without allocating a new luma.gl Framebuffer object.
+   */
+  _reinitialize(
+    colorAttachment: WebGPUTextureView,
+    depthStencilAttachment: WebGPUTextureView | null
+  ): void {
+    this.colorAttachments[0] = colorAttachment;
+    // @ts-expect-error Internal-only canvas wrapper reuse mutates this otherwise-readonly attachment.
+    this.depthStencilAttachment = depthStencilAttachment;
+    this.width = colorAttachment.texture.width;
+    this.height = colorAttachment.texture.height;
+
+    this.props.width = this.width;
+    this.props.height = this.height;
+    this.props.colorAttachments = [colorAttachment.texture];
+    this.props.depthStencilAttachment = depthStencilAttachment?.texture || null;
+  }
 }

package/src/adapter/resources/webgpu-query-set.ts

@@ -2,13 +2,13 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {QuerySet, QuerySetProps} from '@luma.gl/core';
+import {Buffer, QuerySet, QuerySetProps} from '@luma.gl/core';
 import {WebGPUDevice} from '../webgpu-device';
-
-export type QuerySetProps2 = {
-  type: 'occlusion' | 'timestamp';
-  count: number;
-};
+import {WebGPUBuffer} from './webgpu-buffer';
+import {
+  getCpuHotspotSubmitReason,
+  setCpuHotspotSubmitReason
+} from '../helpers/cpu-hotspot-profiler';
 
 /**
  * Immutable
@@ -17,6 +17,12 @@ export class WebGPUQuerySet extends QuerySet {
   readonly device: WebGPUDevice;
   readonly handle: GPUQuerySet;
 
+  protected _resolveBuffer: WebGPUBuffer | null = null;
+  protected _readBuffer: WebGPUBuffer | null = null;
+  protected _cachedResults: bigint[] | null = null;
+  protected _readResultsPromise: Promise<bigint[]> | null = null;
+  protected _resultsPendingResolution: boolean = false;
+
   constructor(device: WebGPUDevice, props: QuerySetProps) {
     super(device, props);
     this.device = device;
@@ -30,8 +36,178 @@ export class WebGPUQuerySet extends QuerySet {
   }
 
   override destroy(): void {
-    this.handle?.destroy();
-    // @ts-expect-error readonly
-    this.handle = null;
+    if (!this.destroyed) {
+      this.handle?.destroy();
+      this.destroyResource();
+      // @ts-expect-error readonly
+      this.handle = null;
+    }
+  }
+
+  isResultAvailable(queryIndex?: number): boolean {
+    if (!this._cachedResults) {
+      return false;
+    }
+
+    return queryIndex === undefined
+      ? true
+      : queryIndex >= 0 && queryIndex < this._cachedResults.length;
+  }
+
+  async readResults(options?: {firstQuery?: number; queryCount?: number}): Promise<bigint[]> {
+    const firstQuery = options?.firstQuery || 0;
+    const queryCount = options?.queryCount || this.props.count - firstQuery;
+
+    if (firstQuery < 0 || queryCount < 0 || firstQuery + queryCount > this.props.count) {
+      throw new Error('Query read range is out of bounds');
+    }
+
+    let needsFreshResults = true;
+    while (needsFreshResults) {
+      if (!this._readResultsPromise) {
+        this._readResultsPromise = this._readAllResults();
+      }
+
+      const readResultsPromise = this._readResultsPromise;
+      const results = await readResultsPromise;
+
+      // A later submit may have invalidated the query set while this read was in flight.
+      // Retry so each caller observes the freshest resolved results instead of stale data.
+      needsFreshResults = this._resultsPendingResolution;
+      if (!needsFreshResults) {
+        return results.slice(firstQuery, firstQuery + queryCount);
+      }
+    }
+
+    throw new Error('Query read unexpectedly failed to resolve');
+  }
+
+  async readTimestampDuration(beginIndex: number, endIndex: number): Promise<number> {
+    if (this.props.type !== 'timestamp') {
+      throw new Error('Timestamp durations require a timestamp QuerySet');
+    }
+    if (beginIndex < 0 || endIndex <= beginIndex || endIndex >= this.props.count) {
+      throw new Error('Timestamp duration range is out of bounds');
+    }
+
+    const results = await this.readResults({
+      firstQuery: beginIndex,
+      queryCount: endIndex - beginIndex + 1
+    });
+    return Number(results[results.length - 1] - results[0]) / 1e6;
+  }
+
+  /** Marks any cached query results as stale after new writes have been encoded. */
+  _invalidateResults(): void {
+    this._cachedResults = null;
+    this._resultsPendingResolution = true;
+  }
+
+  protected async _readAllResults(): Promise<bigint[]> {
+    this._ensureBuffers();
+
+    try {
+      // Use a dedicated encoder so async profiling reads cannot flush or replace the
+      // device's active frame encoder while application rendering is in flight.
+      if (this._resultsPendingResolution) {
+        const commandEncoder = this.device.createCommandEncoder({
+          id: `${this.id}-read-results`
+        });
+        commandEncoder.resolveQuerySet(this, this._resolveBuffer!);
+        commandEncoder.copyBufferToBuffer({
+          sourceBuffer: this._resolveBuffer!,
+          destinationBuffer: this._readBuffer!,
+          size: this._resolveBuffer!.byteLength
+        });
+        const commandBuffer = commandEncoder.finish({
+          id: `${this.id}-read-results-command-buffer`
+        });
+        const previousSubmitReason = getCpuHotspotSubmitReason(this.device) || undefined;
+        setCpuHotspotSubmitReason(this.device, 'query-readback');
+        try {
+          this.device.submit(commandBuffer);
+        } finally {
+          setCpuHotspotSubmitReason(this.device, previousSubmitReason);
+        }
+      }
+
+      const data = await this._readBuffer!.readAsync(0, this._readBuffer!.byteLength);
+      const resultView = new BigUint64Array(data.buffer, data.byteOffset, this.props.count);
+      this._cachedResults = Array.from(resultView, value => value);
+      this._resultsPendingResolution = false;
+      return this._cachedResults;
+    } finally {
+      this._readResultsPromise = null;
+    }
+  }
+
+  protected _ensureBuffers(): void {
+    if (this._resolveBuffer && this._readBuffer) {
+      return;
+    }
+
+    const byteLength = this.props.count * 8;
+    this._resolveBuffer = this.device.createBuffer({
+      id: `${this.id}-resolve-buffer`,
+      usage: Buffer.QUERY_RESOLVE | Buffer.COPY_SRC,
+      byteLength
+    });
+    this.attachResource(this._resolveBuffer);
+
+    this._readBuffer = this.device.createBuffer({
+      id: `${this.id}-read-buffer`,
+      usage: Buffer.COPY_DST | Buffer.MAP_READ,
+      byteLength
+    });
+    this.attachResource(this._readBuffer);
+  }
+
+  _encodeResolveToReadBuffer(
+    commandEncoder: {
+      resolveQuerySet: (
+        querySet: WebGPUQuerySet,
+        destination: WebGPUBuffer,
+        options?: {firstQuery?: number; queryCount?: number; destinationOffset?: number}
+      ) => void;
+      copyBufferToBuffer: (options: {
+        sourceBuffer: WebGPUBuffer;
+        destinationBuffer: WebGPUBuffer;
+        sourceOffset?: number;
+        destinationOffset?: number;
+        size?: number;
+      }) => void;
+    },
+    options?: {firstQuery?: number; queryCount?: number}
+  ): boolean {
+    if (!this._resultsPendingResolution) {
+      return false;
+    }
+
+    // If a readback is already mapping the shared read buffer, defer to the fallback read path.
+    // That path will submit resolve/copy commands once the current read has completed.
+    if (this._readResultsPromise) {
+      return false;
+    }
+
+    this._ensureBuffers();
+    const firstQuery = options?.firstQuery || 0;
+    const queryCount = options?.queryCount || this.props.count - firstQuery;
+    const byteLength = queryCount * BigUint64Array.BYTES_PER_ELEMENT;
+    const byteOffset = firstQuery * BigUint64Array.BYTES_PER_ELEMENT;
+
+    commandEncoder.resolveQuerySet(this, this._resolveBuffer!, {
+      firstQuery,
+      queryCount,
+      destinationOffset: byteOffset
+    });
+    commandEncoder.copyBufferToBuffer({
+      sourceBuffer: this._resolveBuffer!,
+      sourceOffset: byteOffset,
+      destinationBuffer: this._readBuffer!,
+      destinationOffset: byteOffset,
+      size: byteLength
+    });
+    this._resultsPendingResolution = false;
+    return true;
   }
 }