@luma.gl/shadertools 9.1.0-alpha.1 → 9.1.0-alpha.12

package/dist/lib/shader-module/shader-module-instance.js

@@ -1,126 +0,0 @@
-// luma.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-import { assert } from "../utils/assert.js";
-import { makePropValidators, getValidatedProperties } from "../filters/prop-types.js";
-import { normalizeInjections } from "../shader-assembly/shader-injections.js";
-let index = 1;
-/** An initialized ShaderModule, ready to use with `assembleShaders()` */
-export class ShaderModuleInstance {
-    name;
-    vs;
-    fs;
-    getModuleUniforms;
-    dependencies;
-    deprecations;
-    defines;
-    injections;
-    uniforms = {};
-    uniformTypes = {};
-    static instantiateModules(modules) {
-        return modules.map((module) => {
-            if (module instanceof ShaderModuleInstance) {
-                return module;
-            }
-            assert(typeof module !== 'string', `Shader module use by name is deprecated. Import shader module '${JSON.stringify(module)}' and use it directly.`);
-            if (!module.name) {
-                // eslint-disable-next-line no-console
-                console.warn('shader module has no name');
-                module.name = `shader-module-${index++}`;
-            }
-            const moduleObject = new ShaderModuleInstance(module);
-            moduleObject.dependencies = ShaderModuleInstance.instantiateModules(module.dependencies || []);
-            return moduleObject;
-        });
-    }
-    constructor(props) {
-        const { name, vs, fs, dependencies = [], uniformPropTypes = {}, getUniforms, deprecations = [], defines = {}, inject = {} } = props;
-        assert(typeof name === 'string');
-        this.name = name;
-        this.vs = vs;
-        this.fs = fs;
-        this.getModuleUniforms = getUniforms;
-        this.dependencies = ShaderModuleInstance.instantiateModules(dependencies);
-        this.deprecations = this._parseDeprecationDefinitions(deprecations);
-        this.defines = defines;
-        this.injections = normalizeInjections(inject);
-        if (uniformPropTypes) {
-            this.uniforms = makePropValidators(uniformPropTypes);
-        }
-    }
-    // Extracts the source code chunk for the specified shader type from the named shader module
-    getModuleSource(stage) {
-        let moduleSource;
-        switch (stage) {
-            case 'vertex':
-                moduleSource = this.vs || '';
-                break;
-            case 'fragment':
-                moduleSource = this.fs || '';
-                break;
-            default:
-                assert(false);
-        }
-        const moduleName = this.name.toUpperCase().replace(/[^0-9a-z]/gi, '_');
-        return `\
-// ----- MODULE ${this.name} ---------------
-
-#define MODULE_${moduleName}
-${moduleSource}\
-
-
-`;
-    }
-    getUniforms(userProps, uniforms) {
-        if (this.getModuleUniforms) {
-            return this.getModuleUniforms(userProps, uniforms);
-        }
-        // Build uniforms from the uniforms array
-        return getValidatedProperties(userProps, this.uniforms, this.name);
-    }
-    getDefines() {
-        return this.defines;
-    }
-    // Warn about deprecated uniforms or functions
-    checkDeprecations(shaderSource, log) {
-        this.deprecations.forEach(def => {
-            if (def.regex?.test(shaderSource)) {
-                if (def.deprecated) {
-                    log.deprecated(def.old, def.new)();
-                }
-                else {
-                    log.removed(def.old, def.new)();
-                }
-            }
-        });
-    }
-    _parseDeprecationDefinitions(deprecations) {
-        deprecations.forEach(def => {
-            switch (def.type) {
-                case 'function':
-                    def.regex = new RegExp(`\\b${def.old}\\(`);
-                    break;
-                default:
-                    def.regex = new RegExp(`${def.type} ${def.old};`);
-            }
-        });
-        return deprecations;
-    }
-    _defaultGetUniforms(opts = {}) {
-        const uniforms = {};
-        const propTypes = this.uniforms;
-        for (const key in propTypes) {
-            const propDef = propTypes[key];
-            if (key in opts && !propDef.private) {
-                if (propDef.validate) {
-                    assert(propDef.validate(opts[key], propDef), `${this.name}: invalid ${key}`);
-                }
-                uniforms[key] = opts[key];
-            }
-            else {
-                uniforms[key] = propDef.value;
-            }
-        }
-        return uniforms;
-    }
-}

package/src/lib/glsl-utils/highlight.ts

