PBRMaterial | Babylon.js API documentation

Class PBRMaterial

The Physically based material of BJS.

This offers the main features of a standard PBR material. For more information, please refer to the documentation : https://doc.babylonjs.com/features/featuresDeepDive/materials/using/introToPBR

Hierarchy (View Summary)

PBRBaseMaterial
- PBRMaterial
  - PBRCustomMaterial

Index

Constructors

constructor

Properties

albedoColor albedoTexture allowShaderHotSwapping alphaCutOff ambientColor ambientTexture ambientTextureImpactOnAnalyticalLights ambientTextureStrength animations anisotropy applyDecalMapAfterDetailMap baseWeight baseWeightTexture brdf bumpTexture checkReadyOnEveryCall checkReadyOnlyOnce clearCoat clipPlane clipPlane2 clipPlane3 clipPlane4 clipPlane5 clipPlane6 customShaderNameResolve decalMap depthFunction detailMap directIntensity disableBumpMap disableColorWrite disableDepthWrite disableLighting doNotSerialize emissiveColor emissiveIntensity emissiveTexture enableSpecularAntiAliasing environmentBRDFTexture environmentIntensity forceAlphaTest forceDepthWrite forceIrradianceInFragment forceNormalForward getRenderTargetTextures id inspectableCustomProperties invertNormalMapX invertNormalMapY iridescence lightmapTexture maxSimultaneousLights metadata metallic metallicF0Factor metallicReflectanceColor metallicReflectanceTexture metallicTexture microSurface microSurfaceTexture name onCompiled onDisposeObservable onError opacityTexture parallaxScaleBias pluginManager? pointSize prePassConfiguration reflectanceTexture reflectionColor reflectionTexture reflectivityColor reflectivityTexture reservedDataStore roughness separateCullingPass shadowDepthWrapper sheen sideOrientation specularIntensity state stencil subSurface twoSidedLighting uniqueId unlit useAlphaFresnel useAlphaFromAlbedoTexture useAmbientInGrayScale useAmbientOcclusionFromMetallicTextureRed useAutoMicroSurfaceFromReflectivityMap useHorizonOcclusion useLightmapAsShadowmap useLinearAlphaFresnel useMetallnessFromMetallicTextureBlue useMicroSurfaceFromReflectivityMapAlpha useObjectSpaceNormalMap useOnlyMetallicFromMetallicReflectanceTexture useParallax useParallaxOcclusion useRadianceOcclusion useRadianceOverAlpha useRoughnessFromMetallicTextureAlpha useRoughnessFromMetallicTextureGreen useSpecularOverAlpha zOffset zOffsetUnits AllDirtyFlag AttributesDirtyFlag ClockWiseSideOrientation CounterClockWiseSideOrientation DEFAULT_AO_ON_ANALYTICAL_LIGHTS ForceGLSL FresnelDirtyFlag ImageProcessingDirtyFlag LightDirtyFlag LIGHTFALLOFF_GLTF LIGHTFALLOFF_PHYSICAL LIGHTFALLOFF_STANDARD LineListDrawMode LineLoopDrawMode LineStripDrawMode MATERIAL_ALPHABLEND MATERIAL_ALPHATEST MATERIAL_ALPHATESTANDBLEND MATERIAL_NORMALBLENDMETHOD_RNM MATERIAL_NORMALBLENDMETHOD_WHITEOUT MATERIAL_OPAQUE MiscDirtyFlag OnEventObservable PBRMATERIAL_ALPHABLEND PBRMATERIAL_ALPHATEST PBRMATERIAL_ALPHATESTANDBLEND PBRMATERIAL_OPAQUE PointFillMode PointListDrawMode PrePassDirtyFlag TextureDirtyFlag TriangleFanDrawMode TriangleFillMode TriangleStripDrawMode WireFrameFillMode

Constructors

constructor

new PBRMaterial(name: string, scene?: Scene, forceGLSL?: boolean): PBRMaterial
Instantiates a new PBRMaterial instance.
Parameters
- name: string
  The material name
