Class ShaderMaterial
Hierarchy
- PushMaterial
- ShaderMaterial
Index
Constructors
Properties
- allow
Shader Hot Swapping - animations
- check
Ready On Every Call - check
Ready Only Once - clip
Plane - clip
Plane2 - clip
Plane3 - clip
Plane4 - clip
Plane5 - clip
Plane6 - custom
Shader Name Resolve - depth
Function - disable
Color Write - disable
Depth Write - do
Not Serialize - force
Depth Write - get
Render Target Textures - id
- inspectable
Custom Properties - metadata
- name
- on
Compiled - on
Dispose Observable - on
Error - plugin
Manager - point
Size - reserved
Data Store - separate
Culling Pass - shadow
Depth Wrapper - side
Orientation - snippet
Id - state
- stencil
- unique
Id - z
Offset - z
Offset Units - All
Dirty Flag - Attributes
Dirty Flag - Clock
Wise Side Orientation - Counter
Clock Wise Side Orientation - Create
From Snippet Async - Fresnel
Dirty Flag - Light
Dirty Flag - Line
List Draw Mode - Line
Loop Draw Mode - Line
Strip Draw Mode - MATERIAL_
ALPHABLEND - MATERIAL_
ALPHATEST - MATERIAL_
ALPHATESTANDBLEND - MATERIAL_
NORMALBLENDMETHOD_ RNM - MATERIAL_
NORMALBLENDMETHOD_ WHITEOUT - MATERIAL_
OPAQUE - Misc
Dirty Flag - On
Event Observable - Point
Fill Mode - Point
List Draw Mode - Pre
Pass Dirty Flag - Snippet
Url - Texture
Dirty Flag - Triangle
Fan Draw Mode - Triangle
Fill Mode - Triangle
Strip Draw Mode - Wire
Frame Fill Mode
Accessors
Methods
- atomic
Materials Update - bind
- bind
Eye Position - bind
For Sub Mesh - bind
Only Normal Matrix - bind
Only World Matrix - bind
View - bind
View Projection - build
Uniform Layout - clone
- dispose
- force
Compilation - force
Compilation Async - freeze
- get
Active Textures - get
Alpha Test Texture - get
Animatables - get
Binded Meshes - get
Class Name - get
Effect - get
Scene - has
Texture - is
Ready - is
Ready For Sub Mesh - mark
As Dirty - mark
Dirty - need
Alpha Blending - need
Alpha Blending For Mesh - need
Alpha Testing - reset
Draw Cache - serialize
- set
Array2 - set
Array3 - set
Array4 - set
Color3 - set
Color3 Array - set
Color4 - set
Color4 Array - set
Define - set
External Texture - set
Float - set
Floats - set
Int - set
Matrices - set
Matrix - set
Matrix2x2 - set
Matrix3x3 - set
Pre Pass Renderer - set
Quaternion - set
Quaternion Array - set
Storage Buffer - set
Texture - set
Texture Array - set
Texture Sampler - setUInt
- set
Uniform Buffer - set
Vector2 - set
Vector3 - set
Vector4 - to
String - unbind
- unfreeze
- Parse
- Parse
From File Async - Parse
From Snippet Async
Constructors
constructor
Instantiate a new shader material. The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh. This returned material effects how the mesh will look based on the code in the shaders.
Parameters
name: string
Define the name of the material in the scene
scene: Scene
Define the scene the material belongs to
shaderPath: any
Defines the route to the shader code in one of three ways:
- object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
- object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
- object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
- string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
Optional options: Partial<IShaderMaterialOptions>
Define the options used to create the shader
Optional storeEffectOnSubMeshes: boolean
true to store effect on submeshes, false to store the effect directly in the material class.
Returns ShaderMaterial
Properties
allow
Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping. This means that the material can keep using a previous shader while a new one is being compiled. This is mostly used when shader parallel compilation is supported (true by default)
animationsSearch playground for animations
Stores the animations for the material
check
Specifies if the ready state should be checked on each call
check
Specifies if the ready state should be checked once
clip
Gets or sets the active clipplane 1
clip
Gets or sets the active clipplane 2
clip
Gets or sets the active clipplane 3
clip
Gets or sets the active clipplane 4
clip
Gets or sets the active clipplane 5
clip
Gets or sets the active clipplane 6
custom
Type declaration
Custom callback helping to override the default shader used in the material.
Parameters
shaderName: string
uniforms: string[]
uniformBuffers: string[]
samplers: string[]
defines: string[] | MaterialDefines
Optional attributes: string[]
Optional options: ICustomShaderNameResolveOptions
Returns string
depth
Specifies the depth function that should be used. 0 means the default engine function
disable
Specifies if color writing should be disabled
disable
Specifies if depth writing should be disabled
do
Specifies if the material should be serialized
force
Specifies if depth writing should be forced
get
Callback triggered to get the render target textures
idSearch playground for id
The ID of the material
inspectable
List of inspectable custom properties (used by the Inspector)
metadataSearch playground for metadata
Gets or sets user defined metadata
nameSearch playground for name
The name of the material
on
Callback triggered when the material is compiled
on
An event triggered when the material is disposed
on
Callback triggered when an error occurs
Optional plugin
Plugin manager for this material
point
Stores the size of points
reserved
For internal use only. Please do not use.
separate
Specifies if there should be a separate pass for culling
shadow
Custom shadow depth material to use for shadow rendering instead of the in-built one
side
Stores the value for side orientation
snippet
Snippet ID if the material was created from the snippet server
stateSearch playground for state
The state of the material
Readonly stencilSearch playground for stencil
Gives access to the stencil properties of the material
unique
Gets or sets the unique id of the material
z
Stores the z offset Factor value
z
Stores the z offset Units value
Static Readonly All
The all dirty flag value
Static Readonly Attributes
The dirty attribute flag value
Static Readonly Clock
Stores the clock-wise side orientation
Static Readonly Counter
Stores the counter clock-wise side orientation
Static Create
Type declaration
Creates a ShaderMaterial from a snippet saved by the Inspector
Parameters
snippetId: string
defines the snippet to load
scene: Scene
defines the hosting scene
Optional rootUrl: string
defines the root URL to use to load textures and relative dependencies
Returns Promise<ShaderMaterial>
a promise that will resolve to the new ShaderMaterial
Static Readonly Fresnel
The dirty fresnel flag value
Static Readonly Light
The dirty light flag value
Static Readonly Line
Returns the line list draw mode
Static Readonly Line
Returns the line loop draw mode
Static Readonly Line
Returns the line strip draw mode
Static Readonly MATERIAL_
MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
Static Readonly MATERIAL_
MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
Static Readonly MATERIAL_
MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer. They are also discarded below the alpha cutoff threshold to improve performances.
Static Readonly MATERIAL_
The Reoriented Normal Mapping method is used to blend normals. Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
Static Readonly MATERIAL_
The Whiteout method is used to blend normals. Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
Static Readonly MATERIAL_
MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
Static Readonly Misc
The dirty misc flag value
Static On
Event observable which raises global events common to all materials (like MaterialPluginEvent.Created)
Static Readonly Point
Returns the point fill mode
Static Readonly Point
Returns the point list draw mode
Static Readonly Pre
The dirty prepass flag value
Static Snippet
Define the Url to load snippets
Static Readonly Texture
The dirty texture flag value
Static Readonly Triangle
Returns the triangle fan draw mode
Static Readonly Triangle
Returns the triangle fill mode
Static Readonly Triangle
Returns the triangle strip draw mode
Static Readonly Wire
Returns the wireframe mode
Accessors
alpha
Gets the alpha value of the material
Returns number
Sets the alpha value of the material
Parameters
value: number
Returns void
alpha
Gets the value of the alpha mode
Value Type Description 0 ALPHA_DISABLE 1 ALPHA_ADD 2 ALPHA_COMBINE 3 ALPHA_SUBTRACT 4 ALPHA_MULTIPLY 5 ALPHA_MAXIMIZED 6 ALPHA_ONEONE 7 ALPHA_PREMULTIPLIED 8 ALPHA_PREMULTIPLIED_PORTERDUFF 9 ALPHA_INTERPOLATE 10 ALPHA_SCREENMODE Returns number
Sets the value of the alpha mode.
Value Type Description 0 ALPHA_DISABLE 1 ALPHA_ADD 2 ALPHA_COMBINE 3 ALPHA_SUBTRACT 4 ALPHA_MULTIPLY 5 ALPHA_MAXIMIZED 6 ALPHA_ONEONE 7 ALPHA_PREMULTIPLIED 8 ALPHA_PREMULTIPLIED_PORTERDUFF 9 ALPHA_INTERPOLATE 10 ALPHA_SCREENMODE Parameters
value: number
Returns void
back
Gets the culling state
Returns boolean
Sets the culling state (true to enable culling, false to disable)
Parameters
value: boolean
Returns void
block
Block the dirty-mechanism for this specific material When set to false after being true the material will be marked as dirty.
Returns boolean
Block the dirty-mechanism for this specific material When set to false after being true the material will be marked as dirty.
Parameters
value: boolean
Returns void
can
If the material can be rendered to several textures with MRT extension
Returns boolean
cull
Gets the type of faces that should be culled
Returns boolean
Sets the type of faces that should be culled (true for back faces, false for front faces)
Parameters
value: boolean
Returns void
fill
Gets the material fill mode
Returns number
Sets the material fill mode
Parameters
value: number
Returns void
fog
Gets the value of the fog enabled state
Returns boolean
Sets the state for enabling fog
Parameters
value: boolean
Returns void
has
Gets a boolean indicating that current material needs to register RTT
Returns boolean
is
Specifies if updates for the material been locked
Returns boolean
is
is multiview set to true?
Returns boolean
is
Can this material render to prepass
Returns boolean
need
Gets the depth pre-pass value
Returns boolean
Sets the need depth pre-pass value
Parameters
value: boolean
Returns void
on
Called during a bind event
Parameters
callback: ((Mesh: AbstractMesh) => void)
Parameters
Mesh: AbstractMesh
Returns void
Returns void
on
An event triggered when the material is bound
Returns Observable<AbstractMesh>
on
Called during a dispose event
Parameters
callback: (() => void)
Returns void
Returns void
on
An event triggered when the effect is (re)created
Returns Observable<{ effect: Effect; subMesh: Nullable<SubMesh> }>
on
An event triggered when the material is unbound
Returns Observable<Material>
options
Gets the options used to compile the shader. They can be modified to trigger a new compilation
Returns IShaderMaterialOptions
points
Gets the value specifying if point clouds are enabled
Returns boolean
Sets the state of point cloud mode
Parameters
value: boolean
Returns void
shader
Gets the shader path used to define the shader code It can be modified to trigger a new compilation
Returns any
Sets the shader path used to define the shader code It can be modified to trigger a new compilation
Parameters
shaderPath: any
Returns void
transparency
wireframe
Returns boolean
Sets the state of wireframe mode
Parameters
value: boolean
Returns void
Methods
atomic
This allows you to modify the material without marking it as dirty after every change. This function should be used if you need to make more than one dirty-enabling change to the material - adding a texture, setting a new fill mode and so on. The callback will pass the material as an argument, so you can make your changes to it.
Parameters
callback: ((material: ShaderMaterial) => void)
the callback to be executed that will update the material
Parameters
material: ShaderMaterial
Returns void
Returns void
bindSearch playground for bind
Binds the material to the mesh
Parameters
world: Matrix
defines the world transformation matrix
Optional mesh: Mesh
defines the mesh to bind the material to
Optional effectOverride: Nullable<Effect>
If provided, use this effect instead of internal effect
Optional subMesh: SubMesh
defines the submesh to bind the material to
Returns void
bind
Binds the view matrix to the effect
Parameters
effect: Effect
defines the effect to bind the view matrix to
Optional variableName: string
name of the shader variable that will hold the eye position
Returns void
bind
bind
Binds the given normal matrix to the active effect
Parameters
normalMatrix: Matrix
the matrix to bind
Returns void
bind
bind
Binds the view matrix to the effect
Parameters
effect: Effect
defines the effect to bind the view matrix to
Returns void
bind
Binds the view projection and projection matrices to the effect
Parameters
effect: Effect
defines the effect to bind the view projection and projection matrices to
Returns void
build
Initializes the uniform buffer layout for the shader.
Returns void
cloneSearch playground for clone
Makes a duplicate of the material, and gives it a new name
Parameters
name: string
defines the new name for the duplicated material
Returns ShaderMaterial
the cloned material
disposeSearch playground for dispose
Disposes the material
Parameters
Optional forceDisposeEffect: boolean
specifies if effects should be forcefully disposed
Optional forceDisposeTextures: boolean
specifies if textures should be forcefully disposed
Optional notBoundToMesh: boolean
specifies if the material that is being disposed is known to be not bound to any mesh
Returns void
force
Force shader compilation
Parameters
mesh: AbstractMesh
defines the mesh associated with this material
Optional onCompiled: ((material: Material) => void)
defines a function to execute once the material is compiled
Parameters
material: Material
Returns void
Optional options: Partial<IMaterialCompilationOptions>
defines the options to configure the compilation
Optional onError: ((reason: string) => void)
defines a function to execute if the material fails compiling
Parameters
reason: string
Returns void
Returns void
force
Force shader compilation
Parameters
mesh: AbstractMesh
defines the mesh that will use this material
Optional options: Partial<IMaterialCompilationOptions>
defines additional options for compiling the shaders
Returns Promise<void>
a promise that resolves when the compilation completes
freezeSearch playground for freeze
Locks updates for the material
Returns void
get
Gets the active textures from the material
Returns BaseTexture[]
an array of textures
get
Gets the texture used for the alpha test
Returns Nullable<BaseTexture>
the texture to use for alpha testing
get
Returns the animatable textures.
Returns IAnimatable[]
- Array of animatable textures.
get
Gets the meshes bound to the material
Returns AbstractMesh[]
an array of meshes bound to the material
get
Gets the current class name of the material e.g. "ShaderMaterial" Mainly use in serialization.
Returns string
the class name
get
Returns Effect
get
Returns the current scene
Returns Scene
a Scene
has
Specifies if the material uses a texture
Parameters
texture: BaseTexture
defines the texture to check against the material
Returns boolean
a boolean specifying if the material uses the texture
is
Checks if the material is ready to render the requested mesh
Parameters
Optional mesh: AbstractMesh
Define the mesh to render
Optional useInstances: boolean
Define whether or not the material is used with instances
Optional subMesh: SubMesh
defines which submesh to render
Returns boolean
true if ready, otherwise false
is
Specifies that the submesh is ready to be used
Parameters
mesh: AbstractMesh
defines the mesh to check
subMesh: SubMesh
defines which submesh to check
Optional useInstances: boolean
specifies that instances should be used
Returns boolean
a boolean indicating that the submesh is ready or not
mark
Marks a define in the material to indicate that it needs to be re-computed
Parameters
flag: number
defines a flag used to determine which parts of the material have to be marked as dirty
Returns void
mark
Marks the material to indicate that it needs to be re-calculated
Parameters
Optional forceMaterialDirty: boolean
Forces the material to be marked as dirty for all components (same as this.markAsDirty(Material.AllDirtyFlag)). You should use this flag if the material is frozen and you want to force a recompilation.
Returns void
need
Specifies if the material will require alpha blending
Returns boolean
a boolean specifying if alpha blending is needed
need
Specifies if the mesh will require alpha blending
Parameters
mesh: AbstractMesh
defines the mesh to check
Returns boolean
a boolean specifying if alpha blending is needed for the mesh
need
Specifies if this material should be rendered in alpha test mode
Returns boolean
a boolean specifying if an alpha test is needed.
reset
Resets the draw wrappers cache for all submeshes that are using this material
Returns void
serializeSearch playground for serialize
Serializes this material in a JSON representation
Returns any
the serialized material object
set
Set a vec2 array in the shader from a number array.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: number[]
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec3 array in the shader from a number array.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: number[]
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec4 array in the shader from a number array.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: number[]
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec3 in the shader from a Color3.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Color3
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec3 array in the shader from a Color3 array.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Color3[]
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec4 in the shader from a Color4.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Color4
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec4 array in the shader from a Color4 array.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Color4[]
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Adds, removes, or replaces the specified shader define and value.
- setDefine("MY_DEFINE", true); // enables a boolean define
- setDefine("MY_DEFINE", "0.5"); // adds "#define MY_DEFINE 0.5" to the shader (or sets and replaces the value of any existing define with that name)
- setDefine("MY_DEFINE", false); // disables and removes the define Note if the active defines do change, the shader will be recompiled and this can be expensive.
Parameters
define: string
the define name e.g., "OUTPUT_TO_SRGB" or "#define OUTPUT_TO_SRGB". If the define was passed into the constructor already, the version used should match that, and in either case, it should not include any appended value.
value: string | boolean
either the value of the define (e.g. a numerical value) or for booleans, true if the define should be enabled or false if it should be disabled
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set an internal texture in the shader.
Parameters
name: string
Define the name of the uniform samplers as defined in the shader
texture: ExternalTexture
Define the texture to bind to this sampler
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a float in the shader.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: number
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set an array of floats in the shader.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: number[]
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a int in the shader.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: number
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a float32Array in the shader from a matrix array.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Matrix[]
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a mat4 in the shader from a Matrix.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Matrix
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a mat2 in the shader from a Float32Array.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: number[] | Float32Array
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a mat3 in the shader from a Float32Array.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: number[] | Float32Array
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Sets the required values to the prepass renderer.
Parameters
prePassRenderer: PrePassRenderer
defines the prepass renderer to setup.
Returns boolean
true if the pre pass is needed.
set
Set a vec4 in the shader from a Quaternion.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Quaternion
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec4 array in the shader from a Quaternion array.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Quaternion[]
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a storage buffer in the shader
Parameters
name: string
Define the name of the storage buffer as defined in the shader
buffer: StorageBuffer
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a texture in the shader.
Parameters
name: string
Define the name of the uniform samplers as defined in the shader
texture: BaseTexture
Define the texture to bind to this sampler
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a texture array in the shader.
Parameters
name: string
Define the name of the uniform sampler array as defined in the shader
textures: BaseTexture[]
Define the list of textures to bind to this sampler
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a texture sampler in the shader
Parameters
name: string
Define the name of the uniform as defined in the shader
sampler: TextureSampler
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
setUIntSearch playground for setUInt
Set a unsigned int in the shader.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: number
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a uniform buffer in the shader
Parameters
name: string
Define the name of the uniform as defined in the shader
buffer: UniformBuffer
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec2 in the shader from a Vector2.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Vector2
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec3 in the shader from a Vector3.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Vector3
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
set
Set a vec4 in the shader from a Vector4.
Parameters
name: string
Define the name of the uniform as defined in the shader
value: Vector4
Define the value to give to the uniform
Returns ShaderMaterial
the material itself allowing "fluent" like uniform updates
to
Returns a string representation of the current material
Parameters
Optional fullDetails: boolean
defines a boolean indicating which levels of logging is desired
Returns string
a string with material information
unbindSearch playground for unbind
Unbinds the material from the mesh
Returns void
unfreezeSearch playground for unfreeze
Unlocks updates for the material
Returns void
Static ParseSearch playground for Parse
Creates a shader material from parsed shader material data
Parameters
source: any
defines the JSON representation of the material
scene: Scene
defines the hosting scene
rootUrl: string
defines the root URL to use to load textures and relative dependencies
Returns ShaderMaterial
a new material
Static Parse
Creates a new ShaderMaterial from a snippet saved in a remote file
Parameters
name: Nullable<string>
defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
url: string
defines the url to load from
scene: Scene
defines the hosting scene
Optional rootUrl: string
defines the root URL to use to load textures and relative dependencies
Returns Promise<ShaderMaterial>
a promise that will resolve to the new ShaderMaterial
Static Parse
Creates a ShaderMaterial from a snippet saved by the Inspector
Parameters
snippetId: string
defines the snippet to load
scene: Scene
defines the hosting scene
Optional rootUrl: string
defines the root URL to use to load textures and relative dependencies
Returns Promise<ShaderMaterial>
a promise that will resolve to the new ShaderMaterial
The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
This returned material effects how the mesh will look based on the code in the shaders.
https://doc.babylonjs.com/features/featuresDeepDive/materials/shaders/shaderMaterial