@luma.gl/shadertools 9.2.5 → 9.3.0-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luma.gl/shadertools",
-  "version": "9.2.5",
+  "version": "9.3.0-alpha.10",
   "description": "Shader module system for luma.gl",
   "type": "module",
   "license": "MIT",
@@ -46,12 +46,11 @@
     "prepublishOnly": "npm run build-minified-bundle && npm run build-dev-bundle"
   },
   "peerDependencies": {
-    "@luma.gl/core": "~9.2.0"
+    "@luma.gl/core": "9.3.0-alpha.6"
   },
   "dependencies": {
     "@math.gl/core": "^4.1.0",
-    "@math.gl/types": "^4.1.0",
-    "wgsl_reflect": "^1.2.0"
+    "@math.gl/types": "^4.1.0"
   },
-  "gitHead": "a8efd26edd0c61c7bb29ea700c6c38f544f60326"
+  "gitHead": "ca3a841517106f8608ce392440fa7f324863a84f"
 }

package/src/index.ts

@@ -9,17 +9,31 @@
  * Install https://marketplace.visualstudio.com/items?itemName=boyswan.glsl-literal
  */
 export type {PlatformInfo} from './lib/shader-assembly/platform-info';
+export type {ShaderBindingDebugRow} from './lib/shader-assembly/wgsl-binding-debug';
 
 // ShaderModules
 
 export type {ShaderModule} from './lib/shader-module/shader-module';
 export type {ShaderPass} from './lib/shader-module/shader-pass';
-export type {UniformTypes} from './lib/utils/uniform-types';
+export type {ShaderModuleUniformValue, UniformTypes} from './lib/utils/uniform-types';
 
 export {initializeShaderModule, initializeShaderModules} from './lib/shader-module/shader-module';
 export {getShaderModuleUniforms} from './lib/shader-module/shader-module';
 export {getShaderModuleDependencies} from './lib/shader-module/shader-module-dependencies';
 export {checkShaderModuleDeprecations} from './lib/shader-module/shader-module';
+export type {
+  GLSLUniformBlockInfo,
+  ShaderModuleUniformLayoutStage,
+  ShaderModuleUniformLayoutValidationResult
+} from './lib/shader-module/shader-module-uniform-layout';
+export {
+  getGLSLUniformBlocks,
+  getShaderModuleUniformBlockFields,
+  getShaderModuleUniformBlockName,
+  getShaderModuleUniformLayoutValidationResult,
+  validateShaderModuleUniformLayout,
+  warnIfGLSLUniformBlocksAreNotStd140
+} from './lib/shader-module/shader-module-uniform-layout';
 
 export {getShaderModuleSource} from './lib/shader-assembly/assemble-shaders';
 
@@ -53,9 +67,6 @@ export {preprocess} from './lib/preprocessor/preprocessor';
 export {assembleGLSLShaderPair} from './lib/shader-assembly/assemble-shaders';
 export {combineInjects} from './lib/shader-assembly/shader-injections';
 
-// EXPERIMENTAL WGSL
-export {getShaderLayoutFromWGSL} from './lib/wgsl/get-shader-layout-wgsl';
-
 // data utils
 export {toHalfFloat, fromHalfFloat} from './modules/math/fp16/fp16-utils';
 export {fp64ify, fp64LowPart, fp64ifyMatrix4} from './modules/math/fp64/fp64-utils';
@@ -68,16 +79,30 @@ export {fp64, fp64arithmetic} from './modules/math/fp64/fp64';
 
 // engine shader modules
 
-// // projection
+//  projection
 // export type {ProjectionUniforms} from './modules/engine/project/project';
 // export {projection} from './modules/engine/project/project';
 export type {PickingProps, PickingUniforms} from './modules/engine/picking/picking';
 export {picking} from './modules/engine/picking/picking';
