Class MultiMaterial
Hierarchy
-
Material
- MultiMaterial
Implements
Index
Constructors
Properties
- allow
Shader Hot Swapping - animations
- check
Ready OnEvery Call - check
Ready Only Once - 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 - state
- stencil
- unique
Id - z
Offset - z
Offset Units - All
Dirty Flag - Attributes
Dirty Flag - Clock
Wise Side Orientation - Counter
Clock Wise Side Orientation - 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 - Texture
Dirty Flag - Triangle
Fan Draw Mode - Triangle
Fill Mode - Triangle
Strip Draw Mode - Wire
Frame Fill Mode
Accessors
Methods
- bind
- bind
Eye Position - bind
For Sub Mesh - 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
Children - get
Class Name - get
Effect - get
Scene - get
Sub Material - has
Texture - is
Ready - is
Ready For Sub Mesh - mark
AsDirty - mark
Dirty - need
Alpha Blending - need
Alpha Blending For Mesh - need
Alpha Testing - reset
Draw Cache - serialize
- set
Pre Pass Renderer - to
String - unbind
- unfreeze
- Parse
- Parse
Multi Material
Constructors
constructor
-
Instantiates a new Multi Material A multi-material is used to apply different materials to different parts of the same object without the need of separate meshes. This can be use to improve performances.
Parameters
-
name: string
Define the name in the scene
-
Optional scene: Scene
Define the scene the material belongs to
Returns MultiMaterial
-
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
custom
Custom callback helping to override the default shader used in the material.
Type declaration
-
-
Parameters
-
shaderName: string
-
uniforms: string[]
-
uniformBuffers: string[]
-
samplers: string[]
-
defines: MaterialDefines | string[]
-
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
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 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 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 any
-
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 any
-
back
-
Gets the culling state
Returns boolean
-
Sets the culling state (true to enable culling, false to disable)
Parameters
-
value: boolean
Returns any
-
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 any
-
fill
-
Gets the material fill mode
Returns number
-
Sets the material fill mode
Parameters
-
value: number
Returns any
-
fog
-
Gets the value of the fog enabled state
Returns boolean
-
Sets the state for enabling fog
Parameters
-
value: boolean
Returns any
-
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
-
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 any
-
on
-
Called during a bind event
Parameters
-
callback: (Mesh: AbstractMesh) => void
-
-
Parameters
-
Mesh: AbstractMesh
Returns void
-
-
-
Returns any
-
on
-
An event triggered when the material is bound
Returns Observable<AbstractMesh>
on
-
Called during a dispose event
Parameters
-
callback: () => void
-
-
Returns void
-
-
Returns any
-
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>
points
-
Gets the value specifying if point clouds are enabled
Returns boolean
-
Sets the state of point cloud mode
Parameters
-
value: boolean
Returns any
-
sub
-
Gets or Sets the list of Materials used within the multi material. They need to be ordered according to the submeshes order in the associated mesh
Returns Nullable<Material>[]
-
Gets or Sets the list of Materials used within the multi material. They need to be ordered according to the submeshes order in the associated mesh
Parameters
Returns any
transparency
wireframe
-
Sets the state of wireframe mode
Returns boolean
-
Sets the state of wireframe mode
Parameters
-
value: boolean
Returns any
-
Methods
bindSearch playground for bind
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 world matrix to the material
Parameters
-
world: Matrix
defines the world transformation matrix
Returns void
-
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
-
Clones the current material and its related sub materials
Parameters
-
name: string
Define the name of the newly cloned material
-
Optional cloneChildren: boolean
Define if submaterial will be cloned or shared with the parent instance
Returns MultiMaterial
the cloned material
-
disposeSearch playground for dispose
-
Dispose the material and release its associated resources
Parameters
-
Optional forceDisposeEffect: boolean
Define if we want to force disposing the associated effect (if false the shader is not released and could be reuse later on)
-
Optional forceDisposeTextures: boolean
Define if we want to force disposing the associated textures (if false, they will not be disposed and can still be use elsewhere in the app)
-
Optional forceDisposeChildren: boolean
Define if we want to force disposing the associated submaterials (if false, they will not be disposed and can still be use elsewhere in the app)
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
-
Get the list of active textures for the whole sub materials list.
Returns BaseTexture[]
All the textures that will be used during the rendering
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
get
-
Gets the current class name of the material e.g. "MultiMaterial" Mainly use in serialization.
Returns string
the class name
get
get
-
Returns the current scene
Returns Scene
a Scene
get
has
-
Specifies if any sub-materials of this multi-material use a given texture.
Parameters
-
texture: BaseTexture
Defines the texture to check against this multi-material's sub-materials.
Returns boolean
A boolean specifying if any sub-material of this multi-material uses the texture.
-
is
-
Specifies if the material is ready to be used
Parameters
-
Optional mesh: AbstractMesh
defines the mesh to check
-
Optional useInstances: boolean
specifies if instances should be used
Returns boolean
a boolean indicating if the material is ready to be used
-
is
-
Checks if the material is ready to render the requested sub mesh
Parameters
-
mesh: AbstractMesh
Define the mesh the submesh belongs to
-
subMesh: SubMesh
Define the sub mesh to look readiness for
-
Optional useInstances: boolean
Define whether or not the material is used with instances
Returns boolean
true if ready, otherwise false
-
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
Returns void
need
-
Specifies whether or not this material should be rendered in alpha blend mode.
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 whether or not 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 the materials into a JSON representation.
Returns any
the JSON representation
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.
-
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
Static Parse
-
Creates a MultiMaterial from parsed MultiMaterial data.
Parameters
-
parsedMultiMaterial: any
defines parsed MultiMaterial data.
-
scene: Scene
defines the hosting scene
Returns MultiMaterial
a new MultiMaterial
-
A multi-material is used to apply different materials to different parts of the same object without the need of separate meshes. This can be use to improve performances.
https://doc.babylonjs.com/how_to/multi_materials