Name | Type | Default | Description |
---|---|---|---|
strength |
number |
The strength of the blur filter. |
|
quality |
number |
The quality of the blur filter. |
|
resolution |
number |
The resolution of the blur filter. |
|
kernelSize |
number | 5 |
optional
The kernelSize of the blur filter.Options: 5, 7, 9, 11, 13, 15. |
Extends
Members
-
autoFit boolean inherited
-
If enabled, PixiJS will fit the filter area into boundaries for better performance. Switch it off if it does not work for specific shader.
-
blendMode number inherited
-
Sets the blendmode of the filter
- Default Value:
- PIXI.BLEND_MODES.NORMAL
-
Sets the strength of both the blur.
- Default Value:
- 2
-
enabled boolean inherited
-
If enabled is true the filter is applied, if false it will not.
-
The fragment shader.
-
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.
-
Sets the quality of the blur by modifying the number of passes. More passes means higher quaility bluring but the lower the performance.
- Default Value:
- 4
-
resolution number inherited
-
The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter.
-
uniforms object inherited
-
An object containing the current values of custom uniforms.
Example
Updating the value of a custom uniform
filter.uniforms.time = performance.now();
-
The vertex shader.
Methods
-
apply (filterManager, input, output, clear) overrides
-
Applies the filter.
Name Type Description filterManager
PIXI.FilterManager The manager.
input
PIXI.RenderTarget The input target.
output
PIXI.RenderTarget The output target.
clear
boolean Should the output be cleared before rendering?