Class FireMaterial
Hierarchy
- PushMaterial
- FireMaterial
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 - diffuse
Color - diffuse
Texture - disable
Color Write - disable
Depth Write - distortion
Texture - do
Not Serialize - force
Depth Write - get
Render Target Textures - id
- inspectable
Custom Properties - metadata
- name
- on
Compiled - on
Dispose Observable - on
Error - opacity
Texture - plugin
Manager - point
Size - reserved
Data Store - separate
Culling Pass - shadow
Depth Wrapper - side
Orientation - speed
- 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
- 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
Pre Pass Renderer - to
String - unbind
- unfreeze
- Parse
Constructors
constructor
Parameters
name: string
Optional scene: Scene
Returns FireMaterial
Properties
allow
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
diffuse
diffuse
disable
Specifies if color writing should be disabled
disable
Specifies if depth writing should be disabled
distortion
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
opacity
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
speedSearch playground for speed
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 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
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>
points
Gets the value specifying if point clouds are enabled
Returns boolean
Sets the state of point cloud mode
Parameters
value: boolean
Returns void
transparency
use
In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes) You can try switching to logarithmic depth.
Returns boolean
In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes) You can try switching to logarithmic depth.
Parameters
value: boolean
Returns void
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: FireMaterial) => void)
the callback to be executed that will update the material
Parameters
material: FireMaterial
Returns void
Returns void
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 given normal matrix to the active effect
Parameters
normalMatrix: Matrix
the matrix to bind
Returns void
bind
Binds the given world matrix to the active effect
Parameters
world: Matrix
the matrix to bind
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
Parameters
name: string
Returns FireMaterial
disposeSearch playground for dispose
Parameters
Optional forceDisposeEffect: boolean
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
Returns BaseTexture[]
get
Returns Nullable<BaseTexture>
get
Returns IAnimatable[]
get
Gets the meshes bound to the material
Returns AbstractMesh[]
an array of meshes bound to the material
get
Returns string
get
Returns Effect
get
Returns the current scene
Returns Scene
a Scene
has
Parameters
texture: BaseTexture
Returns boolean
is
Parameters
Optional mesh: AbstractMesh
Optional useInstances: boolean
Returns boolean
is
Parameters
mesh: AbstractMesh
subMesh: SubMesh
Optional useInstances: boolean
Returns boolean
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
Returns boolean
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
Returns boolean
reset
Resets the draw wrappers cache for all submeshes that are using this material
Returns void
serializeSearch playground for serialize
Returns any
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
Parameters
source: any
scene: Scene
rootUrl: string
Returns FireMaterial
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)