import {DepthEffect} from 'postprocessing'

public class | source

DepthEffect

Extends:

three~EventDispatcher → Effect → 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	inverted: Boolean Indicates whether depth should be inverted.
public set	inverted

Method Summary

Public Methods
public	isInverted(): Boolean this method was deprecated. Use inverted instead. Indicates whether the rendered depth is inverted.
public	setInverted(value: Boolean) this method was deprecated. Use inverted instead. Enables or disables depth inversion.

Inherited Summary

From class Effect
public get	inputColorSpace: ColorSpace this get is experimental. The input color space.
public set	mainCamera: Camera Sets the main camera.
public set	mainScene: Scene Sets the main scene.
public get	outputColorSpace: ColorSpace this get is experimental. The output color space.
protected set	inputColorSpace: ColorSpace this set is experimental.
protected set	outputColorSpace: ColorSpace this set is experimental.
public	blendMode: BlendMode The blend mode of this effect.
public	defines: Map<String, String> Preprocessor macro definitions.
public	extensions: Set<WebGLExtension> WebGL extensions that are required by this effect.
public	name: String The name of this effect.
public	uniforms: Map<String, Uniform> Shader uniforms.
protected	renderer: WebGLRenderer this member was deprecated. The renderer.
public	dispose() Performs a shallow search for properties that define a dispose method and deletes them.
public	getAttributes(): EffectAttribute Returns the effect attributes.
public	getBlendMode(): BlendMode this method was deprecated. Use blendMode instead. Returns the blend mode.
public	getDefines(): Map<String, String> this method was deprecated. Use defines instead. Returns the preprocessor macro definitions.
public	getExtensions(): Set<WebGLExtension> this method was deprecated. Use extensions instead. Returns the WebGL extensions that are required by this effect.
public	getFragmentShader(): String Returns the fragment shader.
public	getName(): String this method was deprecated. Use name instead. Returns the name of this effect.
public	getUniforms(): Map<String, Uniform> this method was deprecated. Use uniforms instead. Returns the uniforms of this effect.
public	getVertexShader(): String Returns the vertex shader.
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) Sets the depth texture.
public	setRenderer(renderer: WebGLRenderer) this method was deprecated. Sets the renderer.
public	setSize(width: Number, height: Number) Updates the size of this effect.
public	update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number) Updates this effect by performing supporting operations.
protected	setAttributes(attributes: EffectAttribute) Sets the effect attributes.
protected	setChanged() Informs the associated EffectPass that this effect 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:

Name	Type	Attribute	Description
options	Object	optional	The options.
options.blendFunction	BlendFunction	optional default: BlendFunction.SRC	The blend function of this effect.
options.inverted	Boolean	optional default: false	Whether the depth should be inverted.

Public Members

public get inverted: Boolean source

Indicates whether depth should be inverted.

public set inverted source

Public Methods

public isInverted(): Boolean source

this method was deprecated. Use inverted instead.

Indicates whether the rendered depth is inverted.

Return:

Boolean

Whether the rendered depth is inverted.

public setInverted(value: Boolean) source

this method was deprecated. Use inverted instead.

Enables or disables depth inversion.

Params:

Name	Type	Attribute	Description
value	Boolean		Whether depth should be inverted.