BlurPass
Extends:
Indirect Implements:
An efficient, incremental blur pass.
Note: This pass allows the input and output buffer to be the same.
Constructor Summary
Public Constructor | ||
public |
constructor(options: Object) Constructs a new blur pass. |
Member Summary
Public Members | ||
public |
Whether the blurred result should also be dithered using noise. |
|
public get |
The absolute height of the internal render targets. |
|
public get |
The kernel size. |
|
public set |
Sets the kernel size. |
|
public get |
The absolute width of the internal render targets. |
Method Summary
Public Methods | ||
public |
Returns the current resolution scale. |
|
public |
initialize(renderer: WebGLRenderer, alpha: Boolean) 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) Sets the resolution scale. |
|
public |
Updates the size of this pass. |
Inherited Summary
From class Pass | ||
public |
Indicates whether this pass should be executed. |
|
public |
The name of this pass. |
|
public |
Only relevant for subclassing. |
|
public |
Only relevant for subclassing. |
|
public |
Indicates whether this pass should render to screen. |
|
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) 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. |
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 |
|
The render texture resolution scale, relative to the main frame buffer size. |
options.kernelSize | KernelSize |
|
The blur kernel size. |
Public Members
Public Methods
public initialize(renderer: WebGLRenderer, alpha: Boolean) source
Performs initialization tasks.
Override:
Pass#initializeParams:
Name | Type | Attribute | Description |
renderer | WebGLRenderer | The renderer. |
|
alpha | Boolean | Whether the renderer uses the alpha channel or not. |
public 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 its 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. |