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

ClearPass

Extends:

Pass → ClearPass

Indirect Implements:

A pass that clears the input buffer or the screen.

Constructor Summary

Public Constructor
public

constructor(color: Boolean, depth: Boolean, stencil: Boolean)

Constructs a new clear pass.

Member Summary

Public Members
public
this member was deprecated. Use setClearFlags() instead.

Indicates whether the color buffer should be cleared.

public
this member was deprecated. Use setClearFlags() instead.

Indicates whether the depth buffer should be cleared.

public
public

An override clear alpha.

public

An override clear color.

public
this member was deprecated. Use setClearFlags() instead.

Indicates whether the stencil buffer should be cleared.

Method Summary

Public Methods
public
this method was deprecated. Use overrideClearAlpha instead.

Returns the override clear alpha.

public
this method was deprecated. Use overrideClearColor instead.

Returns the override clear color.

public

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

Clears the input buffer or the screen.

public

setClearFlags(color: Boolean, depth: Boolean, stencil: Boolean)

Sets the clear flags.

public
this method was deprecated. Use overrideClearAlpha instead.

Sets the override clear alpha.

public

setOverrideClearColor(value: Color)

this method was deprecated. Use overrideClearColor instead.

Sets the override clear color.

Inherited Summary

From class Pass
public get

fullscreenMaterial: Material

The fullscreen material.

public set
public set

mainCamera: Camera

Sets the main camera.

public set

mainScene: Scene

Sets the main scene.

public get

Sets the render to screen flag.

public set
public

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

renderer: WebGLRenderer

this member was deprecated.

The renderer.

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

this method was deprecated. Use fullscreenMaterial instead.

Returns the current fullscreen material.

public

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

Performs initialization tasks.

public
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
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(color: Boolean, depth: Boolean, stencil: Boolean) source

Constructs a new clear pass.

Override:

Pass#constructor

Params:

NameTypeAttributeDescription
color Boolean
  • optional
  • default: true

Determines whether the color buffer should be cleared.

depth Boolean
  • optional
  • default: true

Determines whether the depth buffer should be cleared.

stencil Boolean
  • optional
  • default: false

Determines whether the stencil buffer should be cleared.

Public Members

public color: Boolean source

this member was deprecated. Use setClearFlags() instead.

Indicates whether the color buffer should be cleared.

public depth: Boolean source

this member was deprecated. Use setClearFlags() instead.

Indicates whether the depth buffer should be cleared.

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 overrideClearAlpha: Number source

An override clear alpha. Default is -1.

public overrideClearColor: Color source

An override clear color. Default is null.

public stencil: Boolean source

this member was deprecated. Use setClearFlags() instead.

Indicates whether the stencil buffer should be cleared.

Public Methods

public getOverrideClearAlpha(): Number source

this method was deprecated. Use overrideClearAlpha instead.

Returns the override clear alpha. Default is -1.

Return:

Number

The clear alpha.

public getOverrideClearColor(): Color source

this method was deprecated. Use overrideClearColor instead.

Returns the override clear color. Default is null.

Return:

Color

The clear color.

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

Clears the input buffer or the screen.

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 setClearFlags(color: Boolean, depth: Boolean, stencil: Boolean) source

Sets the clear flags.

Params:

NameTypeAttributeDescription
color Boolean

Whether the color buffer should be cleared.

depth Boolean

Whether the depth buffer should be cleared.

stencil Boolean

Whether the stencil buffer should be cleared.

public setOverrideClearAlpha(value: Number) source

this method was deprecated. Use overrideClearAlpha instead.

Sets the override clear alpha.

Params:

NameTypeAttributeDescription
value Number

The clear alpha.

public setOverrideClearColor(value: Color) source

this method was deprecated. Use overrideClearColor instead.

Sets the override clear color.

Params:

NameTypeAttributeDescription
value Color

The clear color.