import {DepthPass} from 'postprocessing'

public class | source

DepthPass

Extends:

Pass → DepthPass

Indirect Implements:

A pass that renders depth into an RGBA buffer.

Constructor Summary

Public Constructor
public	constructor(scene: Scene, camera: Camera, options: Object) Constructs a new depth pass.

Member Summary

Public Members
public set	mainCamera
public set	mainScene
public	needsSwap: boolean
public	renderTarget: WebGLRenderTarget A render target that contains the scene depth.
public get	texture: Texture The depth texture.

Method Summary

Public Methods
public	getResolution(): Resolution this method was deprecated. Use resolution instead. Returns the resolution settings.
public	getResolutionScale(): Number this method was deprecated. Use resolution instead. Returns the current resolution scale.
public	getTexture(): Texture this method was deprecated. Use texture instead. Returns the depth texture.
public	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders the scene depth.
public	setResolutionScale(scale: Number) this method was deprecated. Use resolution instead. Sets the resolution scale.
public	setSize(width: Number, height: Number) Updates the size of this pass.

Inherited Summary

From class Pass
public static get	fullscreenGeometry: BufferGeometry A shared fullscreen triangle.
public get	fullscreenMaterial: Material The fullscreen material.
public set	fullscreenMaterial
public set	mainCamera: Camera Sets the main camera.
public set	mainScene: Scene Sets the main scene.
public get	renderToScreen: Boolean Sets the render to screen flag.
public set	renderToScreen
public	enabled: Boolean Indicates whether this pass is enabled.
public	name: String The name of this pass.
public	needsDepthTexture: Boolean Only relevant for subclassing.
public	needsSwap: Boolean Only relevant for subclassing.
protected	camera: Camera The camera.
protected	renderer: WebGLRenderer this member was deprecated. The renderer.
protected	scene: Scene The scene to render.
public	dispose() Performs a shallow search for disposable properties and deletes them.
public	getDepthTexture(): Texture Returns the current depth texture.
public	getFullscreenMaterial(): Material this method was deprecated. Use fullscreenMaterial instead. Returns the current fullscreen material.
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	isEnabled(): Boolean this method was deprecated. Use enabled instead. Indicates whether this pass is enabled.
public abstract	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders this pass.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategy) Sets the depth texture.
public	setEnabled(value: Boolean) this method was deprecated. Use enabled instead. Enables or disables this pass.
public	setRenderer(renderer: WebGLRenderer) this method was deprecated. Sets the renderer
public	setSize(width: Number, height: Number) Sets the size.
protected	setFullscreenMaterial(value: Material) this method was deprecated. Use fullscreenMaterial instead. Sets the fullscreen material.

Public Constructors

public constructor(scene: Scene, camera: Camera, options: Object) source

Constructs a new depth pass.

Override:

Pass#constructor

Params:

Name	Type	Attribute	Description
scene	Scene		The scene to render.
camera	Camera		The camera to use to render the scene.
options	Object	optional	The options.
options.renderTarget	WebGLRenderTarget	optional	A custom render target.
options.resolutionScale	Number	optional default: 1.0	The resolution scale.
options.resolutionX	Number	optional default: Resolution.AUTO_SIZE	The horizontal resolution.
options.resolutionY	Number	optional default: Resolution.AUTO_SIZE	The vertical resolution.
options.width	Number	optional default: Resolution.AUTO_SIZE	Deprecated. Use resolutionX instead.
options.height	Number	optional default: Resolution.AUTO_SIZE	Deprecated. Use resolutionY instead.

Public Members

public set mainCamera source

Sets the main camera.

Override:

Pass#mainCamera

public set mainScene source

Sets the main scene.

Override:

Pass#mainScene

public needsSwap: boolean source

Only relevant for subclassing.

Indicates whether the EffectComposer should swap the frame buffers after this pass has finished rendering. Set this to false if this pass doesn't render to the output buffer or the screen. Otherwise, the contents of the input buffer will be lost.

Override:

Pass#needsSwap

public renderTarget: WebGLRenderTarget source

A render target that contains the scene depth.

public get texture: Texture source

The depth texture.

Public Methods

public getResolution(): Resolution source

this method was deprecated. Use resolution instead.

Returns the resolution settings.

Return:

Resolution

The resolution.

public getResolutionScale(): Number source

this method was deprecated. Use resolution instead.

Returns the current resolution scale.

Return:

Number

The resolution scale.

public getTexture(): Texture source

this method was deprecated. Use texture instead.

Returns the depth texture.

Return:

Texture

The texture.

public render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) source

Renders the scene depth.

Override:

Pass#render

Params:

Name	Type	Attribute	Description
renderer	WebGLRenderer		The renderer.
inputBuffer	WebGLRenderTarget		A frame buffer that contains the result of the previous pass.
outputBuffer	WebGLRenderTarget		A frame buffer that serves as the output render target unless this pass renders to screen.
deltaTime	Number	optional	The time between the last frame and the current one in seconds.
stencilTest	Boolean	optional	Indicates whether a stencil mask is active.

public setResolutionScale(scale: Number) source

this method was deprecated. Use resolution instead.

Sets the resolution scale.

Params:

Name	Type	Attribute	Description
scale	Number		The new resolution scale.

public setSize(width: Number, height: Number) source

Updates the size of this pass.

Override:

Pass#setSize

Params:

Name	Type	Attribute	Description
width	Number		The width.
height	Number		The height.