feat(engine): ShaderModule.getBindings()

visgl · Jun 13, 2024 · 0e9d738 · 0e9d738
1 parent 0b46676
commit 0e9d738
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 4 deletions.
diff --git a/modules/engine/src/model/model.ts b/modules/engine/src/model/model.ts
@@ -505,6 +505,7 @@ export class Model {
   /** Update uniform buffers from the model's shader inputs */
   updateShaderInputs(): void {
     this._uniformStore.setUniforms(this.shaderInputs.getUniformValues());
+    this.setBindings(this.shaderInputs.getBindings());
     // TODO - this is already tracked through buffer/texture update times?
     this.setNeedsRedraw('shaderInputs');
   }

diff --git a/modules/engine/src/shader-inputs.ts b/modules/engine/src/shader-inputs.ts
@@ -26,6 +26,7 @@ export type ShaderModuleInputs<
       type: 'texture' | 'sampler' | 'uniforms';
     }
   >;
+  getBindings?: (settings: Partial<PropsT>, prevBindings?: BindingsT) => BindingsT;
 
   uniformTypes?: any;
 };
@@ -112,9 +113,8 @@ export class ShaderInputs<
 
       // console.log(`setProps(${String(moduleName)}`, moduleName, this.moduleUniforms[moduleName])
 
-      // TODO - Get Module bindings
-      // const bindings = module.getBindings?.(moduleProps);
-      // this.moduleUniforms[moduleName] = bindings;
+      const bindings = module.getBindings?.(moduleProps);
+      this.moduleBindings[moduleName] = bindings;
     }
   }
 

diff --git a/modules/engine/test/shader-inputs.spec.ts b/modules/engine/test/shader-inputs.spec.ts
@@ -7,6 +7,7 @@ import {picking} from '../../shadertools/src/index';
 // import {_ShaderInputs as ShaderInputs} from '@luma.gl/engine';
 import {ShaderInputs} from '../src/shader-inputs';
 import {ShaderModule} from '@luma.gl/shadertools';
+import {Texture} from '@luma.gl/core';
 
 test('ShaderInputs#picking', t => {
   const shaderInputsUntyped = new ShaderInputs({picking});
@@ -92,3 +93,32 @@ test('ShaderInputs#dependencies', t => {
 
   t.end();
 });
+
+test('ShaderInputs#bindings', t => {
+  type CustomProps = {color: number[]; colorTexture: Texture};
+  const custom: ShaderModule<CustomProps> = {
+    name: 'custom',
+    uniformTypes: {color: 'vec3<f32>'},
+    uniformPropTypes: {color: {value: [0, 0, 0]}},
+    getUniforms: ({color}) => ({color}),
+    getBindings: ({colorTexture}) => ({colorTexture})
+  };
+
+  const shaderInputs = new ShaderInputs<{
+    custom: CustomProps;
+  }>({custom});
+
+  const MOCK_TEXTURE = 'MOCK_TEXTURE' as unknown as Texture;
+  shaderInputs.setProps({
+    custom: {color: [255, 0, 0], colorTexture: MOCK_TEXTURE}
+  });
+  t.deepEqual(shaderInputs.moduleUniforms.custom.color, [255, 0, 0], 'custom color updated');
+  t.equal(shaderInputs.moduleBindings.custom.colorTexture, MOCK_TEXTURE, 'colorTexture updated');
+
+  const uniformValues = shaderInputs.getUniformValues();
+  const bindings = shaderInputs.getBindings();
+  t.deepEqual(uniformValues, {custom: {color: [255, 0, 0]}}, 'uniformValues correct');
+  t.deepEqual(bindings, {colorTexture: 'MOCK_TEXTURE'}, 'bindings correct');
+
+  t.end();
+});
diff --git a/modules/shadertools/src/lib/shader-module/shader-module.ts b/modules/shadertools/src/lib/shader-module/shader-module.ts
@@ -5,6 +5,7 @@
 import {NumberArray} from '@math.gl/types';
 import {UniformFormat} from '../../types';
 import {PropType} from '../filters/prop-types';
+import {Sampler, Texture} from '@luma.gl/core';
 
 export type UniformValue = number | boolean | Readonly<NumberArray>; // Float32Array> | Readonly<Int32Array> | Readonly<Uint32Array> | Readonly<number[]>;
 
@@ -19,7 +20,7 @@ export type UniformInfo = {
 export type ShaderModule<
   PropsT extends Record<string, unknown> = Record<string, unknown>,
   UniformsT extends Record<string, UniformValue> = Record<string, UniformValue>,
-  BindingsT extends Record<string, unknown> = {}
+  BindingsT extends Record<string, Texture | Sampler> = {}
 > = {
   /** Used for type inference not for values */
   props?: Required<PropsT>;
@@ -43,6 +44,7 @@ export type ShaderModule<
 
   /** uniform buffers, textures, samplers, storage, ... */
   bindings?: Record<keyof BindingsT, {location: number; type: 'texture' | 'sampler' | 'uniforms'}>;
+  getBindings?: (settings?: any, prevBindings?: any) => Record<string, Texture | Sampler>;
 
   defines?: Record<string, string | number>;
   /** Injections */