fix(engine) Workaround for deck.gl attribute access (#1778)

modules/api/src/adapter/resources/render-pipeline.ts

@@ -1,5 +1,6 @@
 // luma.gl, MIT license
 import type {Device} from '../device';
+import type {TypedArray} from '../../types';
 import type {PrimitiveTopology, RenderPipelineParameters} from '../types/parameters';
 import type {ShaderLayout, BufferMapping, Binding} from '../types/shader-layout';
 // import {normalizeAttributeMap} from '../helpers/attribute-bindings';
@@ -104,6 +105,8 @@ export abstract class RenderPipeline extends Resource<RenderPipelineProps> {
   abstract setIndexBuffer(indices: Buffer): void;
   /** Set attributes (stored on pipeline and set before each call) */
   abstract setAttributes(attributes: Record<string, Buffer>): void;
+  /** Set constant attributes (WebGL only) */
+  abstract setConstantAttributes(attributes: Record<string, TypedArray>): void;
   /** Set bindings (stored on pipeline and set before each call) */
   abstract setBindings(bindings: Record<string, Binding>): void;
   /** Uniforms (only supported on WebGL devices. Reset before each call to enable pipeline sharing) */

modules/engine/src/model/model.ts

@@ -1,11 +1,19 @@
 // luma.gl, MIT license
 
-import type {Device, Buffer, RenderPipelineProps, RenderPass, Binding, PrimitiveTopology} from '@luma.gl/api';
+import {
+  Device,
+  Buffer,
+  RenderPipelineProps,
+  RenderPass,
+  Binding,
+  PrimitiveTopology
+} from '@luma.gl/api';
 import {RenderPipeline} from '@luma.gl/api';
-import type { ShaderModule } from '@luma.gl/shadertools';
+import type {ShaderModule} from '@luma.gl/shadertools';
 import type {Geometry} from '../geometry/geometry';
 import {getAttributeBuffersFromGeometry, getIndexBufferFromGeometry} from './model-utils';
 import {PipelineFactory} from '../lib/pipeline-factory';
+import {TypedArray} from '@math.gl/core';
 
 export type ModelProps = Omit<RenderPipelineProps, 'vs' | 'fs'> & {
   // Model also accepts a string
@@ -57,7 +65,7 @@ export class Model {
     this.device = device;
 
     Object.assign(this.userData, this.props.userData);
-    
+
     // Create the pipeline
     if (!props.vs) {
       throw new Error('no vertex shader');
@@ -75,7 +83,8 @@ export class Model {
       this.topology = this.props.geometry.topology || 'triangle-list';
     }
 
-    this.pipelineFactory = this.props.pipelineFactory || PipelineFactory.getDefaultPipelineFactory(this.device);
+    this.pipelineFactory =
+      this.props.pipelineFactory || PipelineFactory.getDefaultPipelineFactory(this.device);
     const {pipeline, getUniforms} = this.pipelineFactory.createRenderPipeline({
       ...this.props,
       vs: this.vs,
@@ -92,7 +101,7 @@ export class Model {
     if (this.props.geometry) {
       this._setGeometry(this.props.geometry);
     }
-    this.setUniforms(this._getModuleUniforms()) // Get all default module uniforms
+    this.setUniforms(this._getModuleUniforms()); // Get all default module uniforms
     this.setProps(this.props);
   }
 
@@ -140,17 +149,67 @@ export class Model {
     return this;
   }
 
-  setAttributes(attributes: Record<string, Buffer>): this {
+  // Temporary hack to support deck.gl's dependency on luma.gl v8 Model attribute API.
+  _splitAttributes(
+    attributes: Record<string, Buffer | TypedArray>,
+    filterBuffers?: boolean
+  ): {
+    bufferAttributes: Record<string, Buffer>;
+    constantAttributes: Record<string, TypedArray>;
+    indices?: Buffer;
+  } {
+    const bufferAttributes: Record<string, Buffer> = {};
+    const constantAttributes: Record<string, TypedArray> = {};
+    const indices: Buffer | undefined = attributes.indices as Buffer;
+
+    delete attributes.indices;
+
+    for (const name in attributes) {
+      let attribute = attributes[name];
+
+      if (attribute instanceof Buffer) {
+        bufferAttributes[name] = attribute;
+        continue;
+      }
+
+      // The `getValue` call provides support for deck.gl `Attribute` class
+      // TODO - remove once deck refactoring completes
+      // @ts-ignore
+      if (attribute.getValue) {
+        // @ts-ignore
+        attribute = attribute.getValue();
+        console.warn(`attribute ${name}: getValue() will be removed`);
+      }
+
+      if (ArrayBuffer.isView(attribute) && !attribute) {
+        constantAttributes[name] = attribute as unknown as TypedArray;
+        continue;
+      }
+
+      // @ts-ignore
+      if (filterBuffers && attribute[name]._buffer) {
+        // @ts-ignore
+        buffer[name] = attribute[name]._buffer;
+      }
+    }
+
+    return {bufferAttributes, constantAttributes, indices};
+  }
+
+  setAttributes(attributes: Record<string, Buffer | TypedArray>, filterBuffers?: boolean): void {
+    const {bufferAttributes, constantAttributes, indices} = this._splitAttributes(attributes, filterBuffers);
+
     // Temporary HACK since deck.gl v9 sets indices as part of attributes
-    if (attributes.indices) {
-      this.setIndexBuffer(attributes.indices);
-      attributes = {...attributes};
-      delete attributes.indices;
-      console.warn('luma.gl: indices should not be part of attributes')
+    if (indices) {
+      this.setIndexBuffer(indices);
+      console.warn('luma.gl: indices should not be part of attributes');
     }
-    this.pipeline.setAttributes(attributes);
-    Object.assign(this.props.attributes, attributes);
-    return this;
+
+    this.pipeline.setAttributes(bufferAttributes);
+    // TODO - WebGL only. We may have to allocate buffers on WebGPU
+    this.pipeline.setConstantAttributes(constantAttributes);
+
+    Object.assign(this.props.attributes, bufferAttributes, constantAttributes);
   }
 
   /** Set the bindings */