PixiJS

Class: BlurFilter

BlurFilter

The BlurFilter applies a Gaussian blur to an object.

The strength of the blur can be set for the x-axis and y-axis separately.

new BlurFilter (…options)

ts:60
Name Type Description
options BlurFilterOptions

The options of the blur filter.

Extends

Members

defaultOptions Partial<BlurFilterOptions> static

Default blur filter options

Properties:
Name Type Default Description
kernelSize number 5

The kernelSize of the blur filter.Options: 5, 7, 9, 11, 13, 15.
quality number 4

The quality of the blur filter.
strength number 8

The strength of the blur filter.

blur number

Sets the strength of both the blurX and blurY properties simultaneously

Default Value:
  • 2

blurX number

Sets the strength of the blurX property

Default Value:
  • 2

blurXFilter BlurFilterPass

The horizontal blur filter

blurY number

Sets the strength of the blurY property

Default Value:
  • 2

blurYFilter BlurFilterPass

The vertical blur filter

quality number

Sets the number of passes for blur. More passes means higher quality bluring.

Default Value:
  • 1

repeatEdgePixels boolean

If set to true the edge of the target will be clamped

Default Value:
  • false

Methods

apply (filterManager, input, output, clearMode) void overrides

ts:104

Applies the filter.

Name Type Description
filterManager FilterSystem

The manager.
input Texture

The input target.
output RenderSurface

The output target.
clearMode boolean

How to clear

Inherited Properties

From class Filter

antialias FilterAntialias inherited

should the filter use antialiasing?

Default Value:
  • inherit

blendMode BLEND_MODES inherited overrides

Get the blend mode of the filter.

Default Value:
  • "normal"

blendRequired boolean inherited

Whether or not this filter requires the previous render texture for blending.

Default Value:
  • false

enabled boolean inherited

If enabled is true the filter is applied, if false it will not.

Default Value:
  • true

padding number inherited

The padding of the filter. Some filters require extra space to breath such as a blur. Increasing this will add extra width and height to the bounds of the object that the filter is applied to.

Default Value:
  • 0

resolution number inherited

The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter.

Default Value:
  • 1

From class Shader

compatibleRenderers number readonly inherited

A number that uses two bits on whether the shader is compatible with the WebGL renderer and/or the WebGPU renderer. 0b00 - not compatible with either 0b01 - compatible with WebGL 0b10 - compatible with WebGPU This is automatically set based on if a GlProgram or {@link GpuProgram} is provided.

glProgram GlProgram inherited

An instance of the GL program used by the WebGL renderer

gpuProgram GpuProgram inherited

An instance of the GPU program used by the WebGPU renderer

resources Record<string, any> inherited

A record of the resources used by the shader.

Inherited Methods

From class Shader

addResource (name, groupIndex, bindIndex) void inherited

ts:336

Sometimes a resource group will be provided later (for example global uniforms) In such cases, this method can be used to let the shader know about the group.

Name Type Description
name string

the name of the resource group
groupIndex number

the index of the group (should match the webGPU shader group location)
bindIndex number

the index of the bind point (should match the webGPU shader bind point)

destroy (destroyPrograms) void inherited

ts:380

Use to destroy the shader when its not longer needed. It will destroy the resources and remove listeners.

Name Type Default Description
destroyPrograms boolean false

if the programs should be destroyed as well. Make sure its not being used by other shaders!

Inherited Events

From class Shader

destroy inherited

ts:173

Fired after rendering finishes.