import {BoxBlurPass} from 'postprocessing'

public class | source

BoxBlurPass

Extends:

Pass → BoxBlurPass

Indirect Implements:

A box blur pass.

Constructor Summary

Public Constructor
public	constructor(options: Object) Constructs a new box blur pass.

Member Summary

Public Members
public	blurMaterial: BoxBlurMaterial The blur material.
public	copyMaterial: CopyMaterial A copy material.
public	fullscreenMaterial: *
public	iterations: Number The amount of blur iterations.
public set	mainCamera
public	needsDepthTexture: *

Method Summary

Public Methods
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders the blur.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) Sets the depth texture.
public	setSize(width: Number, height: Number) Updates the size of this pass.

Inherited Summary

From class Pass
public get	fullscreenMaterial: Material The fullscreen material.
public set	fullscreenMaterial
public set	mainCamera: Camera Sets the main camera.
public set	mainScene: Scene Sets the main scene.
public get	renderToScreen: Boolean Sets the render to screen flag.
public set	renderToScreen
public	enabled: Boolean Indicates whether this pass is enabled.
public	name: String The name of this pass.
public	needsDepthTexture: Boolean Only relevant for subclassing.
public	needsSwap: Boolean Only relevant for subclassing.
protected	camera: Camera The camera.
protected	renderer: WebGLRenderer this member was deprecated. The renderer.
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 this method was deprecated. Use fullscreenMaterial instead. Returns the current fullscreen material.
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	isEnabled(): Boolean this method was deprecated. Use enabled instead. Indicates whether this pass is enabled.
public abstract	render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) Renders this pass.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategy) Sets the depth texture.
public	setEnabled(value: Boolean) this method was deprecated. Use enabled instead. Enables or disables this pass.
public	setRenderer(renderer: WebGLRenderer) this method was deprecated. Sets the renderer
public	setSize(width: Number, height: Number) Sets the size.
protected	setFullscreenMaterial(value: Material) this method was deprecated. Use fullscreenMaterial instead. Sets the fullscreen material.

Public Constructors

public constructor(options: Object) source

Constructs a new box blur pass.

Override:

Pass#constructor

Params:

Name	Type	Attribute	Description
options	Object	optional	The options.
options.kernelSize	Number	optional default: 5	Must be an odd number. The sizes 3 and 5 use optimized code paths.
options.iterations	Number	optional default: 1	The amount of times the blur should be applied.
options.bilateral	Number	optional default: false	Enables or disables bilateral blurring.
options.resolutionScale	Number	optional default: 1.0	The resolution scale.
options.resolutionX	Number	optional default: Resolution.AUTO_SIZE	The horizontal resolution.
options.resolutionY	Number	optional default: Resolution.AUTO_SIZE	The vertical resolution.

Public Members

public blurMaterial: BoxBlurMaterial source

The blur material.

public copyMaterial: CopyMaterial source

A copy material.

public fullscreenMaterial: * source

The fullscreen material.

Override:

Pass#fullscreenMaterial

public iterations: Number source

The amount of blur iterations.

public set mainCamera source

Sets the main camera.

Override:

Pass#mainCamera

public needsDepthTexture: * source

Only relevant for subclassing.

Indicates whether the EffectComposer should prepare a depth texture for this pass. Set this to true if this pass relies on depth information from a preceding RenderPass.

Override:

Pass#needsDepthTexture

Public Methods

public initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) source

Performs initialization tasks.

Override:

Pass#initialize

Params:

Name	Type	Attribute	Description
renderer	WebGLRenderer		The renderer.
alpha	Boolean		Whether the renderer uses the alpha channel or not.
frameBufferType	Number		The type of the main frame buffers.

public render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean) source

Renders the blur.

Override:

Pass#render

Params:

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	optional	The time between the last frame and the current one in seconds.
stencilTest	Boolean	optional	Indicates whether a stencil mask is active.

public setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) source

Sets the depth texture.

Override:

Pass#setDepthTexture

Params:

Name	Type	Attribute	Description
depthTexture	Texture		A depth texture.
depthPacking	DepthPackingStrategies	optional default: BasicDepthPacking	The depth packing strategy.

public setSize(width: Number, height: Number) source

Updates the size of this pass.

Override:

Pass#setSize

Params:

Name	Type	Attribute	Description
width	Number		The width.
height	Number		The height.