Static Member Summary
Static Public Members | ||
public static get |
this get was deprecated. Use {@link Resizer.AUTO_SIZE} instead.
An auto sizing flag. |
Constructor Summary
Public Constructor | ||
public |
constructor(options: Object) Constructs a new blur pass. |
Member Summary
Public Members | ||
public |
this member was deprecated. Set the frameBufferType of the EffectComposer to HalfFloatType instead.
Whether the blurred result should also be dithered using noise. |
|
public get |
this get was deprecated. Use resolution.height instead.
The current height of the internal render targets. |
|
public set |
this set was deprecated. Use resolution.height instead.
Sets the render height. |
|
public get |
The kernel size. |
|
public set |
Sets the kernel size. |
|
public |
The render resolution. |
|
public get |
The current blur scale. |
|
public set |
Sets the blur scale. |
|
public get |
this get was deprecated. Use resolution.width instead.
The current width of the internal render targets. |
|
public set |
this set was deprecated. Use resolution.width instead.
Sets the render width. |
Method Summary
Public Methods | ||
public |
this method was deprecated. Adjust the fixed resolution width or height instead.
Returns the current resolution scale. |
|
public |
initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks. |
|
public |
render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Blurs the input buffer and writes the result to the output buffer. |
|
public |
setResolutionScale(scale: Number) this method was deprecated. Adjust the fixed resolution width or height instead.
Sets the resolution scale. |
|
public |
Updates the size of this pass. |
Inherited Summary
From class Pass | ||
public get |
Indicates whether this pass should render to screen. |
|
public set |
Sets the render to screen flag. |
|
public |
Indicates whether this pass should be executed. |
|
public |
The name of this pass. |
|
public |
Only relevant for subclassing. |
|
public |
Only relevant for subclassing. |
|
protected |
camera: Camera The camera. |
|
protected |
scene: Scene The scene to render. |
|
public |
dispose() Performs a shallow search for disposable properties and deletes them. |
|
public |
getDepthTexture(): Texture Returns the current depth texture. |
|
public |
getFullscreenMaterial(): Material Returns the current fullscreen material. |
|
public |
initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks. |
|
public abstract |
render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders the effect. |
|
public |
setDepthTexture(depthTexture: Texture, depthPacking: Number) Sets the depth texture. |
|
public |
Updates this pass with the renderer's size. You may override this method in case you want to be informed about the size of the main frame buffer. The EffectComposer calls this method before this pass is initialized and every time its own size is updated. |
|
protected |
setFullscreenMaterial(material: Material) Sets the fullscreen material. |
Static Public Members
Public Constructors
public constructor(options: Object) source
Constructs a new blur pass.
Override:
Pass#constructorParams:
Name | Type | Attribute | Description |
options | Object |
|
The options. |
options.resolutionScale | Number |
|
Deprecated. Adjust the height or width instead for consistent results. |
options.width | Number |
|
The blur render width. |
options.height | Number |
|
The blur render height. |
options.kernelSize | KernelSize |
|
The blur kernel size. |
Public Members
public dithering: Boolean source
Whether the blurred result should also be dithered using noise.
public get height: Number source
The current height of the internal render targets.
public set height: Number source
Sets the render height.
public set kernelSize: KernelSize source
Sets the kernel size.
Larger kernels require more processing power but scale well with larger render resolutions.
public resolution: Resizer source
The render resolution.
It's recommended to set the height or the width to an absolute value for consistent results across different devices and resolutions.
public set scale: Number source
Sets the blur scale.
This value influences the overall blur strength and should not be greater than 1. For larger blurs please increase the kernelSize!
Note that the blur strength is closely tied to the resolution. For a smooth transition from no blur to full blur, set the width or the height to a high enough value.
Public Methods
public getResolutionScale(): Number source
Returns the current resolution scale.
public initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) source
Performs initialization tasks.
Override:
Pass#initializepublic render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) source
Blurs the input buffer and writes the result to the output buffer. The input buffer remains intact, unless it's also the output buffer.
Override:
Pass#renderParams:
Name | Type | Attribute | Description |
renderer | WebGLRenderer | The renderer. |
|
inputBuffer | WebGLRenderTarget | A frame buffer that contains the result of the previous pass. |
|
outputBuffer | WebGLRenderTarget | A frame buffer that serves as the output render target unless this pass renders to screen. |
|
deltaTime | Number |
|
The time between the last frame and the current one in seconds. |
stencilTest | Boolean |
|
Indicates whether a stencil mask is active. |