@luma.gl/engine 9.3.0-alpha.9 → 9.3.1

package/src/model/model.ts

@@ -53,6 +53,7 @@ import {Material} from '../material/material';
 
 const LOG_DRAW_PRIORITY = 2;
 const LOG_DRAW_TIMEOUT = 10000;
+const PIPELINE_INITIALIZATION_FAILED = 'render pipeline initialization failed';
 
 export type ModelProps = Omit<RenderPipelineProps, 'vs' | 'fs' | 'bindings'> & {
   source?: string;
@@ -445,6 +446,7 @@ export class Model {
     }
 
     let drawSuccess: boolean;
+    let pipelineErrored = this.pipeline.isErrored;
     try {
       renderPass.pushDebugGroup(`${this}.draw(${renderPass})`);
       this._logDrawCallStart();
@@ -453,36 +455,45 @@ export class Model {
       // TODO - inside RenderPass is likely the worst place to do this from performance perspective.
       // Application can call Model.predraw() to avoid this.
       this.pipeline = this._updatePipeline();
+      pipelineErrored = this.pipeline.isErrored;
 
-      const syncBindings = this._getBindings();
-      const syncBindGroups = this._getBindGroups();
-
-      const {indexBuffer} = this.vertexArray;
-      const indexCount = indexBuffer
-        ? indexBuffer.byteLength / (indexBuffer.indexType === 'uint32' ? 4 : 2)
-        : undefined;
-
-      drawSuccess = this.pipeline.draw({
-        renderPass,
-        vertexArray: this.vertexArray,
-        isInstanced: this.isInstanced,
-        vertexCount: this.vertexCount,
-        instanceCount: this.instanceCount,
-        indexCount,
-        transformFeedback: this.transformFeedback || undefined,
-        // Pipelines may be shared across models when caching is enabled, so bindings
-        // and WebGL uniforms must be supplied on every draw instead of being stored
-        // on the pipeline instance.
-        bindings: syncBindings,
-        bindGroups: syncBindGroups,
-        _bindGroupCacheKeys: this._getBindGroupCacheKeys(),
-        uniforms: this.props.uniforms,
-        // WebGL shares underlying cached pipelines even for models that have different parameters and topology,
-        // so we must provide our unique parameters to each draw
-        // (In WebGPU most parameters are encoded in the pipeline and cannot be changed per draw call)
-        parameters: this.parameters,
-        topology: this.topology
-      });
+      if (pipelineErrored) {
+        log.info(
+          LOG_DRAW_PRIORITY,
+          `>>> DRAWING ABORTED ${this.id}: ${PIPELINE_INITIALIZATION_FAILED}`
+        )();
+        drawSuccess = false;
+      } else {
+        const syncBindings = this._getBindings();
+        const syncBindGroups = this._getBindGroups();
+
+        const {indexBuffer} = this.vertexArray;
+        const indexCount = indexBuffer
+          ? indexBuffer.byteLength / (indexBuffer.indexType === 'uint32' ? 4 : 2)
+          : undefined;
+
+        drawSuccess = this.pipeline.draw({
+          renderPass,
+          vertexArray: this.vertexArray,
+          isInstanced: this.isInstanced,
+          vertexCount: this.vertexCount,
+          instanceCount: this.instanceCount,
+          indexCount,
+          transformFeedback: this.transformFeedback || undefined,
+          // Pipelines may be shared across models when caching is enabled, so bindings
+          // and WebGL uniforms must be supplied on every draw instead of being stored
+          // on the pipeline instance.
+          bindings: syncBindings,
+          bindGroups: syncBindGroups,
+          _bindGroupCacheKeys: this._getBindGroupCacheKeys(),
+          uniforms: this.props.uniforms,
+          // WebGL shares underlying cached pipelines even for models that have different parameters and topology,
+          // so we must provide our unique parameters to each draw
+          // (In WebGPU most parameters are encoded in the pipeline and cannot be changed per draw call)
+          parameters: this.parameters,
+          topology: this.topology
+        });
+      }
     } finally {
       renderPass.popDebugGroup();
       this._logDrawCallEnd();
@@ -493,6 +504,8 @@ export class Model {
     if (drawSuccess) {
       this._lastDrawTimestamp = this.device.timestamp;
       this._needsRedraw = false;
+    } else if (pipelineErrored) {
+      this._needsRedraw = PIPELINE_INITIALIZATION_FAILED;
     } else {
       this._needsRedraw = 'waiting for resource initialization';
     }
@@ -601,11 +614,11 @@ export class Model {
   /** Set the shader inputs */
   setShaderInputs(shaderInputs: ShaderInputs): void {
     this.shaderInputs = shaderInputs;
-    this._uniformStore = new UniformStore(this.shaderInputs.modules);
+    this._uniformStore = new UniformStore(this.device, this.shaderInputs.modules);
     // Create uniform buffer bindings for all modules that actually have uniforms
     for (const [moduleName, module] of Object.entries(this.shaderInputs.modules)) {
       if (shaderModuleHasUniforms(module) && !this.material?.ownsModule(moduleName)) {
-        const uniformBuffer = this._uniformStore.getManagedUniformBuffer(this.device, moduleName);
+        const uniformBuffer = this._uniformStore.getManagedUniformBuffer(moduleName);
         this.bindings[`${moduleName}Uniforms`] = uniformBuffer;
       }
     }
@@ -948,12 +961,11 @@ export class Model {
       // } || (this._drawCount++ > 3 && this._drawCount % 60)) {
       return;
     }
-    // TODO - display framebuffer output in debug window
     const framebuffer = renderPass.props.framebuffer;
-    if (framebuffer) {
-      debugFramebuffer(framebuffer, {id: framebuffer.id, minimap: true});
-      // log.image({logLevel: LOG_DRAW_PRIORITY, message: `${framebuffer.id} %c sup?`, image})();
-    }
+    debugFramebuffer(renderPass, framebuffer, {
+      id: framebuffer?.id || `${this.id}-framebuffer`,
+      minimap: true
+    });
   }
 
   _getAttributeDebugTable(): Record<string, Record<string, unknown>> {

package/src/models/billboard-texture-model.ts

@@ -15,12 +15,12 @@ const backgroundModule = {
 } as const satisfies ShaderModule<{}, {scale: [number, number]}>;
 
 const BACKGROUND_FS_WGSL = /* wgsl */ `\
-@group(0) @binding(0) var backgroundTexture: texture_2d<f32>;
-@group(0) @binding(1) var backgroundTextureSampler: sampler;
+@group(0) @binding(auto) var backgroundTexture: texture_2d<f32>;
+@group(0) @binding(auto) var backgroundTextureSampler: sampler;
 struct backgroundUniforms {
   scale: vec2<f32>,
 };
-@group(0) @binding(2) var<uniform> background: backgroundUniforms;
+@group(0) @binding(auto) var<uniform> background: backgroundUniforms;
 
 fn billboardTexture_getTextureUV(uv: vec2<f32>) -> vec2<f32> {
         let scale: vec2<f32> = background.scale;
@@ -41,7 +41,7 @@ precision highp float;
 
 uniform sampler2D backgroundTexture;
 
-uniform backgroundUniforms {
+layout(std140) uniform backgroundUniforms {
   vec2 scale;
 } background;
 

package/src/models/billboard-texture-module.ts

@@ -7,7 +7,7 @@ import {ShaderModule} from '@luma.gl/shadertools';
 const BACKGROUND_FS = /* glsl */ `\
 #version 300 es
 
-uniform billboardTextureUniforms {
+layout(std140) uniform billboardTextureUniforms {
   vec2 topLeft;
   vec2 bottomRight;
 } billboardTexture;

package/src/models/light-model-utils.ts

@@ -496,7 +496,7 @@ struct lightMarkerUniforms {
   viewProjectionMatrix: mat4x4<f32>,
 };
 
-@binding(0) @group(0) var<uniform> lightMarker : lightMarkerUniforms;
+@group(0) @binding(auto) var<uniform> lightMarker : lightMarkerUniforms;
 
 struct VertexInputs {
   @location(0) positions : vec3<f32>,
@@ -547,7 +547,7 @@ in vec3 instanceDirection;
 in vec3 instanceScale;
 in vec4 instanceColor;
 
-uniform lightMarkerUniforms {
+layout(std140) uniform lightMarkerUniforms {
   mat4 viewProjectionMatrix;
 } lightMarker;
 

package/src/modules/picking/picking-uniforms.ts

@@ -78,7 +78,7 @@ export const GLSL_UNIFORMS = /* glsl */ `\
 precision highp float;
 precision highp int;
 
-uniform pickingUniforms {
+layout(std140) uniform pickingUniforms {
   int isActive;
   int indexMode;
   int batchIndex;

package/src/passes/get-fragment-shader.ts

@@ -36,8 +36,8 @@ export function getFragmentShaderForRenderPass(options: {
 /** Get a filtering WGSL fragment shader */
 function getFilterShaderWGSL(func: string) {
   return /* wgsl */ `\
-@group(0) @binding(0) var sourceTexture: texture_2d<f32>;
-@group(0) @binding(2) var sourceTextureSampler: sampler;
+@group(0) @binding(auto) var sourceTexture: texture_2d<f32>;
+@group(0) @binding(auto) var sourceTextureSampler: sampler;
 
 @fragment
 fn fragmentMain(inputs: FragmentInputs) -> @location(0) vec4f {
@@ -54,8 +54,8 @@ fn fragmentMain(inputs: FragmentInputs) -> @location(0) vec4f {
 /** Get a sampling WGSL fragment shader */
 function getSamplerShaderWGSL(func: string) {
   return /* wgsl */ `\
-@group(0) @binding(0) var sourceTexture: texture_2d<f32>;
-@group(0) @binding(2) var sourceTextureSampler: sampler;
+@group(0) @binding(auto) var sourceTexture: texture_2d<f32>;
+@group(0) @binding(auto) var sourceTextureSampler: sampler;
 
 @fragment
 fn fragmentMain(inputs: FragmentInputs) -> @location(0) vec4f {

package/src/shader-inputs.ts

@@ -84,13 +84,11 @@ export class ShaderInputs<
 
     // Initialize the modules
     for (const [name, module] of Object.entries(modules)) {
-      if (!module) {
-        continue;
-      }
-
-      this._addModule(module);
-      if (module.name && name !== module.name && !this.options.disableWarnings) {
-        log.warn(`Module name: ${name} vs ${module.name}`)();
+      if (module) {
+        this._addModule(module);
+        if (module.name && name !== module.name && !this.options.disableWarnings) {
+          log.warn(`Module name: ${name} vs ${module.name}`)();
+        }
       }
     }
   }
@@ -111,26 +109,25 @@ export class ShaderInputs<
         if (!this.options.disableWarnings) {
           log.warn(`Module ${name} not found`)();
         }
-        continue; // eslint-disable-line no-continue
+      } else {
+        const oldUniforms = this.moduleUniforms[moduleName];
+        const oldBindings = this.moduleBindings[moduleName];
+        const uniformsAndBindings =
+          module.getUniforms?.(moduleProps, oldUniforms) || (moduleProps as any);
+
+        const {uniforms, bindings} = splitUniformsAndBindings(
+          uniformsAndBindings,
+          module.uniformTypes as Readonly<Record<string, CompositeShaderType>>
+        );
+        this.moduleUniforms[moduleName] = mergeModuleUniforms(
+          oldUniforms as Record<string, ShaderModuleUniformValue>,
+          uniforms,
+          module.uniformTypes as Readonly<Record<string, CompositeShaderType>>
+        );
+        this.moduleBindings[moduleName] = {...oldBindings, ...bindings};
+        // this.moduleUniformsChanged ||= moduleName;
       }
 
-      const oldUniforms = this.moduleUniforms[moduleName];
-      const oldBindings = this.moduleBindings[moduleName];
-      const uniformsAndBindings =
-        module.getUniforms?.(moduleProps, oldUniforms) || (moduleProps as any);
-
-      const {uniforms, bindings} = splitUniformsAndBindings(
-        uniformsAndBindings,
-        module.uniformTypes as Readonly<Record<string, CompositeShaderType>>
-      );
-      this.moduleUniforms[moduleName] = mergeModuleUniforms(
-        oldUniforms as Record<string, ShaderModuleUniformValue>,
-        uniforms,
-        module.uniformTypes as Readonly<Record<string, CompositeShaderType>>
-      );
-      this.moduleBindings[moduleName] = {...oldBindings, ...bindings};
-      // this.moduleUniformsChanged ||= moduleName;
-
       // console.log(`setProps(${String(moduleName)}`, moduleName, this.moduleUniforms[moduleName])
     }
   }
@@ -194,11 +191,9 @@ function mergeModuleUniforms(
 ): Record<string, ShaderModuleUniformValue> {
   const mergedUniforms = {...currentUniforms};
   for (const [key, value] of Object.entries(nextUniforms)) {
-    if (value === undefined) {
-      continue;
+    if (value !== undefined) {
+      mergedUniforms[key] = mergeModuleUniformValue(currentUniforms[key], value, uniformTypes[key]);
     }
-
-    mergedUniforms[key] = mergeModuleUniformValue(currentUniforms[key], value, uniformTypes[key]);
   }
   return mergedUniforms;
 }
@@ -224,15 +219,13 @@ function mergeModuleUniformValue(
     const mergedArray = currentArray.slice();
     for (let index = 0; index < nextValue.length; index++) {
       const elementValue = nextValue[index];
-      if (elementValue === undefined) {
-        continue;
+      if (elementValue !== undefined) {
+        mergedArray[index] = mergeModuleUniformValue(
+          currentArray[index],
+          elementValue,
+          uniformType[0] as CompositeShaderType
+        );
       }
-
-      mergedArray[index] = mergeModuleUniformValue(
-        currentArray[index],
-        elementValue,
-        uniformType[0] as CompositeShaderType
-      );
     }
     return mergedArray;
   }
@@ -245,11 +238,9 @@ function mergeModuleUniformValue(
   const currentObject = isPlainUniformObject(currentValue) ? currentValue : {};
   const mergedObject: Record<string, ShaderModuleUniformValue | undefined> = {...currentObject};
   for (const [key, value] of Object.entries(nextValue)) {
-    if (value === undefined) {
-      continue;
+    if (value !== undefined) {
+      mergedObject[key] = mergeModuleUniformValue(currentObject[key], value, uniformStruct[key]);
     }
-
-    mergedObject[key] = mergeModuleUniformValue(currentObject[key], value, uniformStruct[key]);
   }
   return mergedObject as ShaderModuleUniformValue;
 }