Class BloomEffect
Hierarchy
- PostProcessRenderEffect
- BloomEffect
Index
Constructors
Accessors
Methods
Constructors
constructor
Creates a new instance of @see BloomEffect
Parameters
scene: Scene
The scene the effect belongs to.
_bloomScale: number
The ratio of the blur texture to the input texture that should be used to compute the bloom.
bloomWeight: number
The the strength of bloom.
bloomKernel: number
The size of the kernel to be used when applying the blur.
Optional pipelineTextureType: number
The type of texture to be used when performing the post processing.
Optional blockCompilation: boolean
If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
Returns BloomEffect
Accessors
is
Checks if all the post processes in the effect are supported.
Returns boolean
kernel
Specifies the size of the bloom blur kernel, relative to the final output size
Returns number
Specifies the size of the bloom blur kernel, relative to the final output size
Parameters
value: number
Returns void
threshold
The luminance threshold to find bright areas of the image to bloom.
Returns number
The luminance threshold to find bright areas of the image to bloom.
Parameters
value: number
Returns void
weight
The strength of the bloom.
Returns number
The strength of the bloom.
Parameters
value: number
Returns void
Methods
dispose
Disposes each of the internal effects for a given camera.
Parameters
camera: Camera
The camera to dispose the effect on.
Returns void
get
Gets a list of the post processes contained in the effect.
Parameters
Optional camera: Camera
The camera to get the post processes on.
Returns Nullable<PostProcess[]>
The list of the post processes in the effect.
The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras