---

title: ClearPass category: Addons layout: docs

ClearPass

This class can be used to force a clear operation for the current read or default framebuffer (when rendering to screen).

Code Example

const clearPass = new ClearPass();
composer.addPass( clearPass );

Import

ClearPass is an addon, and must be imported explicitly, see Installation#Addons.

import { ClearPass } from 'three/addons/postprocessing/ClearPass.js';

Constructor

new ClearPass( clearColor : number | Color | string, clearAlpha : number )

Constructs a new clear pass.

clearColor | The clear color. Default is 0x000000.
---|---
clearAlpha | The clear alpha. Default is 0.

Properties

.clearAlpha : number

The clear alpha.

Default is 0.

.clearColor : number | Color | string

The clear color.

Default is 0x000000.

.needsSwap : boolean

Overwritten to disable the swap.

Default is false.

Overrides: Pass#needsSwap

Methods

.render( renderer : WebGLRenderer, writeBuffer : WebGLRenderTarget, readBuffer : WebGLRenderTarget, deltaTime : number, maskActive : boolean )

Performs the clear operation. This affects the current read or the default framebuffer.

renderer | The renderer.
---|---
writeBuffer | The write buffer. This buffer is intended as the rendering destination for the pass.
readBuffer | The read buffer. The pass can access the result from the previous pass from this buffer.
deltaTime | The delta time in seconds.
maskActive | Whether masking is active or not.

Overrides: Pass#render

Source

examples/jsm/postprocessing/ClearPass.js