+export {skin} from './modules/engine/skin/skin';
+
+// lighting
+export {
+  type Light,
+  type AmbientLight,
+  type PointLight,
+  type SpotLight,
+  type DirectionalLight,
+  type LightingLightUniform
+} from './modules/lighting/lights/lighting';
 
-// // lighting
 export type {LightingProps, LightingUniforms} from './modules/lighting/lights/lighting';
 export {lighting} from './modules/lighting/lights/lighting';
+export type {IBLBindings} from './modules/lighting/ibl/ibl';
+export {ibl} from './modules/lighting/ibl/ibl';
 export {dirlight} from './modules/lighting/no-material/dirlight';
+export type {LambertMaterialProps} from './modules/lighting/lambert-material/lambert-material';
+export {lambertMaterial} from './modules/lighting/lambert-material/lambert-material';
 export type {GouraudMaterialProps} from './modules/lighting/gouraud-material/gouraud-material';
 export {gouraudMaterial} from './modules/lighting/gouraud-material/gouraud-material';
 export type {PhongMaterialProps} from './modules/lighting/phong-material/phong-material';
@@ -87,6 +112,12 @@ export type {
   PBRMaterialProps,
   PBRMaterialUniforms
 } from './modules/lighting/pbr-material/pbr-material';
+export type {
+  PBRSceneBindings,
+  PBRSceneProps,
+  PBRSceneUniforms
+} from './modules/lighting/pbr-material/pbr-scene';
 export type {PBRProjectionProps} from './modules/lighting/pbr-material/pbr-projection';
 
 export {pbrMaterial} from './modules/lighting/pbr-material/pbr-material';
+export {pbrScene} from './modules/lighting/pbr-material/pbr-scene';

package/src/lib/preprocessor/preprocessor.ts

@@ -2,8 +2,15 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-const IFDEF_REGEXP = /^\s*\#\s*ifdef\s*([a-zA-Z_]+)\s*$/;
+const DEFINE_NAME_PATTERN = '([a-zA-Z_][a-zA-Z0-9_]*)';
+const IFDEF_REGEXP = new RegExp(`^\\s*\\#\\s*ifdef\\s*${DEFINE_NAME_PATTERN}\\s*$`);
+const IFNDEF_REGEXP = new RegExp(`^\\s*\\#\\s*ifndef\\s*${DEFINE_NAME_PATTERN}\\s*(?:\\/\\/.*)?$`);
+const ELSE_REGEXP = /^\s*\#\s*else\s*(?:\/\/.*)?$/;
 const ENDIF_REGEXP = /^\s*\#\s*endif\s*$/;
