CustomMaterial | Babylon.js API documentation

Class CustomMaterial

Customized material

Hierarchy (View Summary)

StandardMaterial
- CustomMaterial

Index

Constructors

Properties

_createdShaderName _customAttributes _customUniform _newSamplerInstances _newUniformInstances _newUniforms allowShaderHotSwapping alphaCutOff ambientColor ambientTexture animations applyDecalMapAfterDetailMap bumpTexture checkReadyOnEveryCall checkReadyOnlyOnce clipPlane clipPlane2 clipPlane3 clipPlane4 clipPlane5 clipPlane6 CustomParts customShaderNameResolve decalMap depthFunction detailMap diffuseColor diffuseFresnelParameters diffuseTexture disableColorWrite disableDepthWrite disableLighting doNotSerialize emissiveColor emissiveFresnelParameters emissiveTexture forceDepthWrite FragmentShader getRenderTargetTextures id indexOfRefraction inspectableCustomProperties invertNormalMapX invertNormalMapY invertRefractionY lightmapTexture linkEmissiveWithDiffuse maxSimultaneousLights metadata name onCompiled onDisposeObservable onError opacityFresnelParameters opacityTexture parallaxScaleBias pluginManager? pointSize prePassConfiguration reflectionFresnelParameters reflectionTexture refractionFresnelParameters refractionTexture reservedDataStore roughness separateCullingPass shadowDepthWrapper sideOrientation specularColor specularPower specularTexture state stencil twoSidedLighting uniqueId useAlphaFromDiffuseTexture useEmissiveAsIllumination useGlossinessFromSpecularMapAlpha useLightmapAsShadowmap useObjectSpaceNormalMap useParallax useParallaxOcclusion useReflectionFresnelFromSpecular useReflectionOverAlpha useSpecularOverAlpha VertexShader zOffset zOffsetUnits AllDirtyFlag AttributesDirtyFlag ClockWiseSideOrientation CounterClockWiseSideOrientation ForceGLSL 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 ShaderIndexer TextureDirtyFlag TriangleFanDrawMode TriangleFillMode TriangleStripDrawMode WireFrameFillMode

Methods

AddAttribute AddUniform atomicMaterialsUpdate AttachAfterBind bind bindEyePosition bindForSubMesh bindOnlyNormalMatrix bindOnlyWorldMatrix bindView bindViewProjection Builder buildUniformLayout clone dispose forceCompilation forceCompilationAsync Fragment_Before_Fog Fragment_Before_FragColor Fragment_Before_Lights Fragment_Begin Fragment_Custom_Alpha Fragment_Custom_Diffuse Fragment_Definitions Fragment_MainBegin Fragment_MainEnd freeze getActiveTextures getAlphaTestTexture getAnimatables getBindedMeshes getClassName getEffect getScene hasTexture isReady isReadyForSubMesh markAsDirty markDirty needAlphaBlending needAlphaBlendingForMesh needAlphaTesting needAlphaTestingForMesh resetDrawCache serialize setPrePassRenderer toString unbind unfreeze Vertex_After_WorldPosComputed Vertex_Before_NormalUpdated Vertex_Before_PositionUpdated Vertex_Begin Vertex_Definitions Vertex_MainBegin Vertex_MainEnd Parse

Constructors

constructor

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

Properties

_createdShaderName

_createdShaderName: string

Name of the shader

_customAttributes

_customAttributes: string[]

List of the custom attributes

_customUniform

_customUniform: string[]

List of custom uniforms

_newSamplerInstances

_newSamplerInstances: { [name: string]: Texture }

Instances of the new sampler objects

_newUniformInstances

_newUniformInstances: { [name: string]: any }

Instances of the new uniform objects

_newUniforms

_newUniforms: string[]

Names of the new uniforms

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)

alphaCutOff

alphaCutOff: number

Defines the alpha limits in alpha test mode.

ambientColor

ambientColor: Color3

The color of the material lit by the environmental background lighting.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/materials_introduction#ambient-color-example

ambientTexture

ambientTexture: Nullable<BaseTexture>

AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.

animations

animations: Nullable<Animation[]>

Stores the animations for the material

applyDecalMapAfterDetailMap

applyDecalMapAfterDetailMap: boolean

If sets to true, the decal map will be applied after the detail map. Else, it is applied before (default: false)

bumpTexture

bumpTexture: Nullable<BaseTexture>

Bump mapping is a technique to simulate bump and dents on a rendered surface. These are made by creating a normal map from an image. The means to do this can be found on the web, a search for 'normal map generator' will bring up free and paid for methods of doing this.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/moreMaterials#bump-map

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

CustomParts

CustomParts: ShaderSpecialParts

Custom shader structure

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.

decalMap

decalMap: Nullable<DecalMapConfiguration>

Defines the decal map parameters for the material.

depthFunction

depthFunction: number

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

`Readonly`detailMap

detailMap: DetailMapConfiguration

Defines the detail map parameters for the material.

diffuseColor

diffuseColor: Color3

The basic color of the material as viewed under a light.

diffuseFresnelParameters

diffuseFresnelParameters: FresnelParameters

Define the diffuse fresnel parameters of the material.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/fresnelParameters

diffuseTexture

diffuseTexture: Nullable<BaseTexture>

The basic texture of the material as viewed under a light.

disableColorWrite

disableColorWrite: boolean

Specifies if color writing should be disabled

disableDepthWrite

disableDepthWrite: boolean

Specifies if depth writing should be disabled

disableLighting

disableLighting: boolean

Does lights from the scene impacts this material. It can be a nice trick for performance to disable lighting on a fully emissive material.

doNotSerialize

doNotSerialize: boolean

Specifies if the material should be serialized

emissiveColor

emissiveColor: Color3

Define the color of the material as if self lit. This will be mixed in the final result even in the absence of light.

emissiveFresnelParameters

emissiveFresnelParameters: FresnelParameters

Define the emissive fresnel parameters of the material.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/fresnelParameters

emissiveTexture

emissiveTexture: Nullable<BaseTexture>

Define texture of the material as if self lit. This will be mixed in the final result even in the absence of light.

forceDepthWrite

forceDepthWrite: boolean

Specifies if depth writing should be forced

FragmentShader

FragmentShader: string

Fragment shader string

getRenderTargetTextures

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

Callback triggered to get the render target textures

id

id: string

The ID of the material

indexOfRefraction

indexOfRefraction: number

In case of refraction, define the value of the index of refraction.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/reflectionTexture#how-to-obtain-reflections-and-refractions

inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

See

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

invertNormalMapX

invertNormalMapX: boolean

If sets to true, x component of normal map value will invert (x = 1.0 - x).

invertNormalMapY

invertNormalMapY: boolean

If sets to true, y component of normal map value will invert (y = 1.0 - y).

invertRefractionY

invertRefractionY: boolean

Invert the refraction texture alongside the y axis. It can be useful with procedural textures or probe for instance.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/reflectionTexture#how-to-obtain-reflections-and-refractions

lightmapTexture

lightmapTexture: Nullable<BaseTexture>

Complex lighting can be computationally expensive to compute at runtime. To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.

See

https://doc.babylonjs.com/features/featuresDeepDive/lights/lights_introduction#lightmaps

linkEmissiveWithDiffuse

linkEmissiveWithDiffuse: boolean

If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing the emissive level when the final color is close to one.

maxSimultaneousLights

maxSimultaneousLights: number

Defines the maximum number of lights that can be used in the material

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

opacityFresnelParameters

opacityFresnelParameters: FresnelParameters

Define the opacity fresnel parameters of the material.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/fresnelParameters

opacityTexture

opacityTexture: Nullable<BaseTexture>

Define the transparency of the material from a texture. The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false) or from the luminance or the current texel (if texture.getAlphaFromRGB is true)

parallaxScaleBias

parallaxScaleBias: number

Apply a scaling factor that determine which "depth" the height map should reprensent. A value between 0.05 and 0.1 is reasonnable in Parallax, you can reach 0.2 using Parallax Occlusion.