@@ -1,11 +0,0 @@
-// luma.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-// SHADER HELPERS
-
-/**
- * Marks GLSL shaders for syntax highlighting: glsl`...`
- * Install https://marketplace.visualstudio.com/items?itemName=boyswan.glsl-literal
- */
-export const glsl = (x: TemplateStringsArray) => `${x}`;

package/src/lib/shader-assembly/resolve-modules.ts

@@ -1,81 +0,0 @@
-// luma.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-import type {ShaderModule} from '../shader-module/shader-module';
-import {ShaderModuleInstance} from '../shader-module/shader-module-instance';
-
-/**
- * Instantiate shader modules and esolve any dependencies
- */
-export function resolveModules(
-  modules: (ShaderModule | ShaderModuleInstance)[]
-): ShaderModuleInstance[] {
-  const instances = ShaderModuleInstance.instantiateModules(modules);
-  return getShaderDependencies(instances);
-}
-
-/**
- * Takes a list of shader module names and returns a new list of
- * shader module names that includes all dependencies, sorted so
- * that modules that are dependencies of other modules come first.
- *
- * If the shader glsl code from the returned modules is concatenated
- * in the reverse order, it is guaranteed that all functions be resolved and
- * that all function and variable definitions come before use.
- *
- * @param modules - Array of modules (inline modules or module names)
- * @return - Array of modules
- */
-function getShaderDependencies(modules: ShaderModuleInstance[]): ShaderModuleInstance[] {
-  const moduleMap: Record<string, ShaderModuleInstance> = {};
-  const moduleDepth: Record<string, number> = {};
-  getDependencyGraph({modules, level: 0, moduleMap, moduleDepth});
-
-  // Return a reverse sort so that dependencies come before the modules that use them
-  return Object.keys(moduleDepth)
-    .sort((a, b) => moduleDepth[b] - moduleDepth[a])
-    .map(name => moduleMap[name]);
-}
-
-/**
- * Recursively checks module dependencies to calculate dependency level of each module.
- *
- * @param options.modules - Array of modules
- * @param options.level - Current level
- * @param options.moduleMap -
- * @param options.moduleDepth - Current level
- * @return - Map of module name to its level
- */
-// Adds another level of dependencies to the result map
-export function getDependencyGraph(options: {
-  modules: ShaderModuleInstance[];
-  level: number;
-  moduleMap: Record<string, ShaderModuleInstance>;
-  moduleDepth: Record<string, number>;
-}) {
-  const {modules, level, moduleMap, moduleDepth} = options;
-  if (level >= 5) {
-    throw new Error('Possible loop in shader dependency graph');
-  }
-
-  // Update level on all current modules
-  for (const module of modules) {
-    moduleMap[module.name] = module;
-    if (moduleDepth[module.name] === undefined || moduleDepth[module.name] < level) {
-      moduleDepth[module.name] = level;
-    }
-  }
-
-  // Recurse
-  for (const module of modules) {
-    if (module.dependencies) {
-      getDependencyGraph({modules: module.dependencies, level: level + 1, moduleMap, moduleDepth});
-    }
-  }
-}
-
-export const TEST_EXPORTS = {
-  getShaderDependencies,
-  getDependencyGraph
-};

package/src/lib/shader-module/normalize-shader-module.ts

@@ -1,17 +0,0 @@
-// luma.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-import {ShaderModule} from './shader-module';
-import {ShaderModuleInstance} from './shader-module-instance';
-
-export function normalizeShaderModule(module: ShaderModule): ShaderModule {
-  if (!module.normalized) {
-    module.normalized = true;
-    if (module.uniformPropTypes && !module.getUniforms) {
-      const shaderModule = new ShaderModuleInstance(module);
-      module.getUniforms = shaderModule.getUniforms.bind(shaderModule);
-    }
-  }
-  return module;
-}

package/src/lib/shader-module/shader-module-instance.ts