+const IFDEF_WITH_COMMENT_REGEXP = new RegExp(
+  `^\\s*\\#\\s*ifdef\\s*${DEFINE_NAME_PATTERN}\\s*(?:\\/\\/.*)?$`
+);
+const ENDIF_WITH_COMMENT_REGEXP = /^\s*\#\s*endif\s*(?:\/\/.*)?$/;
 
 export type PreprocessorOptions = {
   defines?: Record<string, boolean>;
@@ -13,19 +20,48 @@ export function preprocess(source: string, options?: PreprocessorOptions): strin
   const lines = source.split('\n');
   const output: string[] = [];
 
+  const conditionalStack: Array<{
+    parentActive: boolean;
+    branchTaken: boolean;
+    active: boolean;
+  }> = [];
   let conditional = true;
-  let currentDefine: string | null = null;
+
   for (const line of lines) {
-    const matchIf = line.match(IFDEF_REGEXP);
-    const matchEnd = line.match(ENDIF_REGEXP);
-    if (matchIf) {
-      currentDefine = matchIf[1];
-      conditional = Boolean(options?.defines?.[currentDefine]);
+    const matchIf = line.match(IFDEF_WITH_COMMENT_REGEXP) || line.match(IFDEF_REGEXP);
+    const matchIfNot = line.match(IFNDEF_REGEXP);
+    const matchElse = line.match(ELSE_REGEXP);
+    const matchEnd = line.match(ENDIF_WITH_COMMENT_REGEXP) || line.match(ENDIF_REGEXP);
+
+    if (matchIf || matchIfNot) {
+      const defineName = (matchIf || matchIfNot)?.[1];
+      const defineValue: boolean = Boolean(options?.defines?.[defineName!]);
+      const branchTaken: boolean = matchIf ? defineValue : !defineValue;
+      const active: boolean = conditional && branchTaken;
+      conditionalStack.push({parentActive: conditional, branchTaken, active});
+      conditional = active;
+    } else if (matchElse) {
+      const currentConditional = conditionalStack[conditionalStack.length - 1];
+      if (!currentConditional) {
+        throw new Error('Encountered #else without matching #ifdef or #ifndef');
+      }
+      currentConditional.active =
+        currentConditional.parentActive && !currentConditional.branchTaken;
+      currentConditional.branchTaken = true;
+      conditional = currentConditional.active;
     } else if (matchEnd) {
-      conditional = true;
+      conditionalStack.pop();
+      conditional = conditionalStack.length
+        ? conditionalStack[conditionalStack.length - 1].active
+        : true;
     } else if (conditional) {
       output.push(line);
     }
   }
+
+  if (conditionalStack.length > 0) {
+    throw new Error('Unterminated conditional block in shader source');
+  }
+
   return output.join('\n');
 }

package/src/lib/shader-assembler.ts

@@ -10,6 +10,10 @@ import {
   assembleWGSLShader,
   assembleGLSLShaderPair
 } from './shader-assembly/assemble-shaders';
+import {
+  getShaderBindingDebugRowsFromWGSL,
+  type ShaderBindingDebugRow
+} from './shader-assembly/wgsl-binding-debug';
 import {preprocess} from './preprocessor/preprocessor';
 
 /**
@@ -23,6 +27,8 @@ export class ShaderAssembler {
   private readonly _hookFunctions: any[] = [];
   /** Shader modules */
   private _defaultModules: ShaderModule[] = [];
+  /** Stable per-run WGSL auto-binding assignments keyed by group/module/binding. */
+  private readonly _wgslBindingRegistry = new Map<string, number>();
 
   /**
    * A default shader assembler instance - the natural place to register default modules and hooks
@@ -77,20 +83,36 @@ export class ShaderAssembler {
     source: string;
     getUniforms: GetUniformsFunc;
     modules: ShaderModule[];
+    bindingAssignments: {moduleName: string; name: string; group: number; location: number}[];
+    bindingTable: ShaderBindingDebugRow[];
   } {
     const modules = this._getModuleList(props.modules); // Combine with default modules
     const hookFunctions = this._hookFunctions; // TODO - combine with default hook functions
-    const {source, getUniforms} = assembleWGSLShader({
+    const {source, getUniforms, bindingAssignments} = assembleWGSLShader({
       ...props,
       // @ts-expect-error
       source: props.source,
+      _bindingRegistry: this._wgslBindingRegistry,
       modules,
       hookFunctions
     });
+    const defines = {
+      ...modules.reduce<Record<string, boolean>>((accumulator, module) => {
+        Object.assign(accumulator, module.defines);
+        return accumulator;
+      }, {}),
+      ...props.defines
+    };
     // WGSL does not have built-in preprocessing support (just compile time constants)
     const preprocessedSource =
-      props.platformInfo.shaderLanguage === 'wgsl' ? preprocess(source) : source;
-    return {source: preprocessedSource, getUniforms, modules};
+      props.platformInfo.shaderLanguage === 'wgsl' ? preprocess(source, {defines}) : source;
+    return {
+      source: preprocessedSource,
+      getUniforms,
+      modules,
+      bindingAssignments,
+      bindingTable: getShaderBindingDebugRowsFromWGSL(preprocessedSource, bindingAssignments)
+    };
   }
 
   /**