Class AlphaBlurFilter

Apply a gaussian blur going inward by using alpha as the penetrating channel.

param [strength=8]: Strength of the blur (distance of sampling).
param [quality=4]: Number of passes to generate the blur. More passes = Higher quality = Lower Perf.
param [resolution=PIXI.settings.FILTER_RESOLUTION]: Resolution of the filter.
param [kernelSize=5]: Number of kernels to use. More kernels = Higher quality = Lower Perf.

Hierarchy

any
- AlphaBlurFilter

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AlphaBlurFilter(strength?: number, quality?: number, resolution?: any, kernelSize?: number): AlphaBlurFilter

Overrides PIXI.Filter.constructor
Parameters
- strength: number = 8
- quality: number = 4
- resolution: any = PIXI.settings.FILTER_RESOLUTION
- kernelSize: number = 5
Returns AlphaBlurFilter

Properties

blurXFilter

blurXFilter: AlphaBlurFilterPass

blurYFilter

blurYFilter: AlphaBlurFilterPass

resolution

resolution: any

_repeatEdgePixels

_repeatEdgePixels: boolean

padding

padding: number

Accessors

quality

get quality(): number
set quality(value: number): void

The quality of blur defines the number of passes used by subsidiary filters.

Returns number
The quality of blur defines the number of passes used by subsidiary filters.

Parameters
- value: number
Returns void

blur

get blur(): number
set blur(value: number): void

The amount of blur is forwarded to the X and Y filters.

Returns number
The amount of blur is forwarded to the X and Y filters.

Parameters
- value: number
Returns void

repeatEdgePixels

get repeatEdgePixels(): boolean
set repeatEdgePixels(value: boolean): void

Whether to repeat edge pixels, adding padding to the filter area.

Returns boolean
Whether to repeat edge pixels, adding padding to the filter area.

Parameters
- value: boolean
Returns void

blurX

get blurX(): number
set blurX(value: number): void

Provided for completeness with PIXI.filters.BlurFilter

Returns number
Provided for completeness with PIXI.filters.BlurFilter

Parameters
- value: number
Returns void

blurY

get blurY(): number
set blurY(value: number): void

Provided for completeness with PIXI.filters.BlurFilter

Returns number
Provided for completeness with PIXI.filters.BlurFilter

Parameters
- value: number
Returns void

blendMode

get blendMode(): number
set blendMode(value: number): void

Provided for completeness with PIXI.filters.BlurFilter

Returns number
Provided for completeness with PIXI.filters.BlurFilter

Parameters
- value: number
Returns void

Methods

apply

apply(filterManager: any, input: any, output: any, clearMode: any): void

override
Parameters
- filterManager: any
- input: any
- output: any
- clearMode: any
Returns void

updatePadding

updatePadding(): void

Update the filter padding according to the blur strength value (0 if _repeatEdgePixels is active)

Returns void