Class DepthPass

A pass that renders depth into an RGBA buffer.

Hierarchy (view full)

Pass
- DepthPass

Constructors

constructor

new DepthPass(scene?, camera?, options?): DepthPass
Constructs a new depth pass.
Parameters
- Optional scene: Scene
  The scene to render.
- Optional camera: Camera
  The camera to use to render the scene.
- Optional options: {
      height?: number;
      renderTarget?: WebGLRenderTarget<Texture>;
      resolutionScale?: number;
      resolutionX?: number;
      resolutionY?: number;
      width?: number;
  }
  The options.
  - Optional height?: number
    Deprecated. Use resolutionY instead.
  - Optional renderTarget?: WebGLRenderTarget<Texture>
    A custom render target.
  - Optional resolutionScale?: number
    The resolution scale.
  - Optional resolutionX?: number
    The horizontal resolution.
  - Optional resolutionY?: number
    The vertical resolution.
  - Optional width?: number
    Deprecated. Use resolutionX instead.
Returns DepthPass
Overrides Pass.constructor

Properties

`Protected` camera

camera: Camera

The camera.

enabled

enabled: boolean

Indicates whether this pass is enabled.

name

name: string

The name of this pass.

needsDepthTexture

needsDepthTexture: boolean

Only relevant for subclassing.

Indicates whether the EffectComposer should prepare a depth texture for this pass. Set this to true if this pass relies on depth information from a preceding RenderPass.

needsSwap

needsSwap: boolean

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.

`Protected` renderer

renderer: WebGLRenderer

The renderer.

Deprecated

resolution

resolution: Resolution

`Protected` scene

scene: Scene

The scene to render.

Accessors

fullscreenMaterial

get fullscreenMaterial(): Material
The fullscreen material.

Returns Material
Inherited from Pass.fullscreenMaterial
set fullscreenMaterial(arg): void
Parameters
- arg: Material
Returns void
Inherited from Pass.fullscreenMaterial

mainCamera

set mainCamera(arg): void
Sets the main camera.
Parameters
- arg: Camera
Returns void
Inherited from Pass.mainCamera

mainScene

set mainScene(arg): void
Sets the main scene.
Parameters
- arg: Scene
Returns void
Inherited from Pass.mainScene

renderToScreen

get renderToScreen(): boolean
Indicates whether this pass should render to screen.

Returns boolean
Inherited from Pass.renderToScreen
set renderToScreen(arg): void
Sets the render to screen flag.

If this flag is changed, the fullscreen material will be updated as well.
Parameters
- arg: boolean
Returns void
Inherited from Pass.renderToScreen

texture

get texture(): Texture
The depth texture.

Returns Texture

Methods

dispose

dispose(): void
Performs a shallow search for disposable properties and deletes them.

The EffectComposer calls this method when it is being destroyed. You can use it independently to free memory when you're certain that you don't need this pass anymore.

Returns void
Inherited from Pass.dispose

getDepthTexture

getDepthTexture(): Texture
Returns the current depth texture.

Returns Texture
The current depth texture, or null if there is none.

Inherited from Pass.getDepthTexture

getFullscreenMaterial

getFullscreenMaterial(): Material
Returns the current fullscreen material.

Returns Material
The current fullscreen material, or null if there is none.

Deprecated
Use fullscreenMaterial instead.

Inherited from Pass.getFullscreenMaterial

getResolution

getResolution(): Resolution
Returns the resolution settings.

Returns Resolution
The resolution.

Deprecated
Use resolution instead.

getResolutionScale

getResolutionScale(): number
Returns the current resolution scale.

Returns number
The resolution scale.

Deprecated
Use resolution instead.

getTexture

getTexture(): Texture
Returns the depth texture.

Returns Texture
The texture.

Deprecated
Use texture instead.

initialize

initialize(renderer, alpha, frameBufferType): void
Performs initialization tasks.

This method is called when this pass is added to an EffectComposer.
Parameters
- renderer: WebGLRenderer
  The renderer.
- alpha: boolean
  Whether the renderer uses the alpha channel or not.
- frameBufferType: number
  The type of the main frame buffers.
Returns void
Inherited from Pass.initialize

isEnabled

isEnabled(): boolean
Indicates whether this pass is enabled.

Returns boolean
Whether this pass is enabled.