`Optional`pluginManager

pluginManager?: MaterialPluginManager

Plugin manager for this material

pointSize

pointSize: number

Stores the size of points

`Readonly`prePassConfiguration

prePassConfiguration: PrePassConfiguration

Defines additional PrePass parameters for the material.

reflectionFresnelParameters

reflectionFresnelParameters: FresnelParameters

Define the reflection fresnel parameters of the material.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/fresnelParameters

reflectionTexture

reflectionTexture: Nullable<BaseTexture>

Define the texture used to display the reflection.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/reflectionTexture#how-to-obtain-reflections-and-refractions

refractionFresnelParameters

refractionFresnelParameters: FresnelParameters

Define the refraction fresnel parameters of the material.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/fresnelParameters

refractionTexture

refractionTexture: Nullable<BaseTexture>

Define the texture used to display the refraction.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/reflectionTexture#how-to-obtain-reflections-and-refractions

reservedDataStore

reservedDataStore: any

For internal use only. Please do not use.

roughness

roughness: number

Helps to define how blurry the reflections should appears in the material.

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

specularColor

specularColor: Color3

Define how the color and intensity of the highlight given by the light in the material.

specularPower

specularPower: number

Defines how sharp are the highlights in the material. The bigger the value the sharper giving a more glossy feeling to the result. Reversely, the smaller the value the blurrier giving a more rough feeling to the result.

specularTexture

specularTexture: Nullable<BaseTexture>

Define how the color and intensity of the highlight given by the light in the material.

state

state: string

The state of the material

`Readonly`stencil

stencil: MaterialStencilState

Gives access to the stencil properties of the material

twoSidedLighting

twoSidedLighting: boolean

If sets to true and backfaceCulling is false, normals will be flipped on the backside.

uniqueId

uniqueId: number

Gets or sets the unique id of the material

useAlphaFromDiffuseTexture

useAlphaFromDiffuseTexture: boolean

Does the transparency come from the diffuse texture alpha channel.

useEmissiveAsIllumination

useEmissiveAsIllumination: boolean

If true, the emissive value is added into the end result, otherwise it is multiplied in.

useGlossinessFromSpecularMapAlpha

useGlossinessFromSpecularMapAlpha: boolean

Defines if the glossiness/roughness of the material should be read from the specular map alpha channel

useLightmapAsShadowmap

useLightmapAsShadowmap: boolean

In case of light mapping, define whether the map contains light or shadow informations.

useObjectSpaceNormalMap

useObjectSpaceNormalMap: boolean

Allows using an object space normal map (instead of tangent space).

useParallax

useParallax: boolean

Is parallax enabled or not.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/parallaxMapping

useParallaxOcclusion

useParallaxOcclusion: boolean

Is parallax occlusion enabled or not. If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/parallaxMapping

useReflectionFresnelFromSpecular

useReflectionFresnelFromSpecular: boolean

If true automatically deducts the fresnels values from the material specularity.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/fresnelParameters

useReflectionOverAlpha

useReflectionOverAlpha: boolean

Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones). A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.

useSpecularOverAlpha

useSpecularOverAlpha: boolean

Specifies that the material will keep the specular highlights over a transparent surface (only the most luminous ones). A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.

VertexShader

VertexShader: string

Vertex shader string

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`ForceGLSL

ForceGLSL: boolean

Force all the standard materials to compile to glsl even on WebGPU engines. False by default. This is mostly meant for backward compatibility.

`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`ShaderIndexer

ShaderIndexer: number

Index for each created shader

`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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.blockDirtyMechanism
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73161
set blockDirtyMechanism(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.blockDirtyMechanism
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73162

cameraColorCurves

get cameraColorCurves(): Nullable<ColorCurves>
The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT). They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects. These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image; corresponding to low luminance, medium luminance, and high luminance areas respectively.

