Chapter 269: SavePass

Core Idea

A pass that saves the contents of the current read buffer in a render target.

Key Concepts

• material : ShaderMaterial: The pass material.
• needsSwap : boolean: Overwritten to disable the swap.
• renderTarget : WebGLRenderTarget: The render target which is used to save the read buffer.
• uniforms : Object: The pass uniforms.

Code Examples

const savePass = new SavePass( customRenderTarget );
composer.addPass( savePass );

• What it demonstrates: Typical usage of SavePass.

Reference Tables

Constructor

Signature
new SavePass( renderTarget : WebGLRenderTarget )

Properties

Property	Description
.material : ShaderMaterial	The pass material.
.needsSwap : boolean	Overwritten to disable the swap.
.renderTarget : WebGLRenderTarget	The render target which is used to save the read buffer.
.uniforms : Object	The pass uniforms.

Methods

Method	Description
.dispose()	Frees the GPU-related resources allocated by this instance. Call this method whenever the pass is no longer used in your app.
.render( renderer : WebGLRenderer, writeBuffer : WebGLRenderTarget, readBuffer : WebGLRenderTarget, deltaTime : number, maskActive : boolean )	Performs the save pass.
.setSize( width : number, height : number )	Sets the size of the pass.

Key Takeaways

1. SavePass extends: Pass
2. Most relevant properties: material, needsSwap, renderTarget, uniforms.
3. Key methods: dispose, render, setSize.

Connects To

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