Chapter 411: FilmNode

Core Idea

Post processing node for creating a film grain effect.

Key Concepts

• inputNode : Node: The node that represents the input of the effect.
• intensityNode : Node.<float>: A node that represents the effect's intensity.
• uvNode : Node.<vec2>: A node that allows to pass custom (e.g. animated) uv data.

Code Examples

import { film } from 'three/addons/tsl/display/FilmNode.js';

• What it demonstrates: Typical usage of FilmNode.

Reference Tables

Constructor

Signature
new FilmNode( inputNode : Node, intensityNode : Node.<float>, uvNode : Node.<vec2> )

Properties

Property	Description
.inputNode : Node	The node that represents the input of the effect.
.intensityNode : Node.<float>	A node that represents the effect's intensity.
.uvNode : Node.<vec2>	A node that allows to pass custom (e.g. animated) uv data.

Methods

Method	Description
.setup( builder : NodeBuilder ) : ShaderCallNodeInternal	This method is used to setup the effect's TSL code.

Key Takeaways

1. FilmNode extends: EventDispatcher → Node → TempNode
2. Most relevant properties: inputNode, intensityNode, uvNode.
3. Key methods: setup.

Connects To

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