类 WaterMaterial

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

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.

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.

Represents the alpha value of the constant blend color.

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

Represents the RGB values of the constant blend color.

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

Defines the blending destination factor.

Defines the blending destination alpha factor.

Defines the blending equation.

Defines the blending equation of the alpha channel.

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.

Defines the blending source factor.

Defines the blending source alpha factor.

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

Defines whether this material supports clipping; true to let the renderer pass the clippingPlanes uniform.

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.

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

Whether to render the material's color.

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

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

• color: [ 1, 1, 1 ]
• uv: [ 0, 0 ]
• uv1: [ 0, 0 ]

Defines the depth function.

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

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.

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

This object allows to enable certain WebGL 2 extensions.

• clipCullDistance: set to true to use vertex shader clipping
• multiDraw: set to true to use vertex shader multi_draw / enable gl_DrawID

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.

Defines the GLSL version of custom shader code.

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

This flag can be used for type testing.

This flag can be used for type testing.

Controls line thickness or lines.

WebGL and WebGPU ignore this setting and always render line primitives with a width of one pixel.

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.

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.

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

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

Override the renderer's default precision for this material.

Whether to premultiply the alpha (transparency) value.

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.

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

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

The stencil comparison function to use.

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

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

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.

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

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

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

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.

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

An array holding uniforms groups for configuring UBOs.

Can be used to force a uniform update while changing uniforms in Object3D#onBeforeRender.

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.

The UUID of the material.

This starts at 0 and counts how many times Material#needsUpdate is set to true.

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.

Defines whether 3D objects using this material are visible.

Renders the geometry as a wireframe.

Controls the thickness of the wireframe.

WebGL and WebGPU ignore this property and always render 1 pixel wide lines.