Instantiates a new standard material. This is the default material used in Babylon. It is the best trade off between quality and performances.
Define the name of the material in the scene
Define the scene the material belong to
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 the material lit by the environmental background lighting.
AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
Stores the animations for the material
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.
Specifies if the ready state should be checked on each call
Specifies if the ready state should be checked once
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.
The basic color of the material as viewed under a light.
Define the diffuse fresnel parameters of the material.
The basic texture of the material as viewed under a light.
Specifies if color writing should be disabled
Specifies if depth writing should be disabled
Does lights from the scene impacts this material. It can be a nice trick for performance to disable lighting on a fully emissive material.
Specifies if the material should be serialized
Define the color of the material as if self lit. This will be mixed in the final result even in the absence of light.
Define the emissive fresnel parameters of the material.
Define texture of the material as if self lit. This will be mixed in the final result even in the absence of light.
Specifies if depth writing should be forced
Callback triggered to get the render target textures
The ID of the material
In case of refraction, define the value of the index of refraction.
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).
Invert the refraction texture alongside the y axis. It can be useful with procedural textures or probe for instance.
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.
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.
Defines the maximum number of lights that can be used in the material
Gets or sets user defined metadata
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
Define the opacity fresnel parameters of the material.
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)
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.
Stores the size of points
Defines additionnal PrePass parameters for the material.
Define the reflection fresnel parameters of the material.
Define the texture used to display the reflection.
Define the refraction fresnel parameters of the material.
Define the texture used to display the refraction.
For internal use only. Please do not use.
Helps to define how blurry the reflections should appears in the material.
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
Stores the value for side orientation
Define how the color and intensity of the highlight given by the light in the material.
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.
Define how the color and intensity of the highlight given by the light in the material.
The state of 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
Does the transparency come from the diffuse texture alpha channel.
If true, the emissive value is added into the end result, otherwise it is multiplied in.
Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
In case of light mapping, define whether the map contains light or shadow informations.
Allows using an object space normal map (instead of tangent space).
Is parallax enabled or not.
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.
If true automatically deducts the fresnels values from the material specularity.
Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones). A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones). A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
Stores the z offset value
The all dirty flag value
The dirty attribute flag value
Stores the clock-wise side orientation
Stores the counter clock-wise side orientation
The dirty fresnel flag value
The dirty light flag value
Returns the line list draw mode
Returns the line loop draw mode
Returns the line strip draw mode
MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
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.
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/
The Whiteout method is used to blend normals. Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
The dirty misc flag value
Returns the point fill mode
Returns the point list draw mode
The dirty prepass flag value
The dirty texture flag value
Returns the triangle fan draw mode
Returns the triangle fill mode
Returns the triangle strip draw mode
Returns the wireframe mode
Gets the alpha value of the material
Sets the alpha value of the material
Gets the value of the alpha mode
| Value | Type | Description |
|---|---|---|
| 0 | ALPHA_DISABLE | |
| 1 | ALPHA_ADD | |
| 2 | ALPHA_COMBINE | |
| 3 | ALPHA_SUBTRACT | |
| 4 | ALPHA_MULTIPLY | |
| 5 | ALPHA_MAXIMIZED | |
| 6 | ALPHA_ONEONE | |
| 7 | ALPHA_PREMULTIPLIED | |
| 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
| 9 | ALPHA_INTERPOLATE | |
| 10 | ALPHA_SCREENMODE |
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 |
Gets the back-face culling state
Sets the back-face culling state
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.
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.
Gets wether the color curves effect is enabled.
Sets wether the color curves effect is enabled.
Gets wether the color grading effect is enabled.
Gets wether the color grading effect is enabled.
Gets the Color Grading 2D Lookup Texture.
Sets the Color Grading 2D Lookup Texture.
Gets The camera contrast used on this material.
Sets The camera contrast used on this material.
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.
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.
Gets wether tonemapping is enabled or not.
Sets wether tonemapping is enabled or not
Can this material render to several textures at once
Gets the material fill mode
Sets the material fill mode
Gets the value of the fog enabled state
Sets the state for enabling fog
Gets a boolean indicating that current material needs to register RTT
Gets the image processing configuration used either in this material.
If sets to null, the scene one is in use.
Sets the Default image processing configuration used either in the this material.
If sets to null, the scene one is in use.
Specifies if updates for the material been locked
Gets the depth pre-pass value
Sets the need depth pre-pass value
Called during a bind event
An event triggered when the material is bound
Called during a dispose event
An event triggered when the effect is (re)created
An event triggered when the material is unbound
Gets the value specifying if point clouds are enabled
Sets the state of point cloud mode
Gets the current transparency mode.
| Value | Type | Description |
|---|---|---|
| 0 | OPAQUE | |
| 1 | ALPHATEST | |
| 2 | ALPHABLEND | |
| 3 | ALPHATESTANDBLEND |
Sets the transparency mode of the material.
| Value | Type | Description |
|---|---|---|
| 0 | OPAQUE | |
| 1 | ALPHATEST | |
| 2 | ALPHABLEND | |
| 3 | ALPHATESTANDBLEND |
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.
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.
Sets the state of wireframe mode
Sets the state of wireframe mode
Are ambient textures enabled in the application.
Are ambient textures enabled in the application.
Are bump textures enabled in the application.
Are bump textures enabled in the application.
Are color grading textures enabled in the application.
Are color grading textures enabled in the application.
Are detail textures enabled in the application.
Are detail textures enabled in the application.
Are diffuse textures enabled in the application.
Are diffuse textures enabled in the application.
Are emissive textures enabled in the application.
Are emissive textures enabled in the application.
Are fresnels enabled in the application.
Are fresnels enabled in the application.
Are lightmap textures enabled in the application.
Are lightmap textures enabled in the application.
Are opacity textures enabled in the application.
Are opacity textures enabled in the application.
Are reflection textures enabled in the application.
Are reflection textures enabled in the application.
Are refraction textures enabled in the application.
Are refraction textures enabled in the application.
Are specular textures enabled in the application.
Are specular textures enabled in the application.
Binds the given normal matrix to the active effect
the matrix to bind
Binds the given world matrix to the active effect
the matrix to bind
Binds the scene's uniform buffer to the effect.
defines the effect to bind to the scene uniform buffer
defines the uniform buffer storing scene data
Binds the view matrix to the effect
defines the effect to bind the view matrix to
Binds the view projection matrix to the effect
defines the effect to bind the view projection matrix to
Builds the material UBO layouts. Used internally during the effect preparation.
Makes a duplicate of the material, and gives it a new name
defines the new name for the duplicated material
the cloned material
Disposes the material
specifies if effects should be forcefully disposed
specifies if textures should be forcefully disposed
Force shader compilation
defines the mesh associated with this material
defines a function to execute once the material is compiled
defines the options to configure the compilation
defines a function to execute if the material fails compiling
Force shader compilation
defines the mesh that will use this material
defines additional options for compiling the shaders
a promise that resolves when the compilation completes
Locks updates for the material
Gets the active textures from the material
an array of textures
Get the texture used for alpha test purpose.
the diffuse texture in case of the standard material.
Get the list of animatables in the material.
the list of animatables object used in the material
Gets the meshes bound to the material
an array of meshes bound to the material
Gets the current class name of the material e.g. "StandardMaterial" Mainly use in serialization.
the class name
Returns the current scene
a Scene
Specifies if the material uses a texture
defines the texture to check against the material
a boolean specifying if the material uses the texture
Get if the submesh is ready to be used and all its information available. Child classes can use it to update shaders
defines the mesh to check
defines which submesh to check
specifies that instances should be used
a boolean indicating that the submesh is ready or not
Marks a define in the material to indicate that it needs to be re-computed
defines a flag used to determine which parts of the material have to be marked as dirty
Marks the material to indicate that it needs to be re-calculated
Specifies if the material will require alpha blending
a boolean specifying if alpha blending is needed
Specifies if the mesh will require alpha blending
defines the mesh to check
a boolean specifying if alpha blending is needed for the mesh
Specifies if this material should be rendered in alpha test mode
a boolean specifying if an alpha test is needed.
Serializes this material in a JSON representation
the serialized material object
Sets the required values to the prepass renderer.
defines the prepass renderer to setup.
true if the pre pass is needed.
Returns a string representation of the current material
defines a boolean indicating which levels of logging is desired
a string with material information
Unbinds the material from the mesh
Unlocks updates for the material
Creates a standard material from parsed material data
defines the JSON representation of the material
defines the hosting scene
defines the root URL to use to load textures and relative dependencies
a new standard material
Generated using TypeDoc
This is the default material used in Babylon. It is the best trade off between quality and performances.
https://doc.babylonjs.com/babylon101/materials