Deprecated
Use enabled instead.

Inherited from Pass.isEnabled

render

render(renderer, inputBuffer, outputBuffer, deltaTime?, stencilTest?): void
Renders the scene depth.
Parameters
- renderer: WebGLRenderer
  The renderer.
- inputBuffer: WebGLRenderTarget<Texture>
  A frame buffer that contains the result of the previous pass.
- outputBuffer: WebGLRenderTarget<Texture>
  A frame buffer that serves as the output render target unless this pass renders to screen.
- Optional deltaTime: number
  The time between the last frame and the current one in seconds.
- Optional stencilTest: boolean
  Indicates whether a stencil mask is active.
Returns void
Overrides Pass.render

setDepthTexture

setDepthTexture(depthTexture, depthPacking?): void
Sets the depth texture.

This method will be called automatically by the EffectComposer. You may override this method if your pass relies on the depth information of a preceding RenderPass.
Parameters
- depthTexture: Texture
  A depth texture.
- Optional depthPacking: DepthPackingStrategies
  The depth packing.
Returns void
Inherited from Pass.setDepthTexture

setEnabled

setEnabled(value): void
Enables or disables this pass.
Parameters
- value: boolean
  Whether the pass should be enabled.
Returns void
Deprecated
Use enabled instead.

Inherited from Pass.setEnabled

`Protected` setFullscreenMaterial

setFullscreenMaterial(value): void
Protected
Sets the fullscreen material.
Parameters
- value: Material
  A fullscreen material.
Returns void
Deprecated
Use fullscreenMaterial instead.

Inherited from Pass.setFullscreenMaterial

setRenderer

setRenderer(renderer): void
Sets the renderer
Parameters
- renderer: WebGLRenderer
  The renderer.
Returns void
Deprecated
Inherited from Pass.setRenderer

setResolutionScale

setResolutionScale(scale): void
Sets the resolution scale.
Parameters
- scale: number
  The new resolution scale.
Returns void
Deprecated
Use resolution instead.

setSize

setSize(width, height): void
Sets the size.

You may override this method if you want to be informed about the size of the backbuffer/canvas. This method is called before initialize and every time the size of the EffectComposer changes.
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
Inherited from Pass.setSize

Class DepthPass

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional scene: Scene

Optional camera: Camera

Optional options: { height?: number; renderTarget?: WebGLRenderTarget<Texture>; resolutionScale?: number; resolutionX?: number; resolutionY?: number; width?: number; }

Optional height?: number

Optional renderTarget?: WebGLRenderTarget<Texture>

Optional resolutionScale?: number

Optional resolutionX?: number

Optional resolutionY?: number

Optional width?: number

Returns DepthPass

Properties

Protected camera

enabled

name

needsDepthTexture

needsSwap

Protected renderer

Deprecated

resolution

Protected scene

Accessors

fullscreenMaterial

Returns Material

Parameters

arg: Material

Returns void

mainCamera

Parameters

arg: Camera

Returns void

mainScene

Parameters

arg: Scene

Returns void

renderToScreen

Returns boolean

Parameters

arg: boolean

Returns void

texture

Returns Texture

Methods

dispose

Returns void

getDepthTexture

Returns Texture

getFullscreenMaterial

Returns Material

Deprecated

getResolution

Returns Resolution

Deprecated

getResolutionScale

Returns number

Deprecated

getTexture

Returns Texture

Deprecated

initialize

Parameters

renderer: WebGLRenderer

alpha: boolean

frameBufferType: number

Returns void

isEnabled

Returns boolean

Deprecated

render

Parameters

renderer: WebGLRenderer

`Optional` scene: Scene

`Optional` camera: Camera

`Optional` options: {
height?: number;
renderTarget?: WebGLRenderTarget<Texture>;
resolutionScale?: number;
resolutionX?: number;
resolutionY?: number;
width?: number;
}

`Optional` height?: number

`Optional` renderTarget?: WebGLRenderTarget<Texture>

`Optional` resolutionScale?: number

`Optional` resolutionX?: number

`Optional` resolutionY?: number

`Optional` width?: number

`Protected` camera

`Protected` renderer

`Protected` scene

`Optional` deltaTime: number

`Optional` stencilTest: boolean

`Optional` depthPacking: DepthPackingStrategies

`Protected` setFullscreenMaterial