OptionalallowOptionalalphaEnables 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.
OptionalalphaOptionalalphaWhether 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.
OptionalblendRepresents the alpha value of the constant blend color.
This property has only an effect when using custom blending with ConstantAlpha or OneMinusConstantAlpha.
OptionalblendRepresents the RGB values of the constant blend color.
This property has only an effect when using custom blending with ConstantColor or OneMinusConstantColor.
OptionalblendDefines the blending destination factor.
OptionalblendDefines the blending destination alpha factor.
OptionalblendDefines the blending equation.
OptionalblendDefines the blending equation of the alpha channel.
OptionalblendingDefines 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.
OptionalblendDefines the blending source factor.
OptionalblendDefines the blending source alpha factor.
OptionalclipChanges the behavior of clipping planes so that only their intersection is clipped, rather than their union.
OptionalclippingDefines whether this material supports clipping; true to let the renderer
pass the clippingPlanes uniform.
OptionalclippingUser-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.
OptionalclipDefines whether to clip shadows according to the clipping planes specified on this material.
OptionalcolorOptionalcolorWhether to render the material's color.
This can be used in conjunction with Object3D#renderOder to create invisible objects that occlude other objects.
OptionaldebugDebug mode for the material. You can visualize several components for diagnosis using debug mode.
OptionaldefaultWhen the rendered geometry doesn't include these attributes but the material does, these default values will be passed to the shaders. This avoids errors when buffer data is missing.
OptionaldefinesDefines custom constants using #define directives within the GLSL code
for both the vertex shader and the fragment shader; each key/value pair
yields another directive.
defines: {
FOO: 15,
BAR: true
}
Yields the lines:
#define FOO 15
#define BAR true
OptionaldepthDefines the depth function.
OptionaldepthWhether to have depth test enabled when rendering this material. When the depth test is disabled, the depth write will also be implicitly disabled.
OptionaldepthWhether 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.
OptionalditheringWhether to apply dithering to the color to remove the appearance of banding.
OptionalemissiveOptionalemissiveOptionalemissiveOptionalextensionsThis object allows to enable certain WebGL 2 extensions.
true to use vertex shader clippingtrue to use vertex shader multi_draw / enable gl_DrawIDOptionalfogWhether the material is affected by fog.
true by default.
OptionalforceWhether 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.
OptionalfragmentFragment shader GLSL code. This is the actual code for the shader.
OptionalgiOptionalglslDefines the GLSL version of custom shader code.
OptionalignoreWhen this is true, vertex colors will be ignored.
true by default.
Optionalindex0If set, this calls [gl.bindAttribLocation]https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/bindAttribLocation to bind a generic vertex index to an attribute variable.
OptionalisIt will draw its outline instead when it's true.
OptionallightsDefines whether this material uses lighting; true to pass uniform data
related to lighting to this shader.
OptionallinewidthControls line thickness or lines.
WebGL and WebGPU ignore this setting and always render line primitives with a width of one pixel.
OptionalmapOptionalmatcapOptionalmatcapOptionalnameThe name of the material.
OptionalnormalOptionalnormalOptionalopacityDefines 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.
OptionaloutlineOptionaloutlineOptionaloutlineOptionaloutlineOptionaloutlineOptionalparametricOptionalparametricOptionalparametricOptionalpolygonWhether 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.
OptionalpolygonSpecifies a scale factor that is used to create a variable depth offset for each polygon.
OptionalpolygonIs multiplied by an implementation-specific value to create a constant depth offset.
OptionalprecisionOverride the renderer's default precision for this material.
OptionalpremultipliedWhether to premultiply the alpha (transparency) value.
OptionalrimOptionalrimOptionalshadeOptionalshadeOptionalshadingOptionalshadingOptionalshadingOptionalshadingOptionalshadowDefines which side of faces cast shadows. If null, the side casting shadows
is determined as follows:
FrontSide, the back side cast shadows.BackSide, the front side cast shadows.DoubleSide, both sides cast shadows.OptionalsideDefines which side of faces will be rendered - front, back or both.
OptionalstencilWhich stencil operation to perform when the comparison function returns false.
OptionalstencilThe stencil comparison function to use.
OptionalstencilThe bit mask to use when comparing against the stencil buffer.
OptionalstencilThe value to use when performing stencil comparisons or stencil operations.
OptionalstencilWhether stencil operations are performed against the stencil buffer. In
order to perform writes or comparisons against the stencil buffer this
value must be true.
OptionalstencilThe bit mask to use when writing to the stencil buffer.
OptionalstencilWhich stencil operation to perform when the comparison function returns
true but the depth test fails.
OptionalstencilWhich stencil operation to perform when the comparison function returns
true and the depth test passes.
OptionaltoneDefines 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.
OptionaltransparentDefines 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.
OptionaltransparentEnable depth buffer when renderMode is transparent. Will be processed in the constructor.
OptionaluniformsAn object of the form:
{
"uniform1": { value: 1.0 },
"uniform2": { value: 2 }
}
specifying the uniforms to be passed to the shader code; keys are uniform names, values are definitions of the form
{
value: 1.0
}
where value is the value of the uniform. Names must match the name of
the uniform, as defined in the GLSL code. Note that uniforms are refreshed
on every frame, so updating the value of the uniform will immediately
update the value available to the GLSL code.
OptionaluniformsAn array holding uniforms groups for configuring UBOs.
OptionaluniformsCan be used to force a uniform update while changing uniforms in Object3D#onBeforeRender.
OptionaluserAn 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.
OptionaluvOptionaluvOptionaluvOptionaluvOptionalv0There is a line of the shader called "comment out if you want to PBR absolutely" in VRM0.0 MToon.
When this is true, the material enables the line to make it compatible with the legacy rendering of VRM.
Usually not recommended to turn this on.
false by default.
OptionalvertexIf 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.
OptionalvertexVertex shader GLSL code. This is the actual code for the shader.
OptionalvisibleDefines whether 3D objects using this material are visible.
OptionalwireframeRenders the geometry as a wireframe.
OptionalwireframeControls the thickness of the wireframe.
WebGL and WebGPU ignore this property and always render 1 pixel wide lines.
Whether it's possible to override the material with Scene#overrideMaterial or not.