Interface PipelinePBRMaterialParameters

Whether it's possible to override the material with Scene#overrideMaterial or not.

Default

true
Copy

Enables alpha hashed transparency, an alternative to Material#transparent or Material#alphaTest. The material will not be rendered if opacity is lower than a random threshold. Randomization introduces some grain or noise, but approximates alpha blending without the associated problems of sorting. Using TAA can reduce the resulting noise.

Default

false
Copy

Whether alpha to coverage should be enabled or not. Can only be used with MSAA-enabled contexts (meaning when the renderer was created with antialias parameter set to true). Enabling this will smooth aliasing on clip plane edges and alphaTest-clipped edges.

Default

false
Copy

Represents the alpha value of the constant blend color.

This property has only an effect when using custom blending with ConstantAlpha or OneMinusConstantAlpha.

Default

0
Copy

Represents the RGB values of the constant blend color.

This property has only an effect when using custom blending with ConstantColor or OneMinusConstantColor.

Default

(0,0,0)
Copy

Defines the blending destination factor.

Default

OneMinusSrcAlphaFactor
Copy

Defines the blending destination alpha factor.

Default

null
Copy

Defines the blending equation.

Default

AddEquation
Copy

Defines the blending equation of the alpha channel.

Default

null
Copy

Defines the blending source factor.

Default

SrcAlphaFactor
Copy

Defines the blending source alpha factor.

Default

null
Copy

Defines the blending type of the material.

It must be set to CustomBlending if custom blending properties like Material#blendSrc, Material#blendDst or Material#blendEquation should have any effect.

Default

NormalBlending
Copy

Changes the behavior of clipping planes so that only their intersection is clipped, rather than their union.

Default

false
Copy

Defines whether to clip shadows according to the clipping planes specified on this material.

Default

false
Copy

User-defined clipping planes specified as THREE.Plane objects in world space. These planes apply to the objects this material is attached to. Points in space whose signed distance to the plane is negative are clipped (not rendered). This requires WebGLRenderer#localClippingEnabled to be true.

Default

null
Copy

Whether to render the material's color.

This can be used in conjunction with Object3D#renderOder to create invisible objects that occlude other objects.

Default

true
Copy

Defines the depth function.

Default

LessEqualDepth
Copy

Whether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write will also be implicitly disabled.

Default

true
Copy

Whether rendering this material has any effect on the depth buffer.

When drawing 2D overlays it can be useful to disable the depth writing in order to layer several things together without creating z-index artifacts.

Default

true
Copy

Whether to apply dithering to the color to remove the appearance of banding.

Default

false
Copy

Whether double-sided, transparent objects should be rendered with a single pass or not.

The engine renders double-sided, transparent objects with two draw calls (back faces first, then front faces) to mitigate transparency artifacts. There are scenarios however where this approach produces no quality gains but still doubles draw calls e.g. when rendering flat vegetation like grass sprites. In these cases, set the forceSinglePass flag to true to disable the two pass rendering to avoid performance issues.

Default

false
Copy

The name of the material.

Defines how transparent the material is. A value of 0.0 indicates fully transparent, 1.0 is fully opaque.

If the Material#transparent is not set to true, the material will remain fully opaque and this value will only affect its color.

Default

1
Copy

Whether to use polygon offset or not. When enabled, each fragment's depth value will be offset after it is interpolated from the depth values of the appropriate vertices. The offset is added before the depth test is performed and before the value is written into the depth buffer.

Can be useful for rendering hidden-line images, for applying decals to surfaces, and for rendering solids with highlighted edges.

Default

false
Copy

Specifies a scale factor that is used to create a variable depth offset for each polygon.

Default

0
Copy

Is multiplied by an implementation-specific value to create a constant depth offset.

Default

0
Copy

Override the renderer's default precision for this material.

Default

null
Copy

Whether to premultiply the alpha (transparency) value.

Default

false
Copy

Defines which side of faces cast shadows. If null, the side casting shadows is determined as follows:

• When Material#side is set to FrontSide, the back side cast shadows.
• When Material#side is set to BackSide, the front side cast shadows.
• When Material#side is set to DoubleSide, both sides cast shadows.

Default

null
Copy

Defines which side of faces will be rendered - front, back or both.

Default

FrontSide
Copy

Which stencil operation to perform when the comparison function returns false.

Default

KeepStencilOp
Copy

The stencil comparison function to use.

Default

AlwaysStencilFunc
Copy

The bit mask to use when comparing against the stencil buffer.

Default

0xff
Copy

The value to use when performing stencil comparisons or stencil operations.

Default

0
Copy

Whether stencil operations are performed against the stencil buffer. In order to perform writes or comparisons against the stencil buffer this value must be true.

Default

false
Copy

The bit mask to use when writing to the stencil buffer.

Default

0xff
Copy

Which stencil operation to perform when the comparison function returns true but the depth test fails.

Default

KeepStencilOp
Copy

Which stencil operation to perform when the comparison function returns true and the depth test passes.

Default

KeepStencilOp
Copy

Defines whether this material is tone mapped according to the renderer's tone mapping setting.

It is ignored when rendering to a render target or using post processing or when using WebGPURenderer. In all these cases, all materials are honored by tone mapping.

Default

true
Copy

Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects.

When set to true, the extent to which the material is transparent is controlled by Material#opacity.

Default

false
Copy

An object that can be used to store custom data about the Material. It should not hold references to functions as these will not be cloned.

If set to true, vertex colors should be used.

The engine supports RGB and RGBA vertex colors depending on whether a three (RGB) or four (RGBA) component color buffer attribute is used.

Default

false
Copy

Defines whether 3D objects using this material are visible.

Default

true
Copy