import {DepthCopyMaterial} from 'postprocessing'

public class | source

DepthCopyMaterial

Extends:

three~ShaderMaterial → DepthCopyMaterial

A depth copy shader material.

Constructor Summary

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

Member Summary

Public Members
public get	depthBuffer: Texture The input depth buffer.
public set	depthBuffer
public set	inputDepthPacking: DepthPackingStrategies The input depth packing strategy.
public get	mode: DepthCopyMode The depth copy mode.
public set	mode
public	needsUpdate: boolean
public get	outputDepthPacking: DepthPackingStrategies The output depth packing strategy.
public set	outputDepthPacking
public get	texelPosition: Vector2 The screen space position used for single-texel copy operations.

Method Summary

Public Methods
public	getInputDepthPacking(): DepthPackingStrategies this method was deprecated. Returns the current input depth packing strategy.
public	getMode(): DepthCopyMode this method was deprecated. Use mode instead. Returns the depth copy mode.
public	getOutputDepthPacking(): DepthPackingStrategies this method was deprecated. Use outputDepthPacking instead. Returns the current output depth packing strategy.
public	getTexelPosition(): Vector2 this method was deprecated. Use texelPosition instead. Returns the screen space position used for single-texel copy operations.
public	setDepthBuffer(buffer: Texture, depthPacking: DepthPackingStrategies) this method was deprecated. Use depthBuffer and inputDepthPacking instead. Sets the input depth buffer.
public	setInputDepthPacking(value: DepthPackingStrategies) this method was deprecated. Use inputDepthPacking instead. Sets the input depth packing strategy.
public	setMode(value: DepthCopyMode) this method was deprecated. Use mode instead. Sets the depth copy mode.
public	setOutputDepthPacking(value: DepthPackingStrategies) this method was deprecated. Use outputDepthPacking instead. Sets the output depth packing strategy.
public	setTexelPosition(value: Vector2) this method was deprecated. Sets the screen space position used for single-texel copy operations.

Public Constructors

public constructor() source

Constructs a new depth copy material.

Public Members

public get depthBuffer: Texture source

The input depth buffer.

public set depthBuffer source

public set inputDepthPacking: DepthPackingStrategies source

The input depth packing strategy.

public get mode: DepthCopyMode source

The depth copy mode.

public set mode source

public needsUpdate: boolean source

public get outputDepthPacking: DepthPackingStrategies source

The output depth packing strategy.

public set outputDepthPacking source

public get texelPosition: Vector2 source

The screen space position used for single-texel copy operations.

Public Methods

public getInputDepthPacking(): DepthPackingStrategies source

this method was deprecated.

Returns the current input depth packing strategy.

Return:

DepthPackingStrategies

The input depth packing strategy.

public getMode(): DepthCopyMode source

this method was deprecated. Use mode instead.

Returns the depth copy mode.

Return:

DepthCopyMode

The depth copy mode.

public getOutputDepthPacking(): DepthPackingStrategies source

this method was deprecated. Use outputDepthPacking instead.

Returns the current output depth packing strategy.

Return:

DepthPackingStrategies

The output depth packing strategy.

public getTexelPosition(): Vector2 source

this method was deprecated. Use texelPosition instead.

Returns the screen space position used for single-texel copy operations.

Return:

Vector2

The position.

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

this method was deprecated. Use depthBuffer and inputDepthPacking instead.

Sets the input depth buffer.

Params:

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

public setInputDepthPacking(value: DepthPackingStrategies) source

this method was deprecated. Use inputDepthPacking instead.

Sets the input depth packing strategy.

Params:

Name	Type	Attribute	Description
value	DepthPackingStrategies		The new input depth packing strategy.

public setMode(value: DepthCopyMode) source

this method was deprecated. Use mode instead.

Sets the depth copy mode.

Params:

Name	Type	Attribute	Description
value	DepthCopyMode		The new mode.

public setOutputDepthPacking(value: DepthPackingStrategies) source

this method was deprecated. Use outputDepthPacking instead.

Sets the output depth packing strategy.

Params:

Name	Type	Attribute	Description
value	DepthPackingStrategies		The new output depth packing strategy.

public setTexelPosition(value: Vector2) source

this method was deprecated.

Sets the screen space position used for single-texel copy operations.

Params:

Name	Type	Attribute	Description
value	Vector2		The position.