@luma.gl/webgpu 9.3.0-alpha.8 → 9.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luma.gl/webgpu",
-  "version": "9.3.0-alpha.8",
+  "version": "9.3.0",
   "description": "WebGPU adapter for the luma.gl core API",
   "type": "module",
   "license": "MIT",
@@ -44,5 +44,5 @@
     "@webgpu/types": "^0.1.69",
     "wgsl_reflect": "^1.2.3"
   },
-  "gitHead": "371f0979c1cd01563badc36118f314365a66e1a1"
+  "gitHead": "c5e44faacd07b315a8622b5927e724f15a3d40ae"
 }

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

@@ -2,7 +2,13 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {Binding, Bindings, ComputeShaderLayout, ShaderLayout} from '@luma.gl/core';
+import type {
+  Binding,
+  BindingDeclaration,
+  Bindings,
+  ComputeShaderLayout,
+  ShaderLayout
+} from '@luma.gl/core';
 import {Buffer, Sampler, Texture, TextureView, getShaderLayoutBinding, log} from '@luma.gl/core';
 import type {WebGPUDevice} from '../webgpu-device';
 import type {WebGPUBuffer} from '../resources/webgpu-buffer';
@@ -10,6 +16,13 @@ import type {WebGPUSampler} from '../resources/webgpu-sampler';
 import type {WebGPUTexture} from '../resources/webgpu-texture';
 import type {WebGPUTextureView} from '../resources/webgpu-texture-view';
 
