@luma.gl/engine 9.0.0-alpha.52 → 9.0.0-alpha.54

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luma.gl/engine",
-  "version": "9.0.0-alpha.52",
+  "version": "9.0.0-alpha.54",
   "description": "WebGL2 Components for High Performance Rendering and Computation",
   "type": "module",
   "license": "MIT",
@@ -40,12 +40,12 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.0.0",
-    "@luma.gl/constants": "9.0.0-alpha.52",
-    "@luma.gl/core": "9.0.0-alpha.52",
-    "@luma.gl/shadertools": "9.0.0-alpha.52",
+    "@luma.gl/constants": "9.0.0-alpha.54",
+    "@luma.gl/core": "9.0.0-alpha.54",
+    "@luma.gl/shadertools": "9.0.0-alpha.54",
     "@math.gl/core": "^4.0.0",
     "@probe.gl/log": "^4.0.2",
     "@probe.gl/stats": "^4.0.2"
   },
-  "gitHead": "41fa29f78dc260e5ef4c6a48e657fb5d23c96e8f"
+  "gitHead": "6028eb651303eadbc8f25e86d135d28f118fa3cf"
 }

package/src/debug/debug-shader-layout.ts

@@ -0,0 +1,34 @@
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import type {ShaderLayout} from '@luma.gl/core';
+
+/**
+ * Extracts a table suitable for `console.table()` from a shader layout to assist in debugging.
+ * @param layout shader layout
+ * @param name app should provide the most meaningful name, usually the model or pipeline name / id.
+ * @returns 
+ */
+export function getDebugTableForShaderLayout(
+  layout: ShaderLayout,
+  name: string = ''
+): Record<string, Record<string, string>> {
+  const table: Record<string, Record<string, string>> = {};
+
+  const header = `Shader Layout for ${name}`;
+
+  for (const attributeDeclaration of layout.attributes) {
+    if (attributeDeclaration) {
+      const glslDeclaration = `${attributeDeclaration.location} ${attributeDeclaration.name}: ${attributeDeclaration.type}`;
+      table[`in ${glslDeclaration}`] = {[header]: attributeDeclaration.stepMode || 'vertex'};
+    }
+  }
+
+  for (const varyingDeclaration of layout.varyings || []) {
+    const glslDeclaration = `${varyingDeclaration.location} ${varyingDeclaration.name}`;
+    table[`out ${glslDeclaration}`] = {[header]: JSON.stringify(varyingDeclaration.accessor)};
+  }
+
+  return table;
+}

package/src/geometry/gpu-geometry.ts

@@ -112,6 +112,7 @@ export function getAttributeBuffersFromGeometry(
       case 'POSITION': name = 'positions'; break;
       case 'NORMAL': name = 'normals'; break;
       case 'TEXCOORD_0': name = 'texCoords'; break;
+      case 'COLOR_0': name = 'colors'; break;
     }
     attributes[name] = device.createBuffer({data: attribute.value, id: `${attributeName}-buffer`});
     const {value, size, normalized} = attribute;

package/src/model/model.ts

@@ -1,18 +1,30 @@
 // luma.gl, MIT license
 // Copyright (c) vis.gl contributors
 
-import type {TypedArray, RenderPipelineProps, RenderPipelineParameters} from '@luma.gl/core';
+import type {
+  TypedArray,
+  RenderPipelineProps,
+  RenderPipelineParameters
+} from '@luma.gl/core';
 import type {BufferLayout, VertexArray, TransformFeedback} from '@luma.gl/core';
 import type {AttributeInfo, Binding, UniformValue, PrimitiveTopology} from '@luma.gl/core';
-import {Device, Buffer, RenderPipeline, RenderPass, UniformStore} from '@luma.gl/core';
+import {
+  Device,
+  Buffer,
+  RenderPipeline,
+  RenderPass,
+  UniformStore,
+  getTypedArrayFromDataType
+} from '@luma.gl/core';
 import {log, uid, deepEqual, splitUniformsAndBindings} from '@luma.gl/core';
-import {getAttributeInfosFromLayouts, getDebugTableForShaderLayout} from '@luma.gl/core';
+import {getAttributeInfosFromLayouts} from '@luma.gl/core';
 import type {ShaderModule, PlatformInfo} from '@luma.gl/shadertools';
 import {ShaderAssembler} from '@luma.gl/shadertools';
 import {ShaderInputs} from '../shader-inputs';
 import type {Geometry} from '../geometry/geometry';
 import {GPUGeometry, makeGPUGeometry} from '../geometry/gpu-geometry';
 import {PipelineFactory} from '../lib/pipeline-factory';
