Class BloomEffect
Hierarchy (View Summary)
- PostProcessRenderEffect
- BloomEffect
Constructors
constructor
-
new BloomEffect(
sceneOrEngine: Scene | AbstractEngine,
bloomScale: number,
bloomWeight: number,
bloomKernel: number,
pipelineTextureType?: number,
blockCompilation?: boolean,
): BloomEffectCreates a new instance of
Parameters
- sceneOrEngine: Scene | AbstractEngine
The scene or engine 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 strength of bloom.
- bloomKernel: number
The size of the kernel to be used when applying the blur.
- pipelineTextureType: number = 0
The type of texture to be used when performing the post processing.
- blockCompilation: boolean = false
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
- sceneOrEngine: Scene | AbstractEngine
Accessors
bloom
-
get bloomScale(): number
Returns number
is
-
get isSupported(): boolean
Checks if all the post processes in the effect are supported.
Returns boolean
kernel
-
get kernel(): number
Specifies the size of the bloom blur kernel, relative to the final output size
Returns number
-
set kernel(value: number): void
Parameters
- value: number
Returns void
threshold
-
get threshold(): number
The luminance threshold to find bright areas of the image to bloom.
Returns number
-
set threshold(value: number): void
Parameters
- value: number
Returns void
weight
-
get weight(): number
The strength of the bloom.
Returns number
-
set weight(value: number): void
Parameters
- value: number
Returns void
Methods
dispose
-
Disposes each of the internal effects for a given camera.
Parameters
Optionalcamera: CameraThe camera to dispose the effect on.
Returns void
get
-
Gets a list of the post processes contained in the effect.
Parameters
Optionalcamera: CameraThe 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