import {DepthMaskMaterial} from 'postprocessing'

public class | source

DepthMaskMaterial

Extends:

three~ShaderMaterial → DepthMaskMaterial

A depth mask shader material.

This material masks a color buffer by comparing two depth textures.

Constructor Summary

Public Constructor
public	constructor() Constructs a new depth mask material.

Member Summary

Public Members
public set	depthBuffer0: Texture The primary depth buffer.
public set	depthBuffer1: Texture The secondary depth buffer.
public get	depthMode: DepthModes The depth mode.
public set	depthMode
public set	depthPacking0: DepthPackingStrategies The primary depth packing strategy.
public set	depthPacking1: DepthPackingStrategies The secondary depth packing strategy.
public get	epsilon: Number A small error threshold that is used for `EqualDepth` and `NotEqualDepth` tests.
public set	epsilon
public get	keepFar: Boolean this get was deprecated. Use maxDepthStrategy instead. Indicates whether maximum depth values should be preserved.
public set	keepFar
public get	maxDepthStrategy: DepthTestStrategy The strategy for handling maximum depth.
public set	maxDepthStrategy
public	needsUpdate: boolean

Method Summary

Public Methods
public	adoptCameraSettings(camera: Camera) this method was deprecated. Use copyCameraSettings instead. Copies the settings of the given camera.
public	copyCameraSettings(camera: Camera) Copies the settings of the given camera.
public	getDepthMode(): DepthModes this method was deprecated. Use depthMode instead. Returns the current depth mode.
public	getEpsilon(): Number this method was deprecated. Use epsilon instead. Returns the current error threshold for depth comparisons.
public	getMaxDepthStrategy(): DepthTestStrategy this method was deprecated. Use maxDepthStrategy instead. Returns the strategy for dealing with maximum depth values.
public	setDepthBuffer0(buffer: Texture, depthPacking: DepthPackingStrategies) this method was deprecated. Use depthBuffer0 and depthPacking0 instead. Sets the base depth buffer.
public	setDepthBuffer1(buffer: Texture, depthPacking: DepthPackingStrategies) this method was deprecated. Use depthBuffer1 and depthPacking1 instead. Sets the depth buffer that will be compared with the base depth buffer.
public	setDepthMode(mode: DepthModes) this method was deprecated. Use depthMode instead. Sets the depth mode.
public	setEpsilon(value: Number) this method was deprecated. Use epsilon instead. Sets the depth comparison error threshold.
public	setMaxDepthStrategy(value: DepthTestStrategy) this method was deprecated. Use maxDepthStrategy instead. Sets the strategy for dealing with maximum depth values.

Public Constructors

public constructor() source

Constructs a new depth mask material.

Public Members

public set depthBuffer0: Texture source

The primary depth buffer.

public set depthBuffer1: Texture source

The secondary depth buffer.

public get depthMode: DepthModes source

The depth mode.

See:

https://threejs.org/docs/#api/en/constants/Materials

public set depthMode source

public set depthPacking0: DepthPackingStrategies source

The primary depth packing strategy.

public set depthPacking1: DepthPackingStrategies source

The secondary depth packing strategy.

public get epsilon: Number source

A small error threshold that is used for EqualDepth and NotEqualDepth tests. Default is 1e-4.

public set epsilon source

public get keepFar: Boolean source

this get was deprecated. Use maxDepthStrategy instead.

Indicates whether maximum depth values should be preserved.

public set keepFar source

public get maxDepthStrategy: DepthTestStrategy source

The strategy for handling maximum depth.

public set maxDepthStrategy source

public needsUpdate: boolean source

Public Methods

public adoptCameraSettings(camera: Camera) source

this method was deprecated. Use copyCameraSettings instead.

Copies the settings of the given camera.

Params:

Name	Type	Attribute	Description
camera	Camera		A camera.

public copyCameraSettings(camera: Camera) source

Copies the settings of the given camera.

Params:

Name	Type	Attribute	Description
camera	Camera		A camera.

public getDepthMode(): DepthModes source

this method was deprecated. Use depthMode instead.

Returns the current depth mode.

Return:

DepthModes

The depth mode. Default is LessDepth.

public getEpsilon(): Number source

this method was deprecated. Use epsilon instead.

Returns the current error threshold for depth comparisons.

Return:

Number

The error threshold.

public getMaxDepthStrategy(): DepthTestStrategy source

this method was deprecated. Use maxDepthStrategy instead.

Returns the strategy for dealing with maximum depth values.

Return:

DepthTestStrategy

The strategy.

public setDepthBuffer0(buffer: Texture, depthPacking: DepthPackingStrategies) source

this method was deprecated. Use depthBuffer0 and depthPacking0 instead.

Sets the base depth buffer.

Params:

Name	Type	Attribute	Description
buffer	Texture		The depth texture.
depthPacking	DepthPackingStrategies	optional default: BasicDepthPacking	The depth packing strategy.

public setDepthBuffer1(buffer: Texture, depthPacking: DepthPackingStrategies) source

this method was deprecated. Use depthBuffer1 and depthPacking1 instead.

Sets the depth buffer that will be compared with the base depth buffer.

Params:

Name	Type	Attribute	Description
buffer	Texture		The depth texture.
depthPacking	DepthPackingStrategies	optional default: BasicDepthPacking	The depth packing strategy.

public setDepthMode(mode: DepthModes) source

this method was deprecated. Use depthMode instead.

Sets the depth mode.

Params:

Name	Type	Attribute	Description
mode	DepthModes		The depth mode.

public setEpsilon(value: Number) source

this method was deprecated. Use epsilon instead.

Sets the depth comparison error threshold.

Params:

Name	Type	Attribute	Description
value	Number		The new error threshold.

public setMaxDepthStrategy(value: DepthTestStrategy) source

this method was deprecated. Use maxDepthStrategy instead.

Sets the strategy for dealing with maximum depth values.

Params:

Name	Type	Attribute	Description
value	DepthTestStrategy		The strategy.