+import {getDebugTableForShaderLayout} from '../debug/debug-shader-layout';
 
 const LOG_DRAW_PRIORITY = 2;
 const LOG_DRAW_TIMEOUT = 10000;
@@ -159,13 +171,20 @@ export class Model {
     Object.assign(this.userData, props.userData);
 
     // Setup shader module inputs
-    const moduleMap = Object.fromEntries(this.props.modules?.map(module => [module.name, module]) || []);
+    const moduleMap = Object.fromEntries(
+      this.props.modules?.map(module => [module.name, module]) || []
+    );
     this.setShaderInputs(props.shaderInputs || new ShaderInputs(moduleMap));
 
     // Setup shader assembler
     const platformInfo = getPlatformInfo(device);
-    const modules = (this.props.modules?.length > 0 ? this.props.modules : this.shaderInputs?.getModules()) || [];
-    const {vs, fs, getUniforms} = this.props.shaderAssembler.assembleShaders({platformInfo, ...this.props, modules});
+    const modules =
+      (this.props.modules?.length > 0 ? this.props.modules : this.shaderInputs?.getModules()) || [];
+    const {vs, fs, getUniforms} = this.props.shaderAssembler.assembleShaders({
+      platformInfo,
+      ...this.props,
+      modules
+    });
 
     this.vs = vs;
     this.fs = fs;
@@ -226,8 +245,7 @@ export class Model {
       this.setUniforms(props.uniforms);
     }
     if (props.moduleSettings) {
-      // eslint-disable-next-line no-console
-      console.warn('Model.props.moduleSettings is deprecated. Use Model.shaderInputs.setProps()');
+      log.warn('Model.props.moduleSettings is deprecated. Use Model.shaderInputs.setProps()')();
       this.updateModuleSettings(props.moduleSettings);
     }
     if (props.transformFeedback) {
@@ -305,7 +323,7 @@ export class Model {
   _setGeometryAttributes(gpuGeometry: GPUGeometry): void {
     // TODO - delete previous geometry?
     this.vertexCount = gpuGeometry.vertexCount;
-    this.setAttributes(gpuGeometry.attributes);
+    this.setAttributes(gpuGeometry.attributes, 'ignore-unknown');
     this.setIndexBuffer(gpuGeometry.indices);
   }
 
@@ -380,10 +398,7 @@ export class Model {
     this._uniformStore = new UniformStore(this.shaderInputs.modules);
     // Create uniform buffer bindings for all modules
     for (const moduleName of Object.keys(this.shaderInputs.modules)) {
-      const uniformBuffer = this._uniformStore.getManagedUniformBuffer(
-        this.device,
-        moduleName
-      );
+      const uniformBuffer = this._uniformStore.getManagedUniformBuffer(this.device, moduleName);
       this.bindings[`${moduleName}Uniforms`] = uniformBuffer;
     }
   }
@@ -396,13 +411,12 @@ export class Model {
    * @deprecated Updates shader module settings (which results in uniforms being set)
    */
   updateModuleSettings(props: Record<string, any>): void {
-    // eslint-disable-next-line no-console
-    console.warn('Model.updateModuleSettings is deprecated. Use Model.shaderInputs.setProps()');
+    log.warn('Model.updateModuleSettings is deprecated. Use Model.shaderInputs.setProps()')();
     const {bindings, uniforms} = splitUniformsAndBindings(this._getModuleUniforms(props));
     Object.assign(this.bindings, bindings);
     Object.assign(this.uniforms, uniforms);
   }
- 
+
   /**
    * Sets bindings (textures, samplers, uniform buffers)
    */
@@ -440,23 +454,21 @@ export class Model {
    * Sets attributes (buffers)
    * @note Overrides any attributes previously set with the same name
    */
-  setAttributes(buffers: Record<string, Buffer>): void {
+  setAttributes(buffers: Record<string, Buffer>, _option?: 'ignore-unknown'): void {
     if (buffers.indices) {
       log.warn(
         `Model:${this.id} setAttributes() - indexBuffer should be set using setIndexBuffer()`
-      );
+      )();
     }
     for (const [bufferName, buffer] of Object.entries(buffers)) {
-      const bufferLayout = this.bufferLayout.find(layout => layout.name === bufferName);
+      const bufferLayout = this.bufferLayout.find(layout => getAttributeNames(layout).includes(bufferName));
       if (!bufferLayout) {
         log.warn(`Model(${this.id}): Missing layout for buffer "${bufferName}".`)();
         continue; // eslint-disable-line no-continue
       }
 
       // For an interleaved attribute we may need to set multiple attributes
-      const attributeNames = bufferLayout.attributes
-        ? bufferLayout.attributes?.map(layout => layout.attribute)
-        : [bufferLayout.name];
+      const attributeNames = getAttributeNames(bufferLayout);
       let set = false;
       for (const attributeName of attributeNames) {
         const attributeInfo = this._attributeInfos[attributeName];
@@ -465,7 +477,7 @@ export class Model {
           set = true;
         }
       }
-      if (!set) {
+      if (!set && _option !== 'ignore-unknown') {
         log.warn(
           `Model(${this.id}): Ignoring buffer "${buffer.id}" for unknown attribute "${bufferName}"`
         )();
@@ -554,10 +566,56 @@ export class Model {
       // log.table(logLevel, uniformTable)();
       log.table(LOG_DRAW_PRIORITY, shaderLayoutTable)();
 
+      const uniformTable = this.shaderInputs.getDebugTable();
+      // Add any global uniforms
+      for (const [name, value] of Object.entries(this.uniforms)) {
+        uniformTable[name] = {value};
+      }
+      log.table(LOG_DRAW_PRIORITY, uniformTable)();
+
+      const attributeTable = this._getAttributeDebugTable();
+      log.table(LOG_DRAW_PRIORITY, this._attributeInfos)();
+      log.table(LOG_DRAW_PRIORITY, attributeTable)();
+
       log.groupEnd(LOG_DRAW_PRIORITY)();
       this._logOpen = false;
     }
   }
+
+  _getAttributeDebugTable(): Record<string, Record<string, unknown>> {
+    const table: Record<string, Record<string, unknown>> = {};
+    for (const [name, attributeInfo] of Object.entries(this._attributeInfos)) {
+      table[attributeInfo.location] = {
+        name,
+        type: attributeInfo.shaderType,
+        values: this._getBufferOrConstantValues(
+          this.vertexArray.attributes[attributeInfo.location],
+          attributeInfo.bufferDataType
+        )
+      };
+    }
+    if (this.vertexArray.indexBuffer) {
+      const {indexBuffer} = this.vertexArray;
+      const values =
+        indexBuffer.indexType === 'uint32'
+          ? new Uint32Array(indexBuffer.debugData)
+          : new Uint16Array(indexBuffer.debugData);
+      table.indices = {
+        name: 'indices',
+        type: indexBuffer.indexType,
+        values: values.toString()
+      };
+    }
+    return table;
+  }
+
+  // TODO - fix typing of luma data types
+  _getBufferOrConstantValues(attribute: Buffer | TypedArray, dataType: any): string {
+    const TypedArrayConstructor = getTypedArrayFromDataType(dataType);
+    const typedArray =
+      attribute instanceof Buffer ? new TypedArrayConstructor(attribute.debugData) : attribute;
+    return typedArray.toString();
+  }
 }
 
 // HELPERS
@@ -586,3 +644,10 @@ export function getPlatformInfo(device: Device): PlatformInfo {
     features: device.features
   };
 }
+
+/** Get attribute names from a BufferLayout */
+function getAttributeNames(bufferLayout: BufferLayout): string[] {
+  return bufferLayout.attributes
+  ? bufferLayout.attributes?.map(layout => layout.attribute)
+  : [bufferLayout.name];
+}

package/src/shader-inputs.ts

@@ -91,7 +91,7 @@ export class ShaderInputs<
       if (!module) {
         // Ignore props for unregistered modules
         log.warn(`Module ${name} not found`)();
-        continue;
+        continue; // eslint-disable-line no-continue
       }
 
       const oldUniforms = this.moduleUniforms[moduleName];  
@@ -134,4 +134,17 @@ export class ShaderInputs<
     }
     return bindings;
   }
+
+  getDebugTable(): Record<string, Record<string, unknown>> {
+    const table: Record<string,Record<string, unknown>> = {};
+    for (const [moduleName, module] of Object.entries(this.moduleUniforms)) {
+      for (const [key, value] of Object.entries(module)) {
+        table[`${moduleName}.${key}`] = {
+          type: this.modules[moduleName].uniformTypes?.[key],
+          value: String(value)
+        };
+      }
+    }
+    return table;
+  }
 }