Returns Nullable<ColorCurves>
Inherited from StandardMaterial.cameraColorCurves
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70101
set cameraColorCurves(value: Nullable<ColorCurves>): void
The color grading curves provide additional color adjustment that is applied after any color grading transform (3D LUT). They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects. These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image; corresponding to low luminance, medium luminance, and high luminance areas respectively.
Parameters
- value: Nullable<ColorCurves>
Returns void
Inherited from StandardMaterial.cameraColorCurves
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70108

cameraColorCurvesEnabled

get cameraColorCurvesEnabled(): boolean
Gets whether the color curves effect is enabled.

Returns boolean
Inherited from StandardMaterial.cameraColorCurvesEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70046
set cameraColorCurvesEnabled(value: boolean): void
Sets whether the color curves effect is enabled.
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.cameraColorCurvesEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70050

cameraColorGradingEnabled

get cameraColorGradingEnabled(): boolean
Gets whether the color grading effect is enabled.

Returns boolean
Inherited from StandardMaterial.cameraColorGradingEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70054
set cameraColorGradingEnabled(value: boolean): void
Gets whether the color grading effect is enabled.
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.cameraColorGradingEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70058

cameraColorGradingTexture

get cameraColorGradingTexture(): Nullable<BaseTexture>
Gets the Color Grading 2D Lookup Texture.

Returns Nullable<BaseTexture>
Inherited from StandardMaterial.cameraColorGradingTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70090
set cameraColorGradingTexture(value: Nullable<BaseTexture>): void
Sets the Color Grading 2D Lookup Texture.
Parameters
- value: Nullable<BaseTexture>
Returns void
Inherited from StandardMaterial.cameraColorGradingTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70094

cameraContrast

get cameraContrast(): number
Gets The camera contrast used on this material.

Returns number
Inherited from StandardMaterial.cameraContrast
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70082
set cameraContrast(value: number): void
Sets The camera contrast used on this material.
Parameters
- value: number
Returns void
Inherited from StandardMaterial.cameraContrast
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70086

cameraExposure

get cameraExposure(): number
The camera exposure used on this material. This property is here and not in the camera to allow controlling exposure without full screen post process. This corresponds to a photographic exposure.

Returns number
Inherited from StandardMaterial.cameraExposure
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70072
set cameraExposure(value: number): void
The camera exposure used on this material. This property is here and not in the camera to allow controlling exposure without full screen post process. This corresponds to a photographic exposure.
Parameters
- value: number
Returns void
Inherited from StandardMaterial.cameraExposure
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70078

cameraToneMappingEnabled

get cameraToneMappingEnabled(): boolean
Gets whether tonemapping is enabled or not.

Returns boolean
Inherited from StandardMaterial.cameraToneMappingEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70062
set cameraToneMappingEnabled(value: boolean): void
Sets whether tonemapping is enabled or not
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.cameraToneMappingEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70066

canRenderToMRT

get canRenderToMRT(): boolean
Can this material render to several textures at once

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

cullBackFaces

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

Returns boolean
Inherited from StandardMaterial.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 StandardMaterial.cullBackFaces
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73151

fillMode

get fillMode(): number
Gets the material fill mode

Returns number
Inherited from StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.hasRenderTargetTextures
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70133

imageProcessingConfiguration

get imageProcessingConfiguration(): ImageProcessingConfiguration
Gets the image processing configuration used either in this material.

Returns ImageProcessingConfiguration
Inherited from StandardMaterial.imageProcessingConfiguration
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70018
set imageProcessingConfiguration(value: ImageProcessingConfiguration): void
Sets the Default image processing configuration used either in the this material.

If sets to null, the scene one is in use.
Parameters
- value: ImageProcessingConfiguration
Returns void
Inherited from StandardMaterial.imageProcessingConfiguration
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70024

isFrozen

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

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

isPrePassCapable

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

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

needDepthPrePass

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

