Home Reference Source
import {ClearPass} from 'postprocessing/src/passes/ClearPass.js'
public class | source

ClearPass

Extends:

Pass → ClearPass

Indirect Implements:

A pass that clears the input buffer or the screen.

You can prevent specific bits from being cleared by setting either the autoClearColor, autoClearStencil or autoClearDepth properties of the renderer to false.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new clear pass.

Member Summary

Public Members
public

The clear alpha.

public

clearColor: Color

The clear color.

public

Method Summary

Public Methods
public

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

Clears the input buffer or the screen.

Inherited Summary

From class Pass
public

[key]: *

public

Indicates whether this pass should be executed.

public

The name of this pass.

public

Indicates whether the EffectComposer should prepare a depth texture for this pass.

public

Indicates whether the EffectComposer should swap the frame buffers after this pass has finished rendering.

public

Indicates whether this pass should render to screen.

protected

camera: Camera

The camera.

protected

scene: Scene

The scene to render.

private

quad: Mesh

A quad mesh that fills the screen.

public

Performs a shallow search for disposable properties and deletes them.

public

getDepthTexture(): Texture

Returns the current depth texture.

public

getFullscreenMaterial(): Material

Returns the current fullscreen material.

public

initialize(renderer: WebGLRenderer, alpha: Boolean)

Performs initialization tasks.

public abstract

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

Renders the effect.

public

setDepthTexture(depthTexture: Texture, depthPacking: Number)

Sets the depth texture.

public

setSize(width: Number, height: Number)

Updates this pass with the renderer's size.

You may override this method in case you want to be informed about the main render size.

The EffectComposer calls this method before this pass is initialized and every time its own size is updated.

protected

setFullscreenMaterial(material: Material)

Sets the fullscreen material.

Public Constructors

public constructor(options: Object) source

Constructs a new clear pass.

Override:

Pass#constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

Additional options.

options.clearColor Color
  • optional
  • default: null

An override clear color.

options.clearAlpha Number
  • optional
  • default: 0.0

An override clear alpha.

Public Members

public clearAlpha: Number source

The clear alpha.

public clearColor: Color source

The clear color.

public needsSwap: boolean source

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 Methods

public render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, delta: 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.

delta Number
  • optional

The time between the last frame and the current one in seconds.

stencilTest Boolean
  • optional

Indicates whether a stencil mask is active.