FireMaterial | Babylon.js API documentation

Class FireMaterial

Hierarchy

PushMaterial
- FireMaterial

Index

Constructors

Properties

allowShaderHotSwapping animations checkReadyOnEveryCall checkReadyOnlyOnce clipPlane clipPlane2 clipPlane3 clipPlane4 clipPlane5 clipPlane6 customShaderNameResolve depthFunction diffuseColor diffuseTexture disableColorWrite disableDepthWrite distortionTexture doNotSerialize forceDepthWrite getRenderTargetTextures id inspectableCustomProperties metadata name onCompiled onDisposeObservable onError opacityTexture pluginManager? pointSize reservedDataStore separateCullingPass shadowDepthWrapper sideOrientation speed state stencil uniqueId zOffset zOffsetUnits AllDirtyFlag AttributesDirtyFlag ClockWiseSideOrientation CounterClockWiseSideOrientation FresnelDirtyFlag ImageProcessingDirtyFlag LightDirtyFlag LineListDrawMode LineLoopDrawMode LineStripDrawMode MATERIAL_ALPHABLEND MATERIAL_ALPHATEST MATERIAL_ALPHATESTANDBLEND MATERIAL_NORMALBLENDMETHOD_RNM MATERIAL_NORMALBLENDMETHOD_WHITEOUT MATERIAL_OPAQUE MiscDirtyFlag OnEventObservable PointFillMode PointListDrawMode PrePassDirtyFlag TextureDirtyFlag TriangleFanDrawMode TriangleFillMode TriangleStripDrawMode WireFrameFillMode

Constructors

constructor

new FireMaterial(name: string, scene?: Scene): FireMaterial
Parameters
- name: string
- Optionalscene: Scene
Returns FireMaterial
Overrides PushMaterial.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145714

Properties

allowShaderHotSwapping

allowShaderHotSwapping: boolean

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)

animations

animations: Nullable<Animation[]>

Stores the animations for the material

checkReadyOnEveryCall

checkReadyOnEveryCall: boolean

Specifies if the ready state should be checked on each call

checkReadyOnlyOnce

checkReadyOnlyOnce: boolean

Specifies if the ready state should be checked once

clipPlane

clipPlane: Nullable<Plane>

Gets or sets the active clipplane 1

clipPlane2

clipPlane2: Nullable<Plane>

Gets or sets the active clipplane 2

clipPlane3

clipPlane3: Nullable<Plane>

Gets or sets the active clipplane 3

clipPlane4

clipPlane4: Nullable<Plane>

Gets or sets the active clipplane 4

clipPlane5

clipPlane5: Nullable<Plane>

Gets or sets the active clipplane 5

clipPlane6

clipPlane6: Nullable<Plane>

Gets or sets the active clipplane 6

customShaderNameResolve

customShaderNameResolve: (
    shaderName: string,
    uniforms: string[],
    uniformBuffers: string[],
    samplers: string[],
    defines: string[] | MaterialDefines,
    attributes?: string[],
    options?: ICustomShaderNameResolveOptions,
) => string

Custom callback helping to override the default shader used in the material.

depthFunction

depthFunction: number

Specifies the depth function that should be used. 0 means the default engine function

diffuseColor

diffuseColor: Color3

diffuseTexture

diffuseTexture: Nullable<BaseTexture>

disableColorWrite

disableColorWrite: boolean

Specifies if color writing should be disabled

disableDepthWrite

disableDepthWrite: boolean

Specifies if depth writing should be disabled

distortionTexture

distortionTexture: Nullable<BaseTexture>

doNotSerialize

doNotSerialize: boolean

Specifies if the material should be serialized

forceDepthWrite

forceDepthWrite: boolean

Specifies if depth writing should be forced

getRenderTargetTextures

getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>

Callback triggered to get the render target textures

id

id: string

The ID of the material

inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

See

https://doc.babylonjs.com/toolsAndResources/inspector#extensibility

metadata

metadata: any

Gets or sets user defined metadata

name

name: string

The name of the material

onCompiled

onCompiled: Nullable<(effect: Effect) => void>

Callback triggered when the material is compiled

onDisposeObservable

onDisposeObservable: Observable<Material>

An event triggered when the material is disposed

onError

onError: Nullable<(effect: Effect, errors: string) => void>

Callback triggered when an error occurs

opacityTexture

opacityTexture: Nullable<BaseTexture>

`Optional`pluginManager

pluginManager?: MaterialPluginManager

Plugin manager for this material

pointSize

pointSize: number