Returns boolean
Inherited from StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.useLogarithmicDepth
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73385
set useLogarithmicDepth(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.useLogarithmicDepth
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73386

wireframe

get wireframe(): boolean
Returns boolean
Inherited from StandardMaterial.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 StandardMaterial.wireframe
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73334

`Static`AmbientTextureEnabled

get AmbientTextureEnabled(): boolean
Are ambient textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.AmbientTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70235
set AmbientTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.AmbientTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70236

`Static`BumpTextureEnabled

get BumpTextureEnabled(): boolean
Are bump textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.BumpTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70260
set BumpTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.BumpTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70261

`Static`ColorGradingTextureEnabled

get ColorGradingTextureEnabled(): boolean
Are color grading textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.ColorGradingTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70275
set ColorGradingTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.ColorGradingTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70276

`Static`DetailTextureEnabled

get DetailTextureEnabled(): boolean
Are detail textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.DetailTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70230
set DetailTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.DetailTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70231

`Static`DiffuseTextureEnabled

get DiffuseTextureEnabled(): boolean
Are diffuse textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.DiffuseTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70225
set DiffuseTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.DiffuseTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70226

`Static`EmissiveTextureEnabled

get EmissiveTextureEnabled(): boolean
Are emissive textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.EmissiveTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70250
set EmissiveTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.EmissiveTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70251

`Static`FresnelEnabled

get FresnelEnabled(): boolean
Are fresnels enabled in the application.

Returns boolean
Inherited from StandardMaterial.FresnelEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70280
set FresnelEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.FresnelEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70281

`Static`LightmapTextureEnabled

get LightmapTextureEnabled(): boolean
Are lightmap textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.LightmapTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70265
set LightmapTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.LightmapTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70266

`Static`OpacityTextureEnabled

get OpacityTextureEnabled(): boolean
Are opacity textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.OpacityTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70240
set OpacityTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.OpacityTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70241

`Static`ReflectionTextureEnabled

get ReflectionTextureEnabled(): boolean
Are reflection textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.ReflectionTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70245
set ReflectionTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.ReflectionTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70246

`Static`RefractionTextureEnabled

get RefractionTextureEnabled(): boolean
Are refraction textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.RefractionTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70270
set RefractionTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.RefractionTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70271

`Static`SpecularTextureEnabled

get SpecularTextureEnabled(): boolean
Are specular textures enabled in the application.

Returns boolean
Inherited from StandardMaterial.SpecularTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70255
set SpecularTextureEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from StandardMaterial.SpecularTextureEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70256

Methods

AddAttribute

AddAttribute(name: string): CustomMaterial
Adds a custom attribute
Parameters
- name: string
  the name of the attribute
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146209

AddUniform

AddUniform(name: string, kind: string, param: any): CustomMaterial
Adds a new uniform to the shader
Parameters
- name: string
  the name of the uniform to add
- kind: string
  the type of the uniform to add
- param: any
  the value of the uniform to add
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146203

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 StandardMaterial.atomicMaterialsUpdate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73169

AttachAfterBind

AttachAfterBind(mesh: undefined | Mesh, effect: Effect): void
Runs after the material is bound to a mesh
Parameters
- mesh: undefined | Mesh
  mesh bound
- effect: Effect
  bound effect used to render
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146174

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 StandardMaterial.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 StandardMaterial.bindEyePosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73624

bindForSubMesh

bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void
Binds the submesh to this material by preparing the effect and shader to draw
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
Inherited from StandardMaterial.bindForSubMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70183

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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.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 StandardMaterial.bindViewProjection
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73618

Builder

Builder(
    shaderName: string,
    uniforms: string[],
    uniformBuffers: string[],
    samplers: string[],
    defines: string[] | MaterialDefines,
    attributes?: string[],
): string
Builds the material
Parameters
- shaderName: string
  name of the shader
- uniforms: string[]
  list of uniforms
- uniformBuffers: string[]
  list of uniform buffers
- samplers: string[]
  list of samplers
- defines: string[] | MaterialDefines
  list of defines
- Optionalattributes: string[]
  list of attributes
Returns string
the shader name
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146189

buildUniformLayout

buildUniformLayout(): void
Builds the material UBO layouts. Used internally during the effect preparation.

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

clone

clone(
    name: string,
    cloneTexturesOnlyOnce?: boolean,
    rootUrl?: string,
): StandardMaterial
Makes a duplicate of the material, and gives it a new name
Parameters
- name: string
  defines the new name for the duplicated material
- OptionalcloneTexturesOnlyOnce: boolean
  if a texture is used in more than one channel (e.g diffuse and opacity), only clone it once and reuse it on the other channels. Default false.
- OptionalrootUrl: string
  defines the root URL to use to load textures
Returns StandardMaterial
the cloned material
Inherited from StandardMaterial.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70213

dispose

dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void
Disposes the material
Parameters
- OptionalforceDisposeEffect: boolean
  specifies if effects should be forcefully disposed
- OptionalforceDisposeTextures: boolean
  specifies if textures should be forcefully disposed
Returns void
Inherited from StandardMaterial.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70205

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 StandardMaterial.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 StandardMaterial.forceCompilationAsync
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73678

Fragment_Before_Fog

Fragment_Before_Fog(shaderPart: string): CustomMaterial
Sets the code on Fragment_Before_Fog portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146257

Fragment_Before_FragColor

Fragment_Before_FragColor(shaderPart: string): CustomMaterial
Sets the code on Fragment_Before_FragColor portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146263

Fragment_Before_Lights

Fragment_Before_Lights(shaderPart: string): CustomMaterial
Sets the code on Fragment_Before_Lights portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146251

Fragment_Begin

Fragment_Begin(shaderPart: string): CustomMaterial
Sets the code on Fragment_Begin portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146215

Fragment_Custom_Alpha

Fragment_Custom_Alpha(shaderPart: string): CustomMaterial
Sets the code on Fragment_Custom_Alpha portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146245

Fragment_Custom_Diffuse

Fragment_Custom_Diffuse(shaderPart: string): CustomMaterial
Sets the code on Fragment_Custom_Diffuse portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146239

Fragment_Definitions

Fragment_Definitions(shaderPart: string): CustomMaterial
Sets the code on Fragment_Definitions portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146221

Fragment_MainBegin

Fragment_MainBegin(shaderPart: string): CustomMaterial
Sets the code on Fragment_MainBegin portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146227

Fragment_MainEnd

Fragment_MainEnd(shaderPart: string): CustomMaterial
Sets the code on Fragment_MainEnd portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146233

freeze

freeze(): void
Locks updates for the material

Returns void
Inherited from StandardMaterial.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
Inherited from StandardMaterial.getActiveTextures
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70193

getAlphaTestTexture

getAlphaTestTexture(): Nullable<BaseTexture>
Get the texture used for alpha test purpose.

Returns Nullable<BaseTexture>
the diffuse texture in case of the standard material.
Inherited from StandardMaterial.getAlphaTestTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70162

getAnimatables

getAnimatables(): IAnimatable[]
Get the list of animatables in the material.

Returns IAnimatable[]
the list of animatables object used in the material
Inherited from StandardMaterial.getAnimatables
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70188

getBindedMeshes

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

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

getClassName

getClassName(): string
Gets the current class name of the material e.g. "StandardMaterial" Mainly use in serialization.

Returns string
the class name
Inherited from StandardMaterial.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70139

getEffect

getEffect(): Effect
Returns the material effect

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

getScene

getScene(): Scene
Returns the current scene

Returns Scene
a Scene
Inherited from StandardMaterial.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
Inherited from StandardMaterial.hasTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70199

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 StandardMaterial.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70829

isReadyForSubMesh

isReadyForSubMesh(
    mesh: AbstractMesh,
    subMesh: SubMesh,
    useInstances?: boolean,
): boolean
Get if the submesh is ready to be used and all its information available. Child classes can use it to update shaders
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
Inherited from StandardMaterial.isReadyForSubMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70171

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 StandardMaterial.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 StandardMaterial.markDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73582

needAlphaBlending

needAlphaBlending(): boolean
Specifies if the material will require alpha blending

Returns boolean
a boolean specifying if alpha blending is needed
Inherited from StandardMaterial.needAlphaBlending
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70144

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 StandardMaterial.needAlphaBlendingForMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73560

needAlphaTesting

needAlphaTesting(): boolean
Specifies if this material should be rendered in alpha test mode

Returns boolean
a boolean specifying if an alpha test is needed.
Inherited from StandardMaterial.needAlphaTesting
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70149

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 StandardMaterial.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 StandardMaterial.resetDrawCache
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73699

serialize

serialize(): any
Serializes this material

Returns any
the serialized material object
Inherited from StandardMaterial.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73768

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 StandardMaterial.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 StandardMaterial.toString
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73475

unbind

unbind(): void
Unbinds the material from the mesh

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

unfreeze

unfreeze(): void
Unlocks updates for the material

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

Vertex_After_WorldPosComputed

Vertex_After_WorldPosComputed(shaderPart: string): CustomMaterial
Sets the code on Vertex_After_WorldPosComputed portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146299

Vertex_Before_NormalUpdated

Vertex_Before_NormalUpdated(shaderPart: string): CustomMaterial
Sets the code on Vertex_Before_NormalUpdated portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146293

Vertex_Before_PositionUpdated

Vertex_Before_PositionUpdated(shaderPart: string): CustomMaterial
Sets the code on Vertex_Before_PositionUpdated portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146287

Vertex_Begin

Vertex_Begin(shaderPart: string): CustomMaterial
Sets the code on Vertex_Begin portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146269

Vertex_Definitions

Vertex_Definitions(shaderPart: string): CustomMaterial
Sets the code on Vertex_Definitions portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146275

Vertex_MainBegin

Vertex_MainBegin(shaderPart: string): CustomMaterial
Sets the code on Vertex_MainBegin portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146281

Vertex_MainEnd

Vertex_MainEnd(shaderPart: string): CustomMaterial
Sets the code on Vertex_MainEnd portion
Parameters
- shaderPart: string
  the code string
Returns CustomMaterial
the current material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146305

`Static`Parse

Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial
Creates a standard material from parsed 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 StandardMaterial
a new standard material
Inherited from StandardMaterial.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70221

Class CustomMaterial

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CustomMaterial

Properties

_createdShaderName

_customAttributes

_customUniform

_newSamplerInstances

_newUniformInstances

_newUniforms

allowShaderHotSwapping

alphaCutOff

ambientColor

See

ambientTexture

animations

applyDecalMapAfterDetailMap

bumpTexture

See

checkReadyOnEveryCall

checkReadyOnlyOnce

clipPlane

clipPlane2

clipPlane3

clipPlane4

clipPlane5

clipPlane6

CustomParts

customShaderNameResolve

decalMap

depthFunction

ReadonlydetailMap

diffuseColor

diffuseFresnelParameters

See

diffuseTexture

disableColorWrite

disableDepthWrite

disableLighting

doNotSerialize

emissiveColor

emissiveFresnelParameters

See

emissiveTexture

forceDepthWrite

FragmentShader

getRenderTargetTextures

id

indexOfRefraction

See

inspectableCustomProperties

See

invertNormalMapX

invertNormalMapY

invertRefractionY

See

lightmapTexture

See

linkEmissiveWithDiffuse

maxSimultaneousLights

metadata

name

onCompiled

onDisposeObservable

onError

opacityFresnelParameters

See

opacityTexture

parallaxScaleBias

OptionalpluginManager

pointSize

ReadonlyprePassConfiguration

`Readonly`detailMap

`Optional`pluginManager

`Readonly`prePassConfiguration

`Readonly`stencil

`Static` `Readonly`AllDirtyFlag

`Static` `Readonly`AttributesDirtyFlag

`Static` `Readonly`ClockWiseSideOrientation

`Static` `Readonly`CounterClockWiseSideOrientation

`Static`ForceGLSL

`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`ShaderIndexer

`Static` `Readonly`TextureDirtyFlag

`Static` `Readonly`TriangleFanDrawMode

`Static` `Readonly`TriangleFillMode

`Static` `Readonly`TriangleStripDrawMode

`Static` `Readonly`WireFrameFillMode