Chapter 241: AfterimagePass

Core Idea

Pass for a basic after image effect.

Key Concepts

• compFsMaterial : ShaderMaterial: The composition material.
• copyFsMaterial : ShaderMaterial: The copy material.
• damp : number: The damping intensity, from 0.0 to 1.0. A higher value means a stronger after image effect.
• uniforms : Object: The pass uniforms. Use this object if you want to update the damp value at runtime.

Code Examples

const afterimagePass = new AfterimagePass( 0.9 );
composer.addPass( afterimagePass );

• What it demonstrates: Typical usage of AfterimagePass.

Reference Tables

Constructor

Signature
new AfterimagePass( damp : number )

Properties

Property	Description
.compFsMaterial : ShaderMaterial	The composition material.
.copyFsMaterial : ShaderMaterial	The copy material.
.damp : number	The damping intensity, from 0.0 to 1.0. A higher value means a stronger after image effect.
.uniforms : Object	The pass uniforms. Use this object if you want to update the damp value at runtime.

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 after image pass.
.setSize( width : number, height : number )	Sets the size of the pass.

Key Takeaways

1. AfterimagePass extends: Pass
2. Most relevant properties: compFsMaterial, copyFsMaterial, damp, uniforms.
3. Key methods: dispose, render, setSize.

Connects To

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