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

DepthEffect

Extends:

three~EventDispatcherEffect → DepthEffect

Indirect Implements:

A depth visualization effect.

Useful for debugging.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new depth effect.

Member Summary

Public Members
public get

Indicates whether depth should be inverted.

public set

Enables or disables depth inversion.

Inherited Summary

From class Effect
public

The blend mode of this effect.

public

Preprocessor macro definitions.

public

WebGL extensions that are required by this effect.

public

The name of this effect.

public

uniforms: Map<String, Uniform>

Shader uniforms.

public

Performs a shallow search for properties that define a dispose method and deletes them.

public

Returns the effect attributes.

public

Returns the fragment shader.

public

Returns the vertex shader.

public

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

Performs initialization tasks.

public

setDepthTexture(depthTexture: Texture, depthPacking: Number)

Sets the depth texture.

public

setSize(width: Number, height: Number)

Updates the size of this effect.

public

update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number)

Updates the effect by performing supporting operations.

protected

Sets the effect attributes.

protected

Informs the associated EffectPass that this effect has changed in a way that requires a shader recompilation.

protected

setFragmentShader(fragmentShader: String)

Sets the fragment shader.

protected

setVertexShader(vertexShader: String)

Sets the vertex shader.

Public Constructors

public constructor(options: Object) source

Constructs a new depth effect.

Override:

Effect#constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

The options.

options.blendFunction BlendFunction
  • optional
  • default: BlendFunction.NORMAL

The blend function of this effect.

options.inverted Boolean
  • optional
  • default: false

Whether the depth values should be inverted.

Public Members

public get inverted: Boolean source

Indicates whether depth should be inverted.

public set inverted: Boolean source

Enables or disables depth inversion.