- Optionalscene: Scene
  The scene the material will be use in.
- OptionalforceGLSL: boolean
  Use the GLSL code generation for the shader (even on WebGPU). Default is false
Returns PBRMaterial
Overrides PBRBaseMaterial.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81767

Properties

albedoColor

albedoColor: Color3

AKA Diffuse Color in other nomenclature.

albedoTexture

albedoTexture: Nullable<BaseTexture>

AKA Diffuse Texture in standard nomenclature.

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 a material in ambient lighting.

ambientTexture

ambientTexture: Nullable<BaseTexture>

AKA Occlusion Texture in other nomenclature.

ambientTextureImpactOnAnalyticalLights

ambientTextureImpactOnAnalyticalLights: number

Defines how much the AO map is occluding the analytical lights (point spot...). 1 means it completely occludes it 0 mean it has no impact

ambientTextureStrength

ambientTextureStrength: number

AKA Occlusion Texture Intensity in other nomenclature.

animations

animations: Nullable<Animation[]>

Stores the animations for the material

`Readonly`anisotropy

anisotropy: PBRAnisotropicConfiguration

Defines the anisotropic parameters 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)

baseWeight

baseWeight: number

OpenPBR Base Weight (multiplier to the diffuse and metal lobes).

baseWeightTexture

baseWeightTexture: Nullable<BaseTexture>

OpenPBR Base Weight (multiplier to the diffuse and metal lobes).

`Readonly`brdf

brdf: PBRBRDFConfiguration

Defines the BRDF parameters for the material.

bumpTexture

bumpTexture: Nullable<BaseTexture>

Stores surface normal data used to displace a mesh in a texture.

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

`Readonly`clearCoat

clearCoat: PBRClearCoatConfiguration

Defines the clear coat layer parameters for the material.

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.

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.

directIntensity

directIntensity: number

Intensity of the direct lights e.g. the four lights available in your scene. This impacts both the direct diffuse and specular highlights.

disableBumpMap

disableBumpMap: boolean

Debug Control allowing disabling the bump map on this material.

disableColorWrite

disableColorWrite: boolean

Specifies if color writing should be disabled

disableDepthWrite

disableDepthWrite: boolean

Specifies if depth writing should be disabled

disableLighting

disableLighting: boolean

If sets to true, disables all the lights affecting the material.

doNotSerialize

doNotSerialize: boolean

Specifies if the material should be serialized

emissiveColor

emissiveColor: Color3

The color emitted from the material.

emissiveIntensity

emissiveIntensity: number

Intensity of the emissive part of the material. This helps controlling the emissive effect without modifying the emissive color.

emissiveTexture

emissiveTexture: Nullable<BaseTexture>

Stores the emissive values in a texture.

enableSpecularAntiAliasing

enableSpecularAntiAliasing: boolean

Enables specular anti aliasing in the PBR shader. It will both interacts on the Geometry for analytical and IBL lighting. It also prefilter the roughness map based on the bump values.

environmentBRDFTexture

environmentBRDFTexture: Nullable<BaseTexture>

Let user defines the brdf lookup texture used for IBL. A default 8bit version is embedded but you could point at :

Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds

environmentIntensity

environmentIntensity: number

Intensity of the environment e.g. how much the environment will light the object either through harmonics for rough material or through the reflection for shiny ones.

forceAlphaTest

forceAlphaTest: boolean

Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.

forceDepthWrite

forceDepthWrite: boolean

Specifies if depth writing should be forced

forceIrradianceInFragment

forceIrradianceInFragment: boolean

Force the shader to compute irradiance in the fragment shader in order to take bump in account.

forceNormalForward

forceNormalForward: boolean

Force normal to face away from face.

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

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).

`Readonly`iridescence

iridescence: PBRIridescenceConfiguration

Defines the iridescence layer parameters for the material.

lightmapTexture

lightmapTexture: Nullable<BaseTexture>

Stores the pre-calculated light information of a mesh in a texture.

maxSimultaneousLights

