Import
BloomPass is an addon, and must be imported explicitly, see Installation#Addons.
import { BloomPass } from 'three/addons/postprocessing/BloomPass.js';Constructor
new BloomPass( strength : number, kernelSize : number, sigma : number )
Constructs a new Bloom pass.
| strength |
The Bloom strength. Default is |
| kernelSize |
The kernel size. Default is |
| sigma |
The sigma. Default is |
Properties
.combineUniforms : Object
The combine pass uniforms.
.convolutionUniforms : Object
The convolution pass uniforms.
.materialCombine : ShaderMaterial
The combine pass material.
.materialConvolution : ShaderMaterial
The convolution pass material.
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 Bloom 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
.setSize( width : number, height : number )
Sets the size of the pass.
| width |
The width to set. |
| height |
The height to set. |
- Overrides: Pass#setSize