BloomEffect
Extends:
Indirect Implements:
A bloom effect.
This effect uses the fast Kawase convolution technique and a luminance filter to blur bright highlights.
Constructor Summary
Public Constructor | ||
public |
constructor(options: Object) Constructs a new bloom effect. |
Member Summary
Public Members | ||
public get |
The luminance distinction factor. |
|
public set |
|
|
public get |
Indicates whether dithering is enabled. |
|
public set |
Enables or disables dithering. |
|
public get |
The blur kernel size. |
|
public set |
|
|
public get |
texture: Texture A texture that contains the intermediate result of this effect. |
Method Summary
Public Methods | ||
public |
Returns the current resolution scale. |
|
public |
initialize(renderer: WebGLRenderer, alpha: Boolean) Performs initialization tasks. |
|
public |
setResolutionScale(scale: Number) Sets the resolution scale. |
|
public |
Updates the size of internal render targets. |
|
public |
Updates this effect. |
Inherited Summary
From class Effect | ||
public |
The effect attributes. |
|
public |
The blend mode of this effect. |
|
public |
Preprocessor macro definitions. |
|
public |
WebGL extensions that are required by this effect. |
|
public |
The fragment shader. |
|
public |
The name of this effect. |
|
public |
Shader uniforms. |
|
public |
The vertex shader. |
|
public |
dispose() Performs a shallow search for properties that define a dispose method and deletes them. |
|
public |
initialize(renderer: WebGLRenderer, alpha: Boolean) Performs initialization tasks. |
|
public |
setDepthTexture(depthTexture: Texture, depthPacking: Number) Sets the depth texture. |
|
public |
Updates the size of this effect. |
|
public |
Updates the effect by performing supporting operations. |
Public Constructors
public constructor(options: Object) source
Constructs a new bloom effect.
Override:
Effect#constructorParams:
Name | Type | Attribute | Description |
options | Object |
|
The options. |
options.blendFunction | BlendFunction |
|
The blend function of this effect. |
options.distinction | Number |
|
The luminance distinction factor. Raise this value to bring out the brighter elements in the scene. |
options.resolutionScale | Number |
|
The render texture resolution scale, relative to the main frame buffer size. |
options.kernelSize | KernelSize |
|
The blur kernel size. |
Public Members
public set kernelSize: KernelSize source
public get texture: Texture source
A texture that contains the intermediate result of this effect.
This texture will be applied to the scene colors unless the blend function
is set to SKIP
.
Public Methods
public initialize(renderer: WebGLRenderer, alpha: Boolean) source
Performs initialization tasks.
Override:
Effect#initializeParams:
Name | Type | Attribute | Description |
renderer | WebGLRenderer | The renderer. |
|
alpha | Boolean | Whether the renderer uses the alpha channel or not. |
public setResolutionScale(scale: Number) source
Sets the resolution scale.
Params:
Name | Type | Attribute | Description |
scale | Number | The new resolution scale. |
public setSize(width: Number, height: Number) source
Updates the size of internal render targets.
Override:
Effect#setSizepublic update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number) source
Updates this effect.
Override:
Effect#updateParams:
Name | Type | Attribute | Description |
renderer | WebGLRenderer | The renderer. |
|
inputBuffer | WebGLRenderTarget | A frame buffer that contains the result of the previous pass. |
|
deltaTime | Number |
|
The time between the last frame and the current one in seconds. |