import {EffectPass} from 'postprocessing'

public class | source

EffectPass

Extends:

Pass → EffectPass

Implements:

EventListener

Indirect Implements:

An effect pass.

Use this pass to combine Effect instances.

Constructor Summary

Public Constructor
public	constructor(camera: Camera, effects: ...Effect) Constructs a new effect pass.

Member Summary

Public Members
public get	dithering: Boolean Indicates whether dithering is enabled.
public set	dithering
public get	encodeOutput: Boolean this get was deprecated. Use fullscreenMaterial.encodeOutput instead. Indicates whether this pass encodes its output when rendering to screen.
public set	encodeOutput
public	fullscreenMaterial: *
public set	mainCamera
public set	mainScene
public	maxTime: Number this member was deprecated. The maximum time.
public	minTime: Number this member was deprecated. A time offset.
public	needsDepthTexture: *
public	needsSwap: *
public	renderer: *
public	timeScale: Number The animation time scale.

Method Summary

Public Methods
public	dispose() Deletes disposable objects.
public	getDepthTexture(): Texture Returns the current depth texture.
public	handleEvent(event: Event) Handles events.
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	recompile() Rebuilds the shader material.
public	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders the effect.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) Sets the depth texture.
public	setSize(width: Number, height: Number) Updates the size of this pass.

Protected Methods
protected	setEffects(effects: Effect[]) Sets the effects.
protected	updateMaterial() Updates the compound shader material.

Inherited Summary

From class Pass
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(camera: Camera, effects: ...Effect) source

Constructs a new effect pass.

Override:

Pass#constructor

Params:

Name	Type	Attribute	Description
camera	Camera		The main camera.
effects	...Effect		The effects that will be rendered by this pass.

Public Members

public get dithering: Boolean source

Indicates whether dithering is enabled.

public set dithering source

public get encodeOutput: Boolean source

this get was deprecated. Use fullscreenMaterial.encodeOutput instead.

Indicates whether this pass encodes its output when rendering to screen.

public set encodeOutput source

public fullscreenMaterial: * source

The fullscreen material.

Override:

Pass#fullscreenMaterial

public set mainCamera source

Sets the main camera.

Override:

Pass#mainCamera

public set mainScene source

Sets the main scene.

Override:

Pass#mainScene

public maxTime: Number source

this member was deprecated.

The maximum time.

If the elapsed time exceeds this value, it will be reset.

public minTime: Number source

this member was deprecated.

A time offset.

Elapsed time will start at this value.

public needsDepthTexture: * source

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.

Override:

Pass#needsDepthTexture

public needsSwap: * 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 renderer: * source

The renderer.

Override:

Pass#renderer

public timeScale: Number source

The animation time scale.

Public Methods

public dispose() source

Deletes disposable objects.

Override:

Pass#dispose

public getDepthTexture(): Texture source

Returns the current depth texture.

Override:

Pass#getDepthTexture

Return:

Texture

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

public handleEvent(event: Event) source

Handles events.

Params:

Name	Type	Attribute	Description
event	Event		An event.

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

Performs initialization tasks.

Override:

Pass#initialize

Params:

Name	Type	Attribute	Description
renderer	WebGLRenderer		The renderer.
alpha	Boolean		Whether the renderer uses the alpha channel or not.
frameBufferType	Number		The type of the main frame buffers.

public recompile() source

Rebuilds the shader material.

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

Renders the effect.

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 setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) source

Sets the depth texture.

Override:

Pass#setDepthTexture

Params:

Name	Type	Attribute	Description
depthTexture	Texture		A depth texture.
depthPacking	DepthPackingStrategies	optional default: BasicDepthPacking	The depth packing.

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.

Protected Methods

protected setEffects(effects: Effect[]) source

Sets the effects.

Params:

Name	Type	Attribute	Description
effects	Effect[]		The effects.

protected updateMaterial() source

Updates the compound shader material.