Chapter 268: SAOPass

Core Idea

A SAO implementation inspired from @bhouston previous SAO work.

SAOPass provides better quality than SSAOPass but is also more expensive.

Key Concepts

• camera : Camera: The camera.
• clear : boolean: Overwritten to perform a clear operation by default.
• needsSwap : boolean: Overwritten to disable the swap.
• params : Object: The SAO parameter.
• resolution : Vector2: The effect's resolution.
• scene : Scene: The scene to render the AO for.

Code Examples

const saoPass = new SAOPass( scene, camera );
composer.addPass( saoPass );

• What it demonstrates: Typical usage of SAOPass.

Reference Tables

Constructor

Signature
new SAOPass( scene : Scene, camera : Camera, resolution : Vector2 )

Properties

Property	Description
.camera : Camera	The camera.
.clear : boolean	Overwritten to perform a clear operation by default.
.needsSwap : boolean	Overwritten to disable the swap.
.params : Object	The SAO parameter.
.resolution : Vector2	The effect's resolution.
.scene : Scene	The scene to render the AO for.

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

Key Takeaways

1. SAOPass extends: Pass
2. Most relevant properties: camera, clear, needsSwap, params.
3. Key methods: dispose, render, setSize.

Connects To

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