maxSimultaneousLights: number

Number of Simultaneous lights allowed on the material.

metadata

metadata: any

Gets or sets user defined metadata

metallic

metallic: Nullable<number>

Specifies the metallic scalar of the metallic/roughness workflow. Can also be used to scale the metalness values of the metallic texture.

metallicF0Factor

metallicF0Factor: number

In metallic workflow, specifies an F0 factor to help configuring the material F0. By default the indexOfrefraction is used to compute F0;

This is used as a factor against the default reflectance at normal incidence to tweak it.

F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor; F90 = metallicReflectanceColor;

metallicReflectanceColor

metallicReflectanceColor: Color3

In metallic workflow, specifies an F0 color. By default the F90 is always 1;

Please note that this factor is also used as a factor against the default reflectance at normal incidence.

F0 = defaultF0_from_IOR * metallicF0Factor * metallicReflectanceColor F90 = metallicF0Factor;

metallicReflectanceTexture

metallicReflectanceTexture: Nullable<BaseTexture>

Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A This is multiplied against the scalar values defined in the material. If useOnlyMetallicFromMetallicReflectanceTexture is true, don't use the RGB channels, only A

metallicTexture

metallicTexture: Nullable<BaseTexture>

Used to switch from specular/glossiness to metallic/roughness workflow.

microSurface

microSurface: number

AKA Glossiness in other nomenclature.

microSurfaceTexture

microSurfaceTexture: Nullable<BaseTexture>

Used to enable roughness/glossiness fetch from a separate channel depending on the current mode. Gray Scale represents roughness in metallic mode and glossiness in specular mode.

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>

Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.

parallaxScaleBias

parallaxScaleBias: number

Controls the scale bias of the parallax mode.

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

reflectanceTexture

reflectanceTexture: Nullable<BaseTexture>

Defines to store reflectanceColor in RGB This is multiplied against the scalar values defined in the material. If both reflectanceTexture and metallicReflectanceTexture textures are provided and useOnlyMetallicFromMetallicReflectanceTexture is false, metallicReflectanceTexture takes priority and reflectanceTexture is not used

reflectionColor

reflectionColor: Color3

The color reflected from the material.

reflectionTexture

reflectionTexture: Nullable<BaseTexture>

Stores the reflection values in a texture.

reflectivityColor

reflectivityColor: Color3

AKA Specular Color in other nomenclature.

reflectivityTexture

reflectivityTexture: Nullable<BaseTexture>

AKA Specular texture in other nomenclature.

reservedDataStore

reservedDataStore: any

For internal use only. Please do not use.

roughness

roughness: Nullable<number>

Specifies the roughness scalar of the metallic/roughness workflow. Can also be used to scale the roughness values of the metallic texture.

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

`Readonly`sheen

sheen: PBRSheenConfiguration

Defines the Sheen parameters for the material.

sideOrientation

sideOrientation: Nullable<number>

Stores the value for side orientation

specularIntensity

specularIntensity: number

This is a special control allowing the reduction of the specular highlights coming from the four lights of the scene. Those highlights may not be needed in full environment lighting.

state

state: string

The state of the material

`Readonly`stencil

stencil: MaterialStencilState

Gives access to the stencil properties of the material

`Readonly`subSurface

subSurface: PBRSubSurfaceConfiguration

Defines the SubSurface parameters for 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

unlit

unlit: boolean

If set to true, no lighting calculations will be applied.

useAlphaFresnel

useAlphaFresnel: boolean

A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested. And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)

useAlphaFromAlbedoTexture

useAlphaFromAlbedoTexture: boolean

Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.

useAmbientInGrayScale

useAmbientInGrayScale: boolean

Specifies if the ambient texture contains the ambient occlusion information in its red channel only.

useAmbientOcclusionFromMetallicTextureRed

useAmbientOcclusionFromMetallicTextureRed: boolean

Specifies if the metallic texture contains the ambient occlusion information in its red channel.

useAutoMicroSurfaceFromReflectivityMap

