Import
FilmPass is an addon, and must be imported explicitly, see Installation#Addons.
import { FilmPass } from 'three/addons/postprocessing/FilmPass.js';Constructor
new FilmPass( intensity : number, grayscale : boolean )
Constructs a new film pass.
| intensity |
The grain intensity in the range Default is |
| grayscale |
Whether to apply a grayscale effect or not. Default is |
Properties
.material : ShaderMaterial
The pass material.
.uniforms : Object
The pass uniforms. Use this object if you want to update the
intensity or grayscale values at runtime.
pass.uniforms.intensity.value = 1;
pass.uniforms.grayscale.value = true;
Methods
.dispose()
Frees the GPU-related resources allocated by this instance. Call this method whenever the pass is no longer used in your app.
- Overrides: Pass#dispose
.render( renderer : WebGLRenderer, writeBuffer : WebGLRenderTarget, readBuffer : WebGLRenderTarget, deltaTime : number, maskActive : boolean )
Performs the film pass.
| renderer |
The renderer. |
| writeBuffer |
The write buffer. This buffer is intended as the rendering destination for the pass. |
| readBuffer |
The read buffer. The pass can access the result from the previous pass from this buffer. |
| deltaTime |
The delta time in seconds. |
| maskActive |
Whether masking is active or not. |
- Overrides: Pass#render