Chapter 452: PixelationPassNode

Core Idea

A special render pass node that renders the scene with a pixelation effect.

Key Concepts

• depthEdgeStrength : number: The depth edge strength.
• isPixelationPassNode : boolean (readonly): This flag can be used for type testing.
• normalEdgeStrength : number: The normal edge strength.
• pixelSize : number: The pixel size.

Code Examples

import { pixelationPass } from 'three/addons/tsl/display/PixelationPassNode.js';

• What it demonstrates: Typical usage of PixelationPassNode.

Reference Tables

Constructor

Signature
`new PixelationPassNode( scene : Scene, camera : Camera, pixelSize : Node.<float>

Properties

Property	Description
.depthEdgeStrength : number	The depth edge strength.
.isPixelationPassNode : boolean (readonly)	This flag can be used for type testing.
.normalEdgeStrength : number	The normal edge strength.
.pixelSize : number	The pixel size.

Methods

Method	Description
.setSize( width : number, height : number )	Sets the size of the pass.
.setup( builder : NodeBuilder ) : PixelationNode	This method is used to setup the effect's TSL code.

Key Takeaways

1. PixelationPassNode extends: EventDispatcher → Node → TempNode → PassNode
2. Most relevant properties: depthEdgeStrength, isPixelationPassNode, normalEdgeStrength, pixelSize.
3. Key methods: setSize, setup.

Connects To

• EventDispatcher: parent class
• Node: parent class
• TempNode: parent class
• PassNode: parent class
• Source: examples/jsm/tsl/display/PixelationPassNode.js