useAutoMicroSurfaceFromReflectivityMap: boolean

In case the reflectivity map does not contain the microsurface information in its alpha channel, The material will try to infer what glossiness each pixel should be.

useHorizonOcclusion

useHorizonOcclusion: boolean

This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal makes the reflect vector face the model (under horizon).

useLightmapAsShadowmap

useLightmapAsShadowmap: boolean

If true, the light map contains occlusion information instead of lighting info.

useLinearAlphaFresnel

useLinearAlphaFresnel: boolean

A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested. And/Or occlude the blended part. (alpha stays linear to compute the fresnel)

useMetallnessFromMetallicTextureBlue

useMetallnessFromMetallicTextureBlue: boolean

Specifies if the metallic texture contains the metallness information in its blue channel.

useMicroSurfaceFromReflectivityMapAlpha

useMicroSurfaceFromReflectivityMapAlpha: boolean

Specifies if the reflectivity texture contains the glossiness information in its alpha channel.

useObjectSpaceNormalMap

useObjectSpaceNormalMap: boolean

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

useOnlyMetallicFromMetallicReflectanceTexture

useOnlyMetallicFromMetallicReflectanceTexture: boolean

Specifies that only the A channel from metallicReflectanceTexture should be used. If false, both RGB and A channels will be used

useParallax

useParallax: boolean

Allows using the bump map in parallax mode.

useParallaxOcclusion

useParallaxOcclusion: boolean

Allows using the bump map in parallax occlusion mode.

useRadianceOcclusion

useRadianceOcclusion: boolean

This parameters will enable/disable radiance occlusion by preventing the radiance to lit too much the area relying on ambient texture to define their ambient occlusion.

useRadianceOverAlpha

useRadianceOverAlpha: 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 example of that. When the street lights reflects on it you can not see what is behind.

useRoughnessFromMetallicTextureAlpha

useRoughnessFromMetallicTextureAlpha: boolean

Specifies if the metallic texture contains the roughness information in its alpha channel.

useRoughnessFromMetallicTextureGreen

useRoughnessFromMetallicTextureGreen: boolean

Specifies if the metallic texture contains the roughness information in its green channel. Needs useRoughnessFromMetallicTextureAlpha to be false.

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 example of that. When sun reflects on it you can not see what is behind.

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

DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number

Defines the default value of how much AO map is occluding the analytical lights (point spot...).

`Static`ForceGLSL

ForceGLSL: boolean

Force all the PBR 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`LIGHTFALLOFF_GLTF

LIGHTFALLOFF_GLTF: 1

PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document to enhance interoperability with other engines.

`Static` `Readonly`LIGHTFALLOFF_PHYSICAL

LIGHTFALLOFF_PHYSICAL: 0

PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.

`Static` `Readonly`LIGHTFALLOFF_STANDARD

LIGHTFALLOFF_STANDARD: 2

PBRMaterialLightFalloff Standard: light is falling off like in the standard material to enhance interoperability with other materials.

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

PBRMATERIAL_ALPHABLEND: 2

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

`Static` `Readonly`PBRMATERIAL_ALPHATEST

PBRMATERIAL_ALPHATEST: 1

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

`Static` `Readonly`PBRMATERIAL_ALPHATESTANDBLEND

PBRMATERIAL_ALPHATESTANDBLEND: 3

PBRMaterialTransparencyMode: 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`PBRMATERIAL_OPAQUE

PBRMATERIAL_OPAQUE: 0

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

