---

title: ClearMaskPass category: Addons layout: docs

ClearMaskPass

This pass can be used to clear a mask previously defined with MaskPass.

Code Example

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

Constructor

new ClearMaskPass()

Constructs a new clear mask pass.

Properties

.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 of the currently defined mask.

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/MaskPass.js