@@ -1,167 +0,0 @@
-// luma.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-import {assert} from '../utils/assert';
-import {makePropValidators, getValidatedProperties, PropValidator} from '../filters/prop-types';
-import {ShaderModule, ShaderModuleDeprecation} from './shader-module';
-import {ShaderInjection, normalizeInjections} from '../shader-assembly/shader-injections';
-
-let index = 1;
-
-/** An initialized ShaderModule, ready to use with `assembleShaders()` */
-export class ShaderModuleInstance {
-  name: string;
-  vs?: string;
-  fs?: string;
-  getModuleUniforms: Function;
-  dependencies: ShaderModuleInstance[];
-  deprecations: ShaderModuleDeprecation[];
-  defines: Record<string, string | number>;
-  injections: {
-    vertex: Record<string, ShaderInjection>;
-    fragment: Record<string, ShaderInjection>;
-  };
-  uniforms: Record<string, PropValidator> = {};
-  uniformTypes: Record<string, PropValidator> = {};
-
-  static instantiateModules(
-    modules: (ShaderModule | ShaderModuleInstance)[]
-  ): ShaderModuleInstance[] {
-    return modules.map((module: ShaderModule | ShaderModuleInstance) => {
-      if (module instanceof ShaderModuleInstance) {
-        return module;
-      }
-
-      assert(
-        typeof module !== 'string',
-        `Shader module use by name is deprecated. Import shader module '${JSON.stringify(
-          module
-        )}' and use it directly.`
-      );
-      if (!module.name) {
-        // eslint-disable-next-line no-console
-        console.warn('shader module has no name');
-        module.name = `shader-module-${index++}`;
-      }
-
-      const moduleObject = new ShaderModuleInstance(module);
-      moduleObject.dependencies = ShaderModuleInstance.instantiateModules(
-        module.dependencies || []
-      );
-
-      return moduleObject;
-    });
-  }
-
-  constructor(props: ShaderModule) {
-    const {
-      name,
-      vs,
-      fs,
-      dependencies = [],
-      uniformPropTypes = {},
-      getUniforms,
-      deprecations = [],
-      defines = {},
-      inject = {}
-    } = props;
-
-    assert(typeof name === 'string');
-    this.name = name;
-    this.vs = vs;
-    this.fs = fs;
-    this.getModuleUniforms = getUniforms!;
-    this.dependencies = ShaderModuleInstance.instantiateModules(dependencies);
-    this.deprecations = this._parseDeprecationDefinitions(deprecations);
-    this.defines = defines;
-    this.injections = normalizeInjections(inject);
-
-    if (uniformPropTypes) {
-      this.uniforms = makePropValidators(uniformPropTypes);
-    }
-  }
-
-  // Extracts the source code chunk for the specified shader type from the named shader module
-  getModuleSource(stage: 'vertex' | 'fragment'): string {
-    let moduleSource;
-    switch (stage) {
-      case 'vertex':
-        moduleSource = this.vs || '';
-        break;
-      case 'fragment':
-        moduleSource = this.fs || '';
-        break;
-      default:
-        assert(false);
-    }
-
-    const moduleName = this.name.toUpperCase().replace(/[^0-9a-z]/gi, '_');
-    return `\
-// ----- MODULE ${this.name} ---------------
-
-#define MODULE_${moduleName}
-${moduleSource}\
-
-
-`;
-  }
-
-  getUniforms(userProps: Record<string, any>, uniforms: Record<string, any>): Record<string, any> {
-    if (this.getModuleUniforms) {
-      return this.getModuleUniforms(userProps, uniforms);
-    }
-    // Build uniforms from the uniforms array
-    return getValidatedProperties(userProps, this.uniforms, this.name);
-  }
-
-  getDefines(): Record<string, string | number> {
-    return this.defines;
-  }
-
-  // Warn about deprecated uniforms or functions
-  checkDeprecations(shaderSource: string, log: any): void {
-    this.deprecations.forEach(def => {
-      if (def.regex?.test(shaderSource)) {
-        if (def.deprecated) {
-          log.deprecated(def.old, def.new)();
-        } else {
-          log.removed(def.old, def.new)();
-        }
-      }
-    });
-  }
-
-  _parseDeprecationDefinitions(deprecations: ShaderModuleDeprecation[]) {
-    deprecations.forEach(def => {
-      switch (def.type) {
-        case 'function':
-          def.regex = new RegExp(`\\b${def.old}\\(`);
-          break;
-        default:
-          def.regex = new RegExp(`${def.type} ${def.old};`);
-      }
-    });
-
-    return deprecations;
-  }
-
-  _defaultGetUniforms(opts: Record<string, any> = {}): Record<string, any> {
-    const uniforms: Record<string, any> = {};
-    const propTypes = this.uniforms;
-
-    for (const key in propTypes) {
-      const propDef = propTypes[key];
-      if (key in opts && !propDef.private) {
-        if (propDef.validate) {
-          assert(propDef.validate(opts[key], propDef), `${this.name}: invalid ${key}`);
-        }
-        uniforms[key] = opts[key];
-      } else {
-        uniforms[key] = propDef.value;
-      }
-    }
-
-    return uniforms;
-  }
-}