`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 PBRBaseMaterial.alpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73011
set alpha(value: number): void
Sets the alpha value of the material
Parameters
- value: number
Returns void
Inherited from PBRBaseMaterial.alpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73007

alphaMode

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

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

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 PBRBaseMaterial.backFaceCulling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73023
set backFaceCulling(value: boolean): void
Sets the culling state (true to enable culling, false to disable)
Parameters
- value: boolean
Returns void
Inherited from PBRBaseMaterial.backFaceCulling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73019

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

cameraColorCurves

get cameraColorCurves(): Nullable<ColorCurves>
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.

Returns Nullable<ColorCurves>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81752
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81759

cameraColorCurvesEnabled

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

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

cameraColorGradingEnabled

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

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

cameraColorGradingTexture

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

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

cameraContrast

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

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

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81723
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81729

cameraToneMappingEnabled

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

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

canRenderToMRT

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

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

cullBackFaces

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

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

fillMode

get fillMode(): number
Gets the material fill mode

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

fogEnabled

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

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

hasRenderTargetTextures

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

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

imageProcessingConfiguration

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

Returns ImageProcessingConfiguration
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81687
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81693

indexOfRefraction

get indexOfRefraction(): number
Index of refraction of the material base layer. https://en.wikipedia.org/wiki/List_of_refractive_indices

This does not only impact refraction but also the Base F0 of Dielectric Materials.

From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81506
set indexOfRefraction(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81507

invertRefractionY

get invertRefractionY(): boolean
Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81511
set invertRefractionY(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81512

isFrozen

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

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

isPrePassCapable

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

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

linkRefractionWithTransparency

get linkRefractionWithTransparency(): boolean
This parameters will make the material used its opacity to control how much it is refracting against not. Materials half opaque for instance using refraction could benefit from this control.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81517
set linkRefractionWithTransparency(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81518

needDepthPrePass

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

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

onBind

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

onBindObservable

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

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

onDispose

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

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 PBRBaseMaterial.onEffectCreatedObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73119

onUnBindObservable

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

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

pointsCloud

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

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

realTimeFiltering

get realTimeFiltering(): boolean
Enables realtime filtering on the texture.

Returns boolean
Inherited from PBRBaseMaterial.realTimeFiltering
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82720
set realTimeFiltering(b: boolean): void
Parameters
- b: boolean
Returns void
Inherited from PBRBaseMaterial.realTimeFiltering
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82721

realTimeFilteringQuality

get realTimeFilteringQuality(): number
Quality switch for realtime filtering

Returns number
Inherited from PBRBaseMaterial.realTimeFilteringQuality
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82726
set realTimeFilteringQuality(n: number): void
Parameters
- n: number
Returns void
Inherited from PBRBaseMaterial.realTimeFilteringQuality
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82727

refractionTexture

get refractionTexture(): Nullable<BaseTexture>
Stores the refracted light information in a texture.

Returns Nullable<BaseTexture>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81468
set refractionTexture(value: Nullable<BaseTexture>): void
Parameters
- value: Nullable<BaseTexture>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81469

shaderLanguage

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

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

transparencyMode

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

Returns Nullable<number>
Inherited from PBRBaseMaterial.transparencyMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73409
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 PBRBaseMaterial.transparencyMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73421

Value	Type	Description
0	OPAQUE
1	ALPHATEST
2	ALPHABLEND
3	ALPHATESTANDBLEND

useGLTFLightFalloff

get useGLTFLightFalloff(): boolean
In order to support the falloff compatibility with gltf, a special mode has been added to reproduce the gltf light falloff.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81586
set useGLTFLightFalloff(value: boolean): void
In order to support the falloff compatibility with gltf, a special mode has been added to reproduce the gltf light falloff.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81591

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

usePhysicalLightFalloff

get usePhysicalLightFalloff(): boolean
BJS is using an hardcoded light falloff based on a manually sets up range. In PBR, one way to represents the falloff is to use the inverse squared root algorithm. This parameter can help you switch back to the BJS mode in order to create scenes using both materials.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81575
set usePhysicalLightFalloff(value: boolean): void
BJS is using an hardcoded light falloff based on a manually sets up range. In PBR, one way to represents the falloff is to use the inverse squared root algorithm. This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81581

wireframe

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

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

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 PBRBaseMaterial.bind
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70729

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

bindForSubMesh

bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void
Binds the submesh data.
Parameters
- world: Matrix
  The world matrix.
- mesh: Mesh
  The BJS mesh.
- subMesh: SubMesh
  A submesh of the BJS mesh.
Returns void
Inherited from PBRBaseMaterial.bindForSubMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82908

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 PBRBaseMaterial.bindOnlyNormalMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70728

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 PBRBaseMaterial.bindOnlyWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:70722

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 PBRBaseMaterial.bindView
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73493

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

buildUniformLayout

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

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

clone

clone(
    name: string,
    cloneTexturesOnlyOnce?: boolean,
    rootUrl?: string,
): PBRMaterial
Makes a duplicate of the current material.
Parameters
- name: string
  name to use for the new 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 PBRMaterial
cloned material instance
Overrides PBRBaseMaterial.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81779

dispose

dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void
Disposes the resources of the material.
Parameters
- OptionalforceDisposeEffect: boolean
  Forces the disposal of effects.
- OptionalforceDisposeTextures: boolean
  Forces the disposal of all textures.
Returns void
Inherited from PBRBaseMaterial.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82943

forceCompilation

forceCompilation(
    mesh: AbstractMesh,
    onCompiled?: (material: Material) => void,
    options?: Partial<IMaterialCompilationOptions>,
): void
Force shader compilation
Parameters
- mesh: AbstractMesh
  Define the mesh we want to force the compilation for
- OptionalonCompiled: (material: Material) => void
  Define a callback triggered when the compilation completes
- Optionaloptions: Partial<IMaterialCompilationOptions>
  Define the options used to create the compilation
Returns void
Inherited from PBRBaseMaterial.forceCompilation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82897

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

freeze

freeze(): void
Locks updates for the material

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

getActiveTextures

getActiveTextures(): BaseTexture[]
Returns an array of the actively used textures.

Returns BaseTexture[]
- Array of BaseTextures
Inherited from PBRBaseMaterial.getActiveTextures
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82924

getAlphaTestTexture

getAlphaTestTexture(): Nullable<BaseTexture>
Returns Nullable<BaseTexture>
the texture used for the alpha test.
Inherited from PBRBaseMaterial.getAlphaTestTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82875

getAnimatables

getAnimatables(): IAnimatable[]
Returns the animatable textures. If material have animatable metallic texture, then reflectivity texture will not be returned, even if it has animations.

Returns IAnimatable[]
- Array of animatable textures.
Inherited from PBRBaseMaterial.getAnimatables
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82914

getBindedMeshes

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

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

getClassName

getClassName(): string
Returns string
the name of this material class.
Overrides PBRBaseMaterial.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81771

getEffect

getEffect(): Effect
Returns the material effect

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

getScene

getScene(): Scene
Returns the current scene

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

hasTexture

hasTexture(texture: BaseTexture): boolean
Checks to see if a texture is used in the material.
Parameters
- texture: BaseTexture
  Base texture to use.
Returns boolean
- Boolean specifying if a texture is used in the material.
Inherited from PBRBaseMaterial.hasTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82930

isMetallicWorkflow

isMetallicWorkflow(): boolean
Specifies if the material uses metallic roughness workflow.

Returns boolean
boolean specifying if the material uses metallic roughness workflow.
Inherited from PBRBaseMaterial.isMetallicWorkflow
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82888

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

isReadyForSubMesh

isReadyForSubMesh(
    mesh: AbstractMesh,
    subMesh: SubMesh,
    useInstances?: boolean,
): boolean
Specifies that the submesh is ready to be used.
Parameters
- mesh: AbstractMesh
  BJS mesh.
- subMesh: SubMesh
  A submesh of the BJS mesh. Used to check if it is ready.
- OptionaluseInstances: boolean
  Specifies that instances should be used.
Returns boolean
- boolean indicating that the submesh is ready or not.
Inherited from PBRBaseMaterial.isReadyForSubMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82883

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 PBRBaseMaterial.markAsDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73575

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

needAlphaBlending

needAlphaBlending(): boolean
Returns boolean
whether or not this material should be rendered in alpha blend mode.
Inherited from PBRBaseMaterial.needAlphaBlending
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82859

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

needAlphaTesting

needAlphaTesting(): boolean
Returns boolean
whether or not this material should be rendered in alpha test mode.
Inherited from PBRBaseMaterial.needAlphaTesting
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82863

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 PBRBaseMaterial.needAlphaTestingForMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:73452

resetDrawCache

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

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

serialize

serialize(): any
Serializes this PBR Material.

Returns any
- An object with the serialized material.
Overrides PBRBaseMaterial.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81784

setPrePassRenderer

setPrePassRenderer(): boolean
Sets the required values to the prepass renderer. It can't be sets when subsurface scattering of this material is disabled. When scene have ability to enable subsurface prepass effect, it will enable.

Returns boolean
- If prepass is enabled or not.
Inherited from PBRBaseMaterial.setPrePassRenderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:82937

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

unbind

unbind(): void
Unbinds the material from the mesh

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

unfreeze

unfreeze(): void
Unlocks updates for the material

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

`Static`Parse

Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial
Parses a PBR Material from a serialized object.
Parameters
- source: any
  Serialized object.
- scene: Scene
  BJS scene instance.
- rootUrl: string
  url for the scene object
Returns PBRMaterial
- PBRMaterial
Overrides PBRBaseMaterial.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:81792

Class PBRMaterial

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PBRMaterial

Properties

albedoColor

albedoTexture

allowShaderHotSwapping

alphaCutOff

ambientColor

ambientTexture

ambientTextureImpactOnAnalyticalLights

ambientTextureStrength

animations

Readonlyanisotropy

applyDecalMapAfterDetailMap

baseWeight

baseWeightTexture

Readonlybrdf

bumpTexture

checkReadyOnEveryCall

checkReadyOnlyOnce

ReadonlyclearCoat

clipPlane

clipPlane2

clipPlane3

clipPlane4

clipPlane5

clipPlane6

customShaderNameResolve

decalMap

depthFunction

ReadonlydetailMap

directIntensity

disableBumpMap

disableColorWrite

disableDepthWrite

disableLighting

doNotSerialize

emissiveColor

emissiveIntensity

emissiveTexture

enableSpecularAntiAliasing

environmentBRDFTexture

environmentIntensity

forceAlphaTest

forceDepthWrite

forceIrradianceInFragment

forceNormalForward

getRenderTargetTextures

id

inspectableCustomProperties

See

invertNormalMapX

invertNormalMapY

Readonlyiridescence

lightmapTexture

maxSimultaneousLights

metadata

metallic

metallicF0Factor

metallicReflectanceColor

metallicReflectanceTexture

metallicTexture

microSurface

microSurfaceTexture

name

onCompiled

onDisposeObservable

onError

opacityTexture

parallaxScaleBias

OptionalpluginManager

`Readonly`anisotropy

`Readonly`brdf

`Readonly`clearCoat

`Readonly`detailMap

`Readonly`iridescence

`Optional`pluginManager

`Readonly`prePassConfiguration

`Readonly`sheen

`Readonly`stencil

`Readonly`subSurface

`Static` `Readonly`AllDirtyFlag

`Static` `Readonly`AttributesDirtyFlag

`Static` `Readonly`ClockWiseSideOrientation

`Static` `Readonly`CounterClockWiseSideOrientation

`Static`DEFAULT_AO_ON_ANALYTICAL_LIGHTS

`Static`ForceGLSL

`Static` `Readonly`FresnelDirtyFlag

`Static` `Readonly`ImageProcessingDirtyFlag

`Static` `Readonly`LightDirtyFlag

`Static` `Readonly`LIGHTFALLOFF_GLTF

`Static` `Readonly`LIGHTFALLOFF_PHYSICAL

`Static` `Readonly`LIGHTFALLOFF_STANDARD

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

`Static` `Readonly`PBRMATERIAL_ALPHATEST

`Static` `Readonly`PBRMATERIAL_ALPHATESTANDBLEND

`Static` `Readonly`PBRMATERIAL_OPAQUE

`Static` `Readonly`PointFillMode

`Static` `Readonly`PointListDrawMode