Chapter 244: ClearMaskPass

Core Idea

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

Key Concepts

• needsSwap : boolean: Overwritten to disable the swap.

Code Examples

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

• What it demonstrates: Typical usage of ClearMaskPass.

Reference Tables

Constructor

Signature
new ClearMaskPass()

Properties

Property	Description
.needsSwap : boolean	Overwritten to disable the swap.

Methods

Method	Description
.render( renderer : WebGLRenderer, writeBuffer : WebGLRenderTarget, readBuffer : WebGLRenderTarget, deltaTime : number, maskActive : boolean )	Performs the clear of the currently defined mask.

Key Takeaways

1. ClearMaskPass extends: Pass
2. Most relevant properties: needsSwap.
3. Key methods: render.

Connects To

• Pass: parent class
• Source: examples/jsm/postprocessing/MaskPass.js