Class PBRCustomMaterial

AKA Diffuse Color in other nomenclature.

AKA Diffuse Texture in standard nomenclature.

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)

Defines the alpha limits in alpha test mode.

The color of a material in ambient lighting.

AKA Occlusion Texture in other nomenclature.

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

AKA Occlusion Texture Intensity in other nomenclature.

Stores the animations for the material

Defines the anisotropic parameters for the material.

Defines the BRDF parameters for the material.

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

Specifies if the ready state should be checked on each call

Specifies if the ready state should be checked once

Defines the clear coat layer parameters for the material.

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

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

Defines the detail map parameters for the material.

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

Debug Control allowing disabling the bump map on this material.

Specifies if color writing should be disabled

Specifies if depth writing should be disabled

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

Specifies if the material should be serialized

The color emitted from the material.

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

Stores the emissive values in a texture.

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.

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

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.

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

Specifies if depth writing should be forced

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

Force normal to face away from face.

Callback triggered to get the render target textures

The ID of the material

List of inspectable custom properties (used by the Inspector)

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

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

Defines the iridescence layer parameters for the material.

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

Number of Simultaneous lights allowed on the material.

Gets or sets user defined metadata

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

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

In metallic workflow, specifies an F90 color to help configuring the material F90. By default the F90 is always 1;

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

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

AKA Glossiness in other nomenclature.

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.

The name of the material

Callback triggered when the material is compiled

An event triggered when the material is disposed

Callback triggered when an error occurs

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

Controls the scale bias of the parallax mode.

Stores the size of points

Defines additional PrePass parameters for the material.

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

The color reflected from the material.

Stores the reflection values in a texture.

AKA Specular Color in other nomenclature.

AKA Specular texture in other nomenclature.

For internal use only. Please do not use.

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

Specifies if there should be a separate pass for culling

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

Defines the Sheen parameters for the material.

Stores the value for side orientation

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.

The state of the material

Gives access to the stencil properties of the material

Defines the SubSurface parameters for the material.

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

Gets or sets the unique id of the material

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

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)

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

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

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

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.

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

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

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)

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

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

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

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

Allows using the bump map in parallax mode.

Allows using the bump map in parallax occlusion mode.

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.

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.

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

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

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.

Stores the z offset Factor value

Stores the z offset Units value