Chapter 69: MeshDepthMaterial

Core Idea

A material for drawing geometry by depth. Depth is based off of the camera near and far plane. White is nearest, black is farthest.

alphaMap : Texture: The alpha map is a grayscale texture that controls the opacity across the surface (black: fully transparent; white: fully opaque).
depthPacking : BasicDepthPacking | RGBADepthPacking | RGBDepthPacking | RGDepthPacking: Type for depth packing.
displacementBias : number: The offset of the displacement map's values on the mesh's vertices. The bias is added to the scaled sample of the displacement map. Without…
displacementMap : Texture: The displacement map affects the position of the mesh's vertices. Unlike other maps which only affect the light and shade of the material t…
displacementScale : number: How much the displacement map affects the mesh (where black is no displacement, and white is maximum displacement). Without a displacement …
isMeshDepthMaterial : boolean (readonly): This flag can be used for type testing.
map : Texture: The color map. May optionally include an alpha channel, typically combined with Material#transparent or [Mater…
wireframe : boolean: Renders the geometry as a wireframe.
wireframeLinewidth : number: Controls the thickness of the wireframe.

Constructor

Signature
`new MeshDepthMaterial( parameters : Object )`

Properties

Property	Description
`.alphaMap : Texture`	The alpha map is a grayscale texture that controls the opacity across the surface (black: fully transparent; white: fully opaque).
`.depthPacking : BasicDepthPacking	RGBADepthPacking
`.displacementBias : number`	The offset of the displacement map's values on the mesh's vertices. The bias is added to the scaled sample of the displacement map. Without a displacement map set, this value is not applied.
`.displacementMap : Texture`	The displacement map affects the position of the mesh's vertices. Unlike other maps which only affect the light and shade of the material the displaced vertices can cast shadows, block other objects,…
`.displacementScale : number`	How much the displacement map affects the mesh (where black is no displacement, and white is maximum displacement). Without a displacement map set, this value is not applied.
`.isMeshDepthMaterial : boolean (readonly)`	This flag can be used for type testing.
`.map : Texture`	The color map. May optionally include an alpha channel, typically combined with Material#transparent or Material#alphaTest.
`.wireframe : boolean`	Renders the geometry as a wireframe.
`.wireframeLinewidth : number`	Controls the thickness of the wireframe.

MeshDepthMaterial extends: EventDispatcher → Material
Most relevant properties: alphaMap, depthPacking, displacementBias, displacementMap.