+type AnyShaderLayout = ShaderLayout | ComputeShaderLayout;
+type BindGroupBindingSummary = {
+  name: string;
+  location: number;
+  type: string;
+};
+
 /**
  * Create a WebGPU "bind group layout" from an array of luma.gl bindings
  * @note bind groups can be automatically generated by WebGPU.
@@ -34,7 +47,8 @@ export function getBindGroup(
   bindGroupLayout: GPUBindGroupLayout,
   shaderLayout: ShaderLayout | ComputeShaderLayout,
   bindings: Bindings,
-  group: number
+  group: number,
+  label?: string
 ): GPUBindGroup | null {
   const entries = getBindGroupEntries(bindings, shaderLayout, group);
   if (entries.length === 0) {
@@ -42,35 +56,93 @@ export function getBindGroup(
   }
   device.pushErrorScope('validation');
   const bindGroup = device.handle.createBindGroup({
+    label,
     layout: bindGroupLayout,
     entries
   });
   device.popErrorScope((error: GPUError) => {
-    log.error(`bindGroup creation: ${error.message}`, bindGroup)();
+    const summary = formatBindGroupCreationErrorSummary(shaderLayout, bindings, entries, group);
+    log.error(`bindGroup creation: ${summary}\nRaw WebGPU error: ${error.message}`, bindGroup)();
   });
   return bindGroup;
 }
 
+export function formatBindGroupCreationErrorSummary(
+  shaderLayout: AnyShaderLayout,
+  bindings: Bindings,
+  entries: GPUBindGroupEntry[],
+  group: number
+): string {
+  const expectedBindings = getExpectedBindingsForGroup(shaderLayout, group);
+  const expectedByLocation = new Map(
+    expectedBindings.map(bindingSummary => [bindingSummary.location, bindingSummary])
+  );
+  const providedBindings = entries
+    .map(entry => expectedByLocation.get(entry.binding) || getUnexpectedEntrySummary(entry))
+    .sort(compareBindingSummaries);
+  const missingBindings = expectedBindings.filter(
+    bindingSummary =>
+      !providedBindings.some(provided => provided.location === bindingSummary.location)
+  );
+  const unexpectedBindings = providedBindings.filter(
+    bindingSummary => !expectedByLocation.has(bindingSummary.location)
+  );
+  const unmatchedLogicalBindings = Object.keys(bindings)
+    .filter(bindingName => !resolveGroupBinding(bindingName, bindings, shaderLayout, group))
+    .sort();
+
+  const lines = [
+    `bindGroup creation failed for group ${group}: expected ${expectedBindings.length}, provided ${providedBindings.length}`,
+    `expected: ${formatBindingSummaryList(expectedBindings)}`,
+    `provided: ${formatBindingSummaryList(providedBindings)}`
+  ];
+
+  if (missingBindings.length > 0) {
+    lines.push(`missing: ${formatBindingSummaryList(missingBindings)}`);
+  }
+  if (unexpectedBindings.length > 0) {
+    lines.push(`unexpected entries: ${formatBindingSummaryList(unexpectedBindings)}`);
+  }
+  if (unmatchedLogicalBindings.length > 0) {
+    lines.push(`unmatched logical bindings: ${unmatchedLogicalBindings.join(', ')}`);
+  }
+
+  return lines.join('\n');
+}
+
+export function getBindGroupLabel(
+  pipelineId: string,
+  shaderLayout: AnyShaderLayout,
+  group: number
+): string {
+  const expectedBindings = getExpectedBindingsForGroup(shaderLayout, group);
+  const bindingSuffix =
+    expectedBindings.length > 0 ? expectedBindings.map(binding => binding.name).join(',') : 'empty';
+  return `${pipelineId}/group${group}[${bindingSuffix}]`;
+}
+
 /**
  * @param bindings
  * @returns
  */
 function getBindGroupEntries(
   bindings: Bindings,
-  shaderLayout: ShaderLayout | ComputeShaderLayout,
+  shaderLayout: AnyShaderLayout,
   group: number
 ): GPUBindGroupEntry[] {
   const entries: GPUBindGroupEntry[] = [];
 
   for (const [bindingName, value] of Object.entries(bindings)) {
-    const exactBindingLayout = shaderLayout.bindings.find(binding => binding.name === bindingName);
-    const bindingLayout = exactBindingLayout || getShaderLayoutBinding(shaderLayout, bindingName);
-    const isShadowedAlias =
-      !exactBindingLayout && bindingLayout ? bindingLayout.name in bindings : false;
+    const {bindingLayout, isShadowedAlias} = resolveGroupBinding(
+      bindingName,
+      bindings,
+      shaderLayout,
+      group
+    ) || {bindingLayout: null, isShadowedAlias: 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 && bindingLayout?.group === group) {
+    if (!isShadowedAlias && bindingLayout) {
       const entry = bindingLayout
         ? getBindGroupEntry(value, bindingLayout.location, undefined, bindingName)
         : null;
@@ -139,3 +211,65 @@ function getBindGroupEntry(
   log.warn(`invalid binding ${bindingName}`, binding);
   return null;
 }
+
+function getExpectedBindingsForGroup(
+  shaderLayout: AnyShaderLayout,
+  group: number
+): BindGroupBindingSummary[] {
+  return shaderLayout.bindings
+    .filter(bindingLayout => bindingLayout.group === group)
+    .map(bindingLayout => toBindingSummary(bindingLayout))
+    .sort(compareBindingSummaries);
+}
+
+function resolveGroupBinding(
+  bindingName: string,
+  bindings: Bindings,
+  shaderLayout: AnyShaderLayout,
+  group: number
+): {bindingLayout: BindingDeclaration; isShadowedAlias: boolean} | null {
+  const exactBindingLayout = shaderLayout.bindings.find(binding => binding.name === bindingName);
+  const bindingLayout =
+    exactBindingLayout || getShaderLayoutBinding(shaderLayout, bindingName, {ignoreWarnings: true});
+  const isShadowedAlias =
+    !exactBindingLayout && bindingLayout ? bindingLayout.name in bindings : false;
+
+  if (isShadowedAlias || !bindingLayout || bindingLayout.group !== group) {
+    return null;
+  }
+
+  return {bindingLayout, isShadowedAlias};
+}
+
+function toBindingSummary(bindingLayout: BindingDeclaration): BindGroupBindingSummary {
+  return {
+    name: bindingLayout.name,
+    location: bindingLayout.location,
+    type: bindingLayout.type
+  };
+}
+
+function getUnexpectedEntrySummary(entry: GPUBindGroupEntry): BindGroupBindingSummary {
+  return {
+    name: '?',
+    location: entry.binding,
+    type: 'unknown'
+  };
+}
+
+function compareBindingSummaries(
+  left: BindGroupBindingSummary,
+  right: BindGroupBindingSummary
+): number {
+  if (left.location !== right.location) {
+    return left.location - right.location;
+  }
+  return left.name.localeCompare(right.name);
+}
+
+function formatBindingSummaryList(bindings: BindGroupBindingSummary[]): string {
+  if (bindings.length === 0) {
+    return 'none';
+  }
+  return bindings.map(binding => `${binding.name}@${binding.location}`).join(', ');
+}

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

@@ -56,12 +56,14 @@ export class WebGPURenderPipeline extends RenderPipeline {
       this.device.pushErrorScope('validation');
       this.handle = this.device.handle.createRenderPipeline(descriptor);
       this.device.popErrorScope((error: GPUError) => {
+        this.linkStatus = 'error';
         this.device.reportError(new Error(`${this} creation failed:\n"${error.message}"`), this)();
         this.device.debug();
       });
     }
     this.descriptor = descriptor;
     this.handle.label = this.props.id;
+    this.linkStatus = 'success';
 
     // Note: Often the same shader in WebGPU
     this.vs = props.vs as WebGPUShader;
@@ -117,6 +119,11 @@ export class WebGPURenderPipeline extends RenderPipeline {
     _bindGroupCacheKeys?: Partial<Record<number, object>>;
     uniforms?: Record<string, unknown>;
   }): boolean {
+    if (this.isErrored) {
+      log.info(2, `RenderPipeline:${this.id}.draw() aborted - pipeline initialization failed`)();
+      return false;
+    }
+
     const webgpuRenderPass = options.renderPass as WebGPURenderPass;
     const instanceCount =
       options.instanceCount && options.instanceCount > 0 ? options.instanceCount : 1;

package/src/adapter/webgpu-adapter.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-// prettier-ignore
+// biome-ignore format: preserve layout
 // / <reference types="@webgpu/types" />
 
 import {Adapter, DeviceProps, log} from '@luma.gl/core';

package/src/adapter/webgpu-canvas-context.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-// prettier-ignore
+// biome-ignore format: preserve layout
 // / <reference types="@webgpu/types" />
 
 import type {TextureFormatDepthStencil, CanvasContextProps} from '@luma.gl/core';

package/src/adapter/webgpu-device.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-// prettier-ignore
+// biome-ignore format: preserve layout
 // / <reference types="@webgpu/types" />
 
 import type {
@@ -128,10 +128,9 @@ export class WebGPUDevice extends Device {
     });
 
     // "Context" loss handling
-    this.lost = new Promise<{reason: 'destroyed'; message: string}>(async resolve => {
-      const lostInfo = await this.handle.lost;
+    this.lost = this.handle.lost.then(lostInfo => {
       this._isLost = true;
-      resolve({reason: 'destroyed', message: lostInfo.message});
+      return {reason: 'destroyed', message: lostInfo.message};
     });
 
     // Note: WebGPU devices can be created without a canvas, for compute shader purposes
@@ -259,16 +258,25 @@ export class WebGPUDevice extends Device {
     bindGroupLayout: unknown,
     shaderLayout: ShaderLayout | ComputeShaderLayout,
     bindings: Bindings,
-    group: number
+    group: number,
+    label?: string
   ): GPUBindGroup | null {
     if (Object.keys(bindings).length === 0) {
       return this.handle.createBindGroup({
+        label,
         layout: bindGroupLayout as GPUBindGroupLayout,
         entries: []
       });
     }
 
-    return getBindGroup(this, bindGroupLayout as GPUBindGroupLayout, shaderLayout, bindings, group);
+    return getBindGroup(
+      this,
+      bindGroupLayout as GPUBindGroupLayout,
+      shaderLayout,
+      bindings,
+      group,
+      label
+    );
   }
 
   submit(commandBuffer?: WebGPUCommandBuffer): void {

package/src/adapter/webgpu-presentation-context.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-// prettier-ignore
+// biome-ignore format: preserve layout
 // / <reference types="@webgpu/types" />
 
 import type {PresentationContextProps, TextureFormatDepthStencil} from '@luma.gl/core';