Stores the size of points

reservedDataStore

reservedDataStore: any

For internal use only. Please do not use.

separateCullingPass

separateCullingPass: boolean

Specifies if there should be a separate pass for culling

shadowDepthWrapper

shadowDepthWrapper: Nullable<ShadowDepthWrapper>

Custom shadow depth material to use for shadow rendering instead of the in-built one

sideOrientation

sideOrientation: Nullable<number>

Stores the value for side orientation

speed

speed: number

state

state: string

The state of the material

`Readonly`stencil

stencil: MaterialStencilState

Gives access to the stencil properties of the material

uniqueId

uniqueId: number

Gets or sets the unique id of the material

zOffset

zOffset: number

Stores the z offset Factor value

zOffsetUnits

zOffsetUnits: number

Stores the z offset Units value

`Static` `Readonly`AllDirtyFlag

AllDirtyFlag: 127

The all dirty flag value

`Static` `Readonly`AttributesDirtyFlag

AttributesDirtyFlag: 8

The dirty attribute flag value

`Static` `Readonly`ClockWiseSideOrientation

ClockWiseSideOrientation: 0

Stores the clock-wise side orientation

`Static` `Readonly`CounterClockWiseSideOrientation

CounterClockWiseSideOrientation: 1

Stores the counter clock-wise side orientation

`Static` `Readonly`FresnelDirtyFlag

FresnelDirtyFlag: 4

The dirty fresnel flag value

`Static` `Readonly`ImageProcessingDirtyFlag

ImageProcessingDirtyFlag: 64

The dirty image processing flag value

`Static` `Readonly`LightDirtyFlag

LightDirtyFlag: 2

The dirty light flag value

`Static` `Readonly`LineListDrawMode

LineListDrawMode: 4

Returns the line list draw mode

`Static` `Readonly`LineLoopDrawMode

LineLoopDrawMode: 5

Returns the line loop draw mode

`Static` `Readonly`LineStripDrawMode

LineStripDrawMode: 6

Returns the line strip draw mode

`Static` `Readonly`MATERIAL_ALPHABLEND

MATERIAL_ALPHABLEND: 2

MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.

`Static` `Readonly`MATERIAL_ALPHATEST

MATERIAL_ALPHATEST: 1

MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.

`Static` `Readonly`MATERIAL_ALPHATESTANDBLEND

MATERIAL_ALPHATESTANDBLEND: 3

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_NORMALBLENDMETHOD_RNM

MATERIAL_NORMALBLENDMETHOD_RNM: 1

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_NORMALBLENDMETHOD_WHITEOUT

MATERIAL_NORMALBLENDMETHOD_WHITEOUT: 0

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_OPAQUE

MATERIAL_OPAQUE: 0

MaterialTransparencyMode: No transparency mode, Alpha channel is not use.

`Static` `Readonly`MiscDirtyFlag

MiscDirtyFlag: 16

The dirty misc flag value

`Static`OnEventObservable

OnEventObservable: Observable<Material>

Event observable which raises global events common to all materials (like MaterialPluginEvent.Created)

`Static` `Readonly`PointFillMode

PointFillMode: 2

Returns the point fill mode

`Static` `Readonly`PointListDrawMode

PointListDrawMode: 3

Returns the point list draw mode

`Static` `Readonly`PrePassDirtyFlag

PrePassDirtyFlag: 32

The dirty prepass flag value

`Static` `Readonly`TextureDirtyFlag

TextureDirtyFlag: 1

The dirty texture flag value

`Static` `Readonly`TriangleFanDrawMode

TriangleFanDrawMode: 8

Returns the triangle fan draw mode

`Static` `Readonly`TriangleFillMode

TriangleFillMode: 0

Returns the triangle fill mode

`Static` `Readonly`TriangleStripDrawMode

TriangleStripDrawMode: 7

Returns the triangle strip draw mode

`Static` `Readonly`WireFrameFillMode

WireFrameFillMode: 1

Returns the wireframe mode

Accessors

alpha

get alpha(): number
Gets the alpha value of the material

Returns number
Inherited from PushMaterial.alpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73131
set alpha(value: number): void
Sets the alpha value of the material
Parameters
- value: number
Returns void
Inherited from PushMaterial.alpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73127

alphaMode

get alphaMode(): number
Gets the value of the alpha mode

Returns number
Inherited from PushMaterial.alphaMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73269

set alphaMode(value: number): void

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

backFaceCulling

get backFaceCulling(): boolean
Gets the culling state

