Pixi’VNInterface: BlurFilterPassOptions
Defined in: node_modules/pixi.js/lib/filters/defaults/blur/BlurFilterPass.d.ts:11
Internal
Options for BlurFilterPass
Extends
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
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
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
BlurFilterOptions.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
BlurFilterOptions.clipToViewport
horizontal
> horizontal: boolean
Defined in: node_modules/pixi.js/lib/filters/defaults/blur/BlurFilterPass.d.ts:13
Do pass along the x-axis (true) or y-axis (false).
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
Inherited from
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
Inherited from
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
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
Inherited from
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
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
Inherited from
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
Inherited from
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