Interface: BlurFilterOptions

Defined in: node_modules/pixi.js/lib/filters/defaults/blur/BlurFilter.d.ts:38

Configuration options for the BlurFilter. Controls how the Gaussian blur effect is applied.

Example

// Basic blur with default values
const filter = new BlurFilter();

// Custom blur configuration
const filter = new BlurFilter({
    strength: 8,        // Overall blur strength
    quality: 4,         // Higher quality = better blur
    kernelSize: 5      // Size of blur kernel
});

// Different horizontal/vertical blur
const filter = new BlurFilter({
    strengthX: 4,      // Horizontal blur only
    strengthY: 12,     // Stronger vertical blur
    quality: 2         // Lower quality for better performance
});

Remarks

• Higher quality values produce better blur but impact performance
• KernelSize affects blur precision and performance
• Strength values determine blur intensity

See

• BlurFilter The filter that uses these options
• FilterOptions Base filter options

Standard

Extends

• FilterOptions

Extended by

• BlurFilterPassOptions

Properties

antialias?

> optional antialias?: boolean | FilterAntialias

Defined in: node_modules/pixi.js/lib/filters/Filter.d.ts:37

If true the filter will make use of antialiasing. Although it looks better this can have a performance impact. If set to 'inherit', the filter will detect the antialiasing of the render target and change this automatically. Definitely don't set this to true if the render target has antialiasing set to false. As it will antialias, but you won't see the difference. (default 'off')

This can be a boolean or [FilterAntialias]FilterAntialias string.

Inherited from

FilterOptions.antialias

blendMode?

> optional blendMode?: BLEND_MODES

Defined in: node_modules/pixi.js/lib/filters/Filter.d.ts:15

optional blend mode used by the filter when rendering (defaults to 'normal')

Inherited from

FilterOptions.blendMode

blendRequired?

> optional blendRequired?: boolean

Defined in: node_modules/pixi.js/lib/filters/Filter.d.ts:47

If this is set to true, the filter system will grab a snap shot of the area being rendered to and pass this into the shader. This is useful for blend modes that need to be aware of the pixels they are rendering to. Only use if you need that data, otherwise its an extra gpu copy you don't need! (default false)

If given, the shader should have a uniform named uBackTexture, which is where the pixels of the area being rendered to can be sampled from.

Inherited from

FilterOptions.blendRequired

clipToViewport?

> optional clipToViewport?: boolean

Defined in: node_modules/pixi.js/lib/filters/Filter.d.ts:53

If this is set to true, the filter system will clip filter texture into viewport This is useful for filters that applied to whole texture. (default true)

Inherited from

FilterOptions.clipToViewport

kernelSize?

> optional kernelSize?: number

Defined in: node_modules/pixi.js/lib/filters/defaults/blur/BlurFilter.d.ts:69

The kernelSize of the blur filter. Larger values create more precise blur but impact performance. Options: 5, 7, 9, 11, 13, 15.

Default

5

legacy?

> optional legacy?: boolean

Defined in: node_modules/pixi.js/lib/filters/defaults/blur/BlurFilter.d.ts:76

When true, uses the legacy (pre-v8.x) blur pass behavior where strength is distributed uniformly across passes (strength / passes) instead of the optimized halving scheme. This also disables per-pass WebGPU UBO batching.

Default

false

padding?

> optional padding?: number

Defined in: node_modules/pixi.js/lib/filters/Filter.d.ts:28

the amount of pixels to pad the container with when applying the filter. For example a blur extends the container out as it blurs, so padding is applied to ensure that extra detail is rendered as well without clipping occurring. (default 0)

Inherited from

FilterOptions.padding

quality?

> optional quality?: number

Defined in: node_modules/pixi.js/lib/filters/defaults/blur/BlurFilter.d.ts:62

The quality of the blur filter. Higher values mean better quality but slower performance.

Default

4

resolution?

> optional resolution?: number | "inherit"

Defined in: node_modules/pixi.js/lib/filters/Filter.d.ts:22

the resolution the filter should be rendered at. The lower the resolution, the more performant the filter will be, but the lower the quality of the output. (default 1) If 'inherit', the resolution of the render target is used. Consider lowering this for things like blurs filters

Inherited from

FilterOptions.resolution

strength?

> optional strength?: number

Defined in: node_modules/pixi.js/lib/filters/defaults/blur/BlurFilter.d.ts:44

The strength of the blur filter. Applied to both horizontal and vertical blur if strengthX/Y not set.

Default

8

strengthX?

> optional strengthX?: number

Defined in: node_modules/pixi.js/lib/filters/defaults/blur/BlurFilter.d.ts:50

The horizontal strength of the blur. Overrides strength parameter for x-axis.

Default

8

strengthY?

> optional strengthY?: number

Defined in: node_modules/pixi.js/lib/filters/defaults/blur/BlurFilter.d.ts:56

The vertical strength of the blur. Overrides strength parameter for y-axis.

Default

8