Returns boolean
Inherited from PushMaterial.backFaceCulling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73143
set backFaceCulling(value: boolean): void
Sets the culling state (true to enable culling, false to disable)
Parameters
- value: boolean
Returns void
Inherited from PushMaterial.backFaceCulling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73139

blockDirtyMechanism

get blockDirtyMechanism(): boolean
Block the dirty-mechanism for this specific material When set to false after being true the material will be marked as dirty.

Returns boolean
Inherited from PushMaterial.blockDirtyMechanism
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73161
set blockDirtyMechanism(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PushMaterial.blockDirtyMechanism
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73162

canRenderToMRT

get canRenderToMRT(): boolean
If the material can be rendered to several textures with MRT extension

Returns boolean
Inherited from PushMaterial.canRenderToMRT
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73114

cullBackFaces

get cullBackFaces(): boolean
Gets the type of faces that should be culled

Returns boolean
Inherited from PushMaterial.cullBackFaces
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73155
set cullBackFaces(value: boolean): void
Sets the type of faces that should be culled (true for back faces, false for front faces)
Parameters
- value: boolean
Returns void
Inherited from PushMaterial.cullBackFaces
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73151

fillMode

get fillMode(): number
Gets the material fill mode

Returns number
Inherited from PushMaterial.fillMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73346
set fillMode(value: number): void
Sets the material fill mode
Parameters
- value: number
Returns void
Inherited from PushMaterial.fillMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73350

fogEnabled

get fogEnabled(): boolean
Gets the value of the fog enabled state

Returns boolean
Inherited from PushMaterial.fogEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73317
set fogEnabled(value: boolean): void
Sets the state for enabling fog
Parameters
- value: boolean
Returns void
Inherited from PushMaterial.fogEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73313

hasRenderTargetTextures

get hasRenderTargetTextures(): boolean
Gets a boolean indicating that current material needs to register RTT

Returns boolean
Inherited from PushMaterial.hasRenderTargetTextures
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73189

isFrozen

get isFrozen(): boolean
Specifies if updates for the material been locked

Returns boolean
Inherited from PushMaterial.isFrozen
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73486

isPrePassCapable

get isPrePassCapable(): boolean
Can this material render to prepass

Returns boolean
Inherited from PushMaterial.isPrePassCapable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73285

needDepthPrePass

get needDepthPrePass(): boolean
Gets the depth pre-pass value

Returns boolean
Inherited from PushMaterial.needDepthPrePass
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73281
set needDepthPrePass(value: boolean): void
Sets the need depth pre-pass value
Parameters
- value: boolean
Returns void
Inherited from PushMaterial.needDepthPrePass
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73277

onBind

set onBind(callback: (Mesh: AbstractMesh) => void): void
Called during a bind event
Parameters
- callback: (Mesh: AbstractMesh) => void
Returns void
Inherited from PushMaterial.onBind
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73227

onBindObservable

get onBindObservable(): Observable<AbstractMesh>
An event triggered when the material is bound

Returns Observable<AbstractMesh>
Inherited from PushMaterial.onBindObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73219

onDispose

set onDispose(callback: () => void): void
Called during a dispose event
Parameters
- callback: () => void
Returns void
Inherited from PushMaterial.onDispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73214

onEffectCreatedObservable

get onEffectCreatedObservable(): Observable<
{ effect: Effect; subMesh: Nullable<SubMesh> },
>
An event triggered when the effect is (re)created

Returns Observable<{ effect: Effect; subMesh: Nullable<SubMesh> }>
Inherited from PushMaterial.onEffectCreatedObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73239

onUnBindObservable

get onUnBindObservable(): Observable<Material>
An event triggered when the material is unbound

Returns Observable<Material>
Inherited from PushMaterial.onUnBindObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73231

pointsCloud

get pointsCloud(): boolean
Gets the value specifying if point clouds are enabled

Returns boolean
Inherited from PushMaterial.pointsCloud
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73338
set pointsCloud(value: boolean): void
Sets the state of point cloud mode
Parameters
- value: boolean
Returns void
Inherited from PushMaterial.pointsCloud
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73342

shaderLanguage

get shaderLanguage(): ShaderLanguage
Gets the shader language used in this material.

Returns ShaderLanguage
Inherited from PushMaterial.shaderLanguage
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73074

transparencyMode

get transparencyMode(): Nullable<number>
Gets the current transparency mode.

Returns Nullable<number>
Inherited from PushMaterial.transparencyMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73529
set transparencyMode(value: Nullable<number>): void
Sets the transparency mode of the material.

Value Type Description

0 OPAQUE

1 ALPHATEST

2 ALPHABLEND

3 ALPHATESTANDBLEND
Parameters
- value: Nullable<number>
Returns void
Inherited from PushMaterial.transparencyMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73541

Value	Type	Description
0	OPAQUE
1	ALPHATEST
2	ALPHABLEND
3	ALPHATESTANDBLEND

useLogarithmicDepth

get useLogarithmicDepth(): 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.

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/materials/advanced/logarithmicDepthBuffer
Inherited from PushMaterial.useLogarithmicDepth
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73385
set useLogarithmicDepth(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PushMaterial.useLogarithmicDepth
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73386

wireframe

get wireframe(): boolean
Returns boolean
Inherited from PushMaterial.wireframe
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73330
set wireframe(value: boolean): void
Sets the state of wireframe mode
Parameters
- value: boolean
Returns void
Inherited from PushMaterial.wireframe
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73334

Methods

atomicMaterialsUpdate

atomicMaterialsUpdate(callback: (material: this) => void): void
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: this) => void
  the callback to be executed that will update the material
Returns void
Inherited from PushMaterial.atomicMaterialsUpdate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73169

bind

bind(world: Matrix, mesh?: Mesh): void
Binds the material to the mesh
Parameters
- world: Matrix
  defines the world transformation matrix
- Optionalmesh: Mesh
  defines the mesh to bind the material to
Returns void
Inherited from PushMaterial.bind
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70843

bindEyePosition

bindEyePosition(effect: Effect, variableName?: string): void
Binds the view matrix to the effect
Parameters
- effect: Effect
  defines the effect to bind the view matrix to
- OptionalvariableName: string
  name of the shader variable that will hold the eye position
Returns void
Inherited from PushMaterial.bindEyePosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73624

bindForSubMesh

bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void
Binds the submesh to the material
Parameters
- world: Matrix
  defines the world transformation matrix
- mesh: Mesh
  defines the mesh containing the submesh
- subMesh: SubMesh
  defines the submesh to bind the material to
Returns void
Overrides PushMaterial.bindForSubMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145719

bindOnlyNormalMatrix

bindOnlyNormalMatrix(normalMatrix: Matrix): void
Binds the given normal matrix to the active effect
Parameters
- normalMatrix: Matrix
  the matrix to bind
Returns void
Inherited from PushMaterial.bindOnlyNormalMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70842

bindOnlyWorldMatrix

bindOnlyWorldMatrix(world: Matrix): void
Binds the given world matrix to the active effect
Parameters
- world: Matrix
  the matrix to bind
Returns void
Inherited from PushMaterial.bindOnlyWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70836

bindView

bindView(effect: Effect): void
Binds the view matrix to the effect
Parameters
- effect: Effect
  defines the effect to bind the view matrix to
Returns void
Inherited from PushMaterial.bindView
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73613

bindViewProjection

bindViewProjection(effect: Effect): void
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
Inherited from PushMaterial.bindViewProjection
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73618

buildUniformLayout

buildUniformLayout(): void
Initializes the uniform buffer layout for the shader.

Returns void
Inherited from PushMaterial.buildUniformLayout
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73596

clone

clone(name: string): FireMaterial
Makes a duplicate of the material, and gives it a new name
Parameters
- name: string
  defines the new name for the duplicated material
Returns FireMaterial
the cloned material
Overrides PushMaterial.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145725

dispose

dispose(forceDisposeEffect?: boolean): void
Parameters
- OptionalforceDisposeEffect: boolean
Returns void
Overrides PushMaterial.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145724

forceCompilation

forceCompilation(
    mesh: AbstractMesh,
    onCompiled?: (material: Material) => void,
    options?: Partial<IMaterialCompilationOptions>,
    onError?: (reason: string) => void,
): void
Force shader compilation
Parameters
- mesh: AbstractMesh
  defines the mesh associated with this material
- OptionalonCompiled: (material: Material) => void
  defines a function to execute once the material is compiled
- Optionaloptions: Partial<IMaterialCompilationOptions>
  defines the options to configure the compilation
- OptionalonError: (reason: string) => void
  defines a function to execute if the material fails compiling
Returns void
Inherited from PushMaterial.forceCompilation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73671

forceCompilationAsync

forceCompilationAsync(
mesh: AbstractMesh,
options?: Partial<IMaterialCompilationOptions>,
): Promise<void>
Force shader compilation
Parameters
- mesh: AbstractMesh
  defines the mesh that will use this material
- Optionaloptions: Partial<IMaterialCompilationOptions>
  defines additional options for compiling the shaders
Returns Promise<void>
a promise that resolves when the compilation completes
Inherited from PushMaterial.forceCompilationAsync
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73678

freeze

freeze(): void
Locks updates for the material

Returns void
Inherited from PushMaterial.freeze
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73490

getActiveTextures

getActiveTextures(): BaseTexture[]
Gets the active textures from the material

Returns BaseTexture[]
an array of textures
Overrides PushMaterial.getActiveTextures
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145721

getAlphaTestTexture

getAlphaTestTexture(): Nullable<BaseTexture>
Gets the texture used for the alpha test

Returns Nullable<BaseTexture>
the texture to use for alpha testing
Overrides PushMaterial.getAlphaTestTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145717

getAnimatables

getAnimatables(): IAnimatable[]
Returns the animatable textures.

Returns IAnimatable[]
- Array of animatable textures.
Overrides PushMaterial.getAnimatables
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145720

getBindedMeshes

getBindedMeshes(): AbstractMesh[]
Gets the meshes bound to the material

Returns AbstractMesh[]
an array of meshes bound to the material
Inherited from PushMaterial.getBindedMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73663

getClassName

getClassName(): string
Gets the class name of the material

Returns string
a string with the class name of the material
Overrides PushMaterial.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145723

getEffect

getEffect(): Effect
Returns the material effect

Returns Effect
the effect associated with the material
Inherited from PushMaterial.getEffect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70828

getScene

getScene(): Scene
Returns the current scene

Returns Scene
a Scene
Inherited from PushMaterial.getScene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73519

hasTexture

hasTexture(texture: BaseTexture): boolean
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
Overrides PushMaterial.hasTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145722

isReady

isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean
Specifies if the material is ready to be used
Parameters
- Optionalmesh: AbstractMesh
  defines the mesh to check
- OptionaluseInstances: boolean
  specifies if instances should be used
Returns boolean
a boolean indicating if the material is ready to be used
Inherited from PushMaterial.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70829

isReadyForSubMesh

isReadyForSubMesh(
    mesh: AbstractMesh,
    subMesh: SubMesh,
    useInstances?: boolean,
): boolean
Specifies that the submesh is ready to be used
Parameters
- mesh: AbstractMesh
  defines the mesh to check
- subMesh: SubMesh
  defines which submesh to check
- OptionaluseInstances: boolean
  specifies that instances should be used
Returns boolean
a boolean indicating that the submesh is ready or not
Overrides PushMaterial.isReadyForSubMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145718

markAsDirty

markAsDirty(flag: number): void
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
Inherited from PushMaterial.markAsDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73695

markDirty

markDirty(forceMaterialDirty?: boolean): void
Marks the material to indicate that it needs to be re-calculated
Parameters
- OptionalforceMaterialDirty: 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
Inherited from PushMaterial.markDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73582

needAlphaBlending

needAlphaBlending(): boolean
Specifies whether or not this material should be rendered in alpha blend mode.

Returns boolean
a boolean specifying if alpha blending is needed

Deprecated
Please use needAlphaBlendingForMesh instead
Overrides PushMaterial.needAlphaBlending
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145715

needAlphaBlendingForMesh

needAlphaBlendingForMesh(mesh: AbstractMesh): boolean
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
Inherited from PushMaterial.needAlphaBlendingForMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73560

needAlphaTesting

needAlphaTesting(): boolean
Specifies whether or not this material should be rendered in alpha test mode.

Returns boolean
a boolean specifying if an alpha test is needed.

Deprecated
Please use needAlphaTestingForMesh instead
Overrides PushMaterial.needAlphaTesting
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145716

needAlphaTestingForMesh

needAlphaTestingForMesh(mesh: AbstractMesh): boolean
Specifies if material alpha testing should be turned on for the mesh
Parameters
- mesh: AbstractMesh
  defines the mesh to check
Returns boolean
a boolean specifying if alpha testing should be turned on for the mesh
Inherited from PushMaterial.needAlphaTestingForMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73572

resetDrawCache

resetDrawCache(): void
Resets the draw wrappers cache for all submeshes that are using this material

Returns void
Inherited from PushMaterial.resetDrawCache
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73699

serialize

serialize(): any
Serializes this material

Returns any
the serialized material object
Overrides PushMaterial.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145726

setPrePassRenderer

setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean
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.
Inherited from PushMaterial.setPrePassRenderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73755

toString

toString(fullDetails?: boolean): string
Returns a string representation of the current material
Parameters
- OptionalfullDetails: boolean
  defines a boolean indicating which levels of logging is desired
Returns string
a string with material information
Inherited from PushMaterial.toString
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73475

unbind

unbind(): void
Unbinds the material from the mesh

Returns void
Inherited from PushMaterial.unbind
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73635

unfreeze

unfreeze(): void
Unlocks updates for the material

Returns void
Inherited from PushMaterial.unfreeze
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73494

`Static`Parse

Parse(source: any, scene: Scene, rootUrl: string): FireMaterial
Creates a material from parsed material data
Parameters
- source: any
- scene: Scene
  defines the hosting scene
- rootUrl: string
  defines the root URL to use to load textures
Returns FireMaterial
a new material
Overrides PushMaterial.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:145727

Class FireMaterial

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FireMaterial

Properties

allowShaderHotSwapping

animations

checkReadyOnEveryCall

checkReadyOnlyOnce

clipPlane

clipPlane2

clipPlane3

clipPlane4

clipPlane5

clipPlane6

customShaderNameResolve

depthFunction

diffuseColor

diffuseTexture

disableColorWrite

disableDepthWrite

distortionTexture

doNotSerialize

forceDepthWrite

getRenderTargetTextures

id

inspectableCustomProperties

See

metadata

name

onCompiled

onDisposeObservable

onError

opacityTexture

OptionalpluginManager

pointSize

reservedDataStore

separateCullingPass

shadowDepthWrapper

sideOrientation

speed

state

Readonlystencil

uniqueId

zOffset

zOffsetUnits

Static ReadonlyAllDirtyFlag

Static ReadonlyAttributesDirtyFlag

Static ReadonlyClockWiseSideOrientation

Static ReadonlyCounterClockWiseSideOrientation

Static ReadonlyFresnelDirtyFlag

Static ReadonlyImageProcessingDirtyFlag

Static ReadonlyLightDirtyFlag

Static ReadonlyLineListDrawMode

Static ReadonlyLineLoopDrawMode

Static ReadonlyLineStripDrawMode

Static ReadonlyMATERIAL_ALPHABLEND

Static ReadonlyMATERIAL_ALPHATEST

Static ReadonlyMATERIAL_ALPHATESTANDBLEND

Static ReadonlyMATERIAL_NORMALBLENDMETHOD_RNM

Static ReadonlyMATERIAL_NORMALBLENDMETHOD_WHITEOUT

Static ReadonlyMATERIAL_OPAQUE

Static ReadonlyMiscDirtyFlag

StaticOnEventObservable

Static ReadonlyPointFillMode

Static ReadonlyPointListDrawMode

Static ReadonlyPrePassDirtyFlag

Static ReadonlyTextureDirtyFlag

Static ReadonlyTriangleFanDrawMode

Static ReadonlyTriangleFillMode

Static ReadonlyTriangleStripDrawMode

Static ReadonlyWireFrameFillMode

Accessors

`Optional`pluginManager

`Readonly`stencil

`Static` `Readonly`AllDirtyFlag

`Static` `Readonly`AttributesDirtyFlag

`Static` `Readonly`ClockWiseSideOrientation

`Static` `Readonly`CounterClockWiseSideOrientation

`Static` `Readonly`FresnelDirtyFlag

`Static` `Readonly`ImageProcessingDirtyFlag

`Static` `Readonly`LightDirtyFlag

`Static` `Readonly`LineListDrawMode

`Static` `Readonly`LineLoopDrawMode

`Static` `Readonly`LineStripDrawMode

`Static` `Readonly`MATERIAL_ALPHABLEND

`Static` `Readonly`MATERIAL_ALPHATEST

`Static` `Readonly`MATERIAL_ALPHATESTANDBLEND

`Static` `Readonly`MATERIAL_NORMALBLENDMETHOD_RNM

`Static` `Readonly`MATERIAL_NORMALBLENDMETHOD_WHITEOUT

`Static` `Readonly`MATERIAL_OPAQUE

`Static` `Readonly`MiscDirtyFlag

`Static`OnEventObservable

`Static` `Readonly`PointFillMode

`Static` `Readonly`PointListDrawMode

`Static` `Readonly`PrePassDirtyFlag

`Static` `Readonly`TextureDirtyFlag

`Static` `Readonly`TriangleFanDrawMode

`Static` `Readonly`TriangleFillMode

`Static` `Readonly`TriangleStripDrawMode

`Static` `Readonly`WireFrameFillMode