Renamed internal class ShaderUtils to ShaderDefinitionUtils (#7652)

mvaligursky · Martin Valigursky · web-flow · commit ca16243422d8 · 2025-05-07T16:14:14.000+01:00
* Renamed internal class ShaderUtils to ShaderDefinitionUtils

* comment

---------

Co-authored-by: Martin Valigursky &lt;mvaligursky@snapchat.com&gt;
diff --git a/src/platform/graphics/shader-definition-utils.js b/src/platform/graphics/shader-definition-utils.js
@@ -37,11 +37,11 @@ const _attrib2Semantic = {
 };
 
 /**
- * A class providing utility functions for shader creation.
+ * A class providing utility functions for shader definition creation.
  *
  * @ignore
  */
-class ShaderUtils {
+class ShaderDefinitionUtils {
     /**
      * Creates a shader definition.
      *
@@ -110,8 +110,8 @@ class ShaderUtils {
         let vertCode;
         let fragCode;
 
-        const vertexDefinesCode = ShaderUtils.getDefinesCode(device, options.vertexDefines);
-        const fragmentDefinesCode = ShaderUtils.getDefinesCode(device, options.fragmentDefines);
+        const vertexDefinesCode = ShaderDefinitionUtils.getDefinesCode(device, options.vertexDefines);
+        const fragmentDefinesCode = ShaderDefinitionUtils.getDefinesCode(device, options.fragmentDefines);
         const wgsl = options.shaderLanguage === SHADERLANGUAGE_WGSL;
 
         if (wgsl) {
@@ -133,22 +133,22 @@ class ShaderUtils {
         } else {
 
             // vertex code
-            vertCode = `${ShaderUtils.versionCode(device) +
+            vertCode = `${ShaderDefinitionUtils.versionCode(device) +
                 getDefines(webgpuVS, gles3VS, true, options) +
                 vertexDefinesCode +
-                ShaderUtils.precisionCode(device)}
+                ShaderDefinitionUtils.precisionCode(device)}
                 ${sharedGLSL}
-                ${ShaderUtils.getShaderNameCode(name)}
+                ${ShaderDefinitionUtils.getShaderNameCode(name)}
                 ${options.vertexCode}`;
 
             // fragment code
             fragCode = `${(options.fragmentPreamble || '') +
-                ShaderUtils.versionCode(device) +
+                ShaderDefinitionUtils.versionCode(device) +
                 getDefines(webgpuFS, gles3FS, false, options) +
                 fragmentDefinesCode +
-                ShaderUtils.precisionCode(device)}
+                ShaderDefinitionUtils.precisionCode(device)}
                 ${sharedGLSL}
-                ${ShaderUtils.getShaderNameCode(name)}
+                ${ShaderDefinitionUtils.getShaderNameCode(name)}
                 ${options.fragmentCode}`;
         }
 
@@ -279,4 +279,4 @@ class ShaderUtils {
     }
 }
 
-export { ShaderUtils };
+export { ShaderDefinitionUtils };
diff --git a/src/platform/graphics/shader.js b/src/platform/graphics/shader.js
@@ -4,7 +4,7 @@ import { platform } from '../../core/platform.js';
 import { Preprocessor } from '../../core/preprocessor.js';
 import { SHADERLANGUAGE_GLSL, SHADERLANGUAGE_WGSL } from './constants.js';
 import { DebugGraphics } from './debug-graphics.js';
-import { ShaderUtils } from './shader-utils.js';
+import { ShaderDefinitionUtils } from './shader-definition-utils.js';
 
 /**
  * @import { BindGroupFormat } from './bind-group-format.js'
@@ -143,7 +143,7 @@ class Shader {
 
             // if no attributes are specified, try to extract the default names after the shader has been pre-processed
             if (definition.shaderLanguage === SHADERLANGUAGE_GLSL) {
-                definition.attributes ??= ShaderUtils.collectAttributes(definition.vshader);
+                definition.attributes ??= ShaderDefinitionUtils.collectAttributes(definition.vshader);
             }
 
             // Strip unused color attachments from fragment shader.
diff --git a/src/platform/graphics/transform-feedback.js b/src/platform/graphics/transform-feedback.js
@@ -3,7 +3,7 @@ import { BUFFER_GPUDYNAMIC, PRIMITIVE_POINTS } from './constants.js';
 import { VertexBuffer } from './vertex-buffer.js';
 import { DebugGraphics } from './debug-graphics.js';
 import { Shader } from './shader.js';
-import { ShaderUtils } from './shader-utils.js';
+import { ShaderDefinitionUtils } from './shader-definition-utils.js';
 
 /**
  * @import { GraphicsDevice } from './graphics-device.js'
@@ -120,7 +120,7 @@ class TransformFeedback {
      * @returns {Shader} A shader to use in the process() function.
      */
     static createShader(graphicsDevice, vertexCode, name) {
-        return new Shader(graphicsDevice, ShaderUtils.createDefinition(graphicsDevice, {
+        return new Shader(graphicsDevice, ShaderDefinitionUtils.createDefinition(graphicsDevice, {
             name,
             vertexCode,
             useTransformFeedback: true,
diff --git a/src/scene/materials/shader-material.js b/src/scene/materials/shader-material.js
@@ -23,7 +23,7 @@ import { Material } from './material.js';
  * inputs to the shader. Defaults to undefined, which generates the default attributes.
  * @property {string | string[]} [fragmentOutputTypes] - Fragment shader output types, which default to
  * vec4. Passing a string will set the output type for all color attachments. Passing an array will
- * set the output type for each color attachment. @see ShaderUtils.createDefinition
+ * set the output type for each color attachment. @see ShaderDefinitionUtils.createDefinition
  */
 
 /**
diff --git a/src/scene/shader-lib/programs/lit.js b/src/scene/shader-lib/programs/lit.js
@@ -2,7 +2,7 @@ import { LitShader } from './lit-shader.js';
 import { LitOptionsUtils } from './lit-options-utils.js';
 import { ShaderGenerator } from './shader-generator.js';
 import { SHADERLANGUAGE_GLSL, SHADERLANGUAGE_WGSL, SHADERTAG_MATERIAL } from '../../../platform/graphics/constants.js';
-import { ShaderUtils } from '../../../platform/graphics/shader-utils.js';
+import { ShaderDefinitionUtils } from '../../../platform/graphics/shader-definition-utils.js';
 import { hashCode } from '../../../core/hash.js';
 
 /**
@@ -68,7 +68,7 @@ class ShaderGeneratorLit extends ShaderGenerator {
         definitionOptions.fragmentIncludes = includes;
         definitionOptions.fragmentDefines = fDefines;
 
-        return ShaderUtils.createDefinition(device, definitionOptions);
+        return ShaderDefinitionUtils.createDefinition(device, definitionOptions);
     }
 }
 
diff --git a/src/scene/shader-lib/programs/particle.js b/src/scene/shader-lib/programs/particle.js
@@ -1,5 +1,5 @@
 import { SEMANTIC_POSITION, SEMANTIC_TEXCOORD0, SHADERLANGUAGE_GLSL, SHADERLANGUAGE_WGSL } from '../../../platform/graphics/constants.js';
-import { ShaderUtils } from '../../../platform/graphics/shader-utils.js';
+import { ShaderDefinitionUtils } from '../../../platform/graphics/shader-definition-utils.js';
 import { blendNames } from '../../constants.js';
 import { shaderChunksWGSL } from '../chunks-wgsl/chunks-wgsl.js';
 import { shaderChunks } from '../chunks/chunks.js';
@@ -81,7 +81,7 @@ class ShaderGeneratorParticle extends ShaderGenerator {
             ...options.chunks
         }));
 
-        return ShaderUtils.createDefinition(device, {
+        return ShaderDefinitionUtils.createDefinition(device, {
             name: 'ParticleShader',
             shaderLanguage: shaderLanguage,
             attributes: attributes,
diff --git a/src/scene/shader-lib/programs/shader-generator-shader.js b/src/scene/shader-lib/programs/shader-generator-shader.js
@@ -1,6 +1,6 @@
 import { hashCode } from '../../../core/hash.js';
 import { SEMANTIC_ATTR15, SEMANTIC_BLENDINDICES, SEMANTIC_BLENDWEIGHT, SHADERLANGUAGE_GLSL, SHADERLANGUAGE_WGSL } from '../../../platform/graphics/constants.js';
-import { ShaderUtils } from '../../../platform/graphics/shader-utils.js';
+import { ShaderDefinitionUtils } from '../../../platform/graphics/shader-definition-utils.js';
 import { shaderChunksWGSL } from '../chunks-wgsl/chunks-wgsl.js';
 import { shaderChunks } from '../chunks/chunks.js';
 import { ShaderGenerator } from './shader-generator.js';
@@ -105,7 +105,7 @@ class ShaderGeneratorShader extends ShaderGenerator {
         this.createVertexDefinition(definitionOptions, options, sharedIncludes, wgsl);
         this.createFragmentDefinition(definitionOptions, options, sharedIncludes, wgsl);
 
-        return ShaderUtils.createDefinition(device, definitionOptions);
+        return ShaderDefinitionUtils.createDefinition(device, definitionOptions);
     }
 }
 
diff --git a/src/scene/shader-lib/programs/standard.js b/src/scene/shader-lib/programs/standard.js
@@ -10,7 +10,7 @@ import { ChunkUtils } from '../chunk-utils.js';
 import { StandardMaterialOptions } from '../../materials/standard-material-options.js';
 import { LitOptionsUtils } from './lit-options-utils.js';
 import { ShaderGenerator } from './shader-generator.js';
-import { ShaderUtils } from '../../../platform/graphics/shader-utils.js';
+import { ShaderDefinitionUtils } from '../../../platform/graphics/shader-definition-utils.js';
 import { SHADERLANGUAGE_GLSL, SHADERLANGUAGE_WGSL, SHADERTAG_MATERIAL } from '../../../platform/graphics/constants.js';
 
 /**
@@ -445,7 +445,7 @@ class ShaderGeneratorStandard extends ShaderGenerator {
 
         options.defines.forEach((value, key) => fDefines.set(key, value));
 
-        const definition = ShaderUtils.createDefinition(device, {
+        const definition = ShaderDefinitionUtils.createDefinition(device, {
             name: 'StandardShader',
             attributes: litShader.attributes,
             shaderLanguage: shaderLanguage,
diff --git a/src/scene/shader-lib/utils.js b/src/scene/shader-lib/utils.js
@@ -1,5 +1,5 @@
 import { Shader } from '../../platform/graphics/shader.js';
-import { ShaderUtils } from '../../platform/graphics/shader-utils.js';
+import { ShaderDefinitionUtils } from '../../platform/graphics/shader-definition-utils.js';
 import { shaderChunks } from './chunks/chunks.js';
 import { getProgramLibrary } from './get-program-library.js';
 import { Debug } from '../../core/debug.js';
@@ -28,7 +28,7 @@ import { ShaderPass } from '../shader-pass.js';
  * @param {string | string[]} [shaderDefinitionOptions.fragmentOutputTypes] - Fragment shader
  * output types, which default to vec4. Passing a string will set the output type for all color
  * attachments. Passing an array will set the output type for each color attachment.
- * @see ShaderUtils.createDefinition
+ * @see ShaderDefinitionUtils.createDefinition
  * @returns {Shader} The newly created shader.
  * @category Graphics
  */
@@ -44,7 +44,7 @@ function createShader(device, vsName, fsName, useTransformFeedback = false, shad
         };
     }
 
-    return new Shader(device, ShaderUtils.createDefinition(device, {
+    return new Shader(device, ShaderDefinitionUtils.createDefinition(device, {
         ...shaderDefinitionOptions,
         name: `${vsName}_${fsName}`,
         vertexCode: shaderChunks[vsName],
@@ -75,7 +75,7 @@ function createShader(device, vsName, fsName, useTransformFeedback = false, shad
  * @param {string | string[]} [shaderDefinitionOptions.fragmentOutputTypes] - Fragment shader
  * output types, which default to vec4. Passing a string will set the output type for all color
  * attachments. Passing an array will set the output type for each color attachment.
- * @see ShaderUtils.createDefinition
+ * @see ShaderDefinitionUtils.createDefinition
  * @returns {Shader} The newly created shader.
  * @category Graphics
  */
@@ -97,7 +97,7 @@ function createShaderFromCode(device, vsCode, fsCode, uniqueName, attributes, us
     const programLibrary = getProgramLibrary(device);
     let shader = programLibrary.getCachedShader(uniqueName);
     if (!shader) {
-        shader = new Shader(device, ShaderUtils.createDefinition(device, {
+        shader = new Shader(device, ShaderDefinitionUtils.createDefinition(device, {
             ...shaderDefinitionOptions,
             name: uniqueName,
             vertexCode: vsCode,

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import { LitShader } from './lit-shader.js';`
`2`	`2`	`import { LitOptionsUtils } from './lit-options-utils.js';`
`3`	`3`	`import { ShaderGenerator } from './shader-generator.js';`
`4`	`4`	`import { SHADERLANGUAGE_GLSL, SHADERLANGUAGE_WGSL, SHADERTAG_MATERIAL } from '../../../platform/graphics/constants.js';`
`5`		`-import { ShaderUtils } from '../../../platform/graphics/shader-utils.js';`
	`5`	`+import { ShaderDefinitionUtils } from '../../../platform/graphics/shader-definition-utils.js';`
`6`	`6`	`import { hashCode } from '../../../core/hash.js';`
`7`	`7`
`8`	`8`	`/**`
`@@ -68,7 +68,7 @@ class ShaderGeneratorLit extends ShaderGenerator {`
`68`	`68`	`definitionOptions.fragmentIncludes = includes;`
`69`	`69`	`definitionOptions.fragmentDefines = fDefines;`
`70`	`70`
`71`		`- return ShaderUtils.createDefinition(device, definitionOptions);`
	`71`	`+ return ShaderDefinitionUtils.createDefinition(device, definitionOptions);`
`72`	`72`	`}`
`73`	`73`	`}`
`74`	`74`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import { hashCode } from '../../../core/hash.js';`
`2`	`2`	`import { SEMANTIC_ATTR15, SEMANTIC_BLENDINDICES, SEMANTIC_BLENDWEIGHT, SHADERLANGUAGE_GLSL, SHADERLANGUAGE_WGSL } from '../../../platform/graphics/constants.js';`
`3`		`-import { ShaderUtils } from '../../../platform/graphics/shader-utils.js';`
	`3`	`+import { ShaderDefinitionUtils } from '../../../platform/graphics/shader-definition-utils.js';`
`4`	`4`	`import { shaderChunksWGSL } from '../chunks-wgsl/chunks-wgsl.js';`
`5`	`5`	`import { shaderChunks } from '../chunks/chunks.js';`
`6`	`6`	`import { ShaderGenerator } from './shader-generator.js';`
`@@ -105,7 +105,7 @@ class ShaderGeneratorShader extends ShaderGenerator {`
`105`	`105`	`this.createVertexDefinition(definitionOptions, options, sharedIncludes, wgsl);`
`106`	`106`	`this.createFragmentDefinition(definitionOptions, options, sharedIncludes, wgsl);`
`107`	`107`
`108`		`- return ShaderUtils.createDefinition(device, definitionOptions);`
	`108`	`+ return ShaderDefinitionUtils.createDefinition(device, definitionOptions);`
`109`	`109`	`}`
`110`	`110`	`}`
`111`	`111`