Home Reference Source
import {DepthPass} from 'postprocessing'
public class | source

DepthPass

Extends:

Pass → DepthPass

Indirect Implements:

A pass that renders depth and packs it 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
public

renderTarget: WebGLRenderTarget

A render target that contains the scene depth.

public

The desired render resolution.

public
public get

texture: Texture

The depth texture.

Method Summary

Public Methods
public
this method was deprecated. Adjust the fixed resolution width or height instead.

Returns the current resolution scale.

public

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

Renders the scene depth.

public
this method was deprecated. Adjust the fixed resolution width or height instead.

Sets the resolution scale.

public

setSize(width: Number, height: Number)

Updates the size of this pass.

Inherited Summary

From class Pass
public get

Indicates whether this pass should render to screen.

public set

Sets the render to screen flag.

public
this member was deprecated. Use isEnabled() and setEnabled() instead.

Indicates whether this pass is enabled.

public

The name of this pass.

public

Only relevant for subclassing.

public

Only relevant for subclassing.

protected

camera: Camera

The camera.

protected

scene: Scene

The scene to render.

public

Performs a shallow search for disposable properties and deletes them.

public

getDepthTexture(): Texture

Returns the current depth texture.

public

getFullscreenMaterial(): Material

Returns the current fullscreen material.

public

initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Performs initialization tasks.

public

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: Number)

Sets the depth texture.

public

setEnabled(enabled: Boolean)

Enables or disables this pass.

public

setSize(width: Number, height: Number)

Updates this pass with the renderer's size.

You may override this method in case you want to be informed about the size of the main frame buffer.

The EffectComposer calls this method before this pass is initialized and every time its own size is updated.

protected

setFullscreenMaterial(material: Material)

Sets the fullscreen material.

Public Constructors

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

Constructs a new depth pass.

Override:

Pass#constructor

Params:

NameTypeAttributeDescription
scene Scene

The scene to render.

camera Camera

The camera to use to render the scene.

options Object
  • optional

The options.

options.resolutionScale Number
  • optional
  • default: 1.0

Deprecated. Adjust the height or width instead for consistent results.

options.width Number
  • optional
  • default: Resizer.AUTO_SIZE

The render width.

options.height Number
  • optional
  • default: Resizer.AUTO_SIZE

The render height.

options.renderTarget WebGLRenderTarget
  • optional

A custom render target.

Public Members

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 resolution: Resizer source

The desired render resolution.

Use Resizer.AUTO_SIZE for the width or height to automatically calculate it based on its counterpart and the original aspect ratio.

public resolutionScale: * source

public get texture: Texture source

The depth texture.

Public Methods

public getResolutionScale(): Number source

this method was deprecated. Adjust the fixed resolution width or height instead.

Returns the current resolution scale.

Return:

Number

The resolution scale.

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

Renders the scene depth.

Override:

Pass#render

Params:

NameTypeAttributeDescription
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. Adjust the fixed resolution width or height instead.

Sets the resolution scale.

Params:

NameTypeAttributeDescription
scale Number

The new resolution scale.

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

Updates the size of this pass.

Override:

Pass#setSize

Params:

NameTypeAttributeDescription
width Number

The width.

height Number

The height.