Class BlurFilterPass

The BlurFilterPass applies a horizontal or vertical Gaussian blur to an object.

Memberof

PIXI

Hierarchy (view full)

Constructors

constructor

Properties

autoFit disposeRunner enabled horizontal legacy multisample padding passes program state strength uniformGroup SOURCE_KEY_MAP defaultMultisample defaultResolution

Accessors

blendMode blur quality resolution uniforms defaultFragmentSrc defaultVertexSrc

Methods

apply checkUniformExists destroy from

Constructors

constructor

  • new BlurFilterPass(horizontal, strength?, quality?, resolution?, kernelSize?): Pixi.BlurFilterPass

  • Parameters

    • horizontal: boolean

      Do pass along the x-axis (true) or y-axis (false).

    • Optional strength: number

      The strength of the blur filter.

    • Optional quality: number

      The quality of the blur filter.

    • Optional resolution: number

      The resolution of the blur filter.

    • Optional kernelSize: number

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

    Returns Pixi.BlurFilterPass

Properties

autoFit

autoFit: boolean

If enabled, PixiJS will fit the filter area into boundaries for better performance. Switch it off if it does not work for specific shader.

Default

true

disposeRunner

disposeRunner: Runner<any, any[]>

enabled

enabled: boolean

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

horizontal

horizontal: boolean

Readonly legacy

legacy: boolean

Legacy filters use position and uvs from attributes (set by filter system)

multisample

multisample: null | MSAA_QUALITY

The samples override of the filter instance. If set to null, the sample count of the current render target is used.

Default

PIXI.Filter.defaultMultisample

padding

padding: number

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.

passes

passes: number

program

program: Program

Program that the shader uses.

state

state: State

The WebGL state the filter requires to render.

strength

strength: number

uniformGroup

uniformGroup: UniformGroup<Dict<any>>

Static SOURCE_KEY_MAP

SOURCE_KEY_MAP: Dict<string>

Used for caching shader IDs.

Static defaultMultisample

defaultMultisample: null | MSAA_QUALITY

Default filter samples for any filter.

Static

Default

PIXI.MSAA_QUALITY.NONE

Static defaultResolution

defaultResolution: null | number

Default filter resolution for any filter.

Static

Accessors

blendMode

  • get blendMode(): BLEND_MODES

  • Sets the blend mode of the filter.

    Returns BLEND_MODES

    Default

    PIXI.BLEND_MODES.NORMAL
  • set blendMode(value): void

  • Parameters

    Returns void

blur

  • get blur(): number

  • Sets the strength of both the blur.

    Returns number

    Default

    16
  • set blur(value): void

  • Parameters

    • value: number

    Returns void

quality

  • get quality(): number

  • Sets the quality of the blur by modifying the number of passes. More passes means higher quality bluring but the lower the performance.

    Returns number

    Default

    4
  • set quality(value): void

  • Parameters

    • value: number

    Returns void

resolution

  • get resolution(): null | number

  • The resolution of the filter. Setting this to be lower will lower the quality but increase the performance of the filter. If set to null or 0, the resolution of the current render target is used.

    Returns null | number

    Default

    PIXI.Filter.defaultResolution
  • set resolution(value): void

  • Parameters

    • value: null | number

    Returns void

uniforms

  • get uniforms(): Dict<any>

  • Shader uniform values, shortcut for uniformGroup.uniforms.

    Returns Dict<any>

Static defaultFragmentSrc

  • get defaultFragmentSrc(): string

  • The default fragment shader source

    Returns string

Static defaultVertexSrc

  • get defaultVertexSrc(): string

  • The default vertex shader source

    Returns string

Methods

apply

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

  • Applies the filter.

    Parameters

    Returns void

checkUniformExists

  • checkUniformExists(name, group): boolean

  • Parameters

    Returns boolean

destroy

  • destroy(): void

  • Returns void

Static from

  • from(vertexSrc?, fragmentSrc?, uniforms?): Shader

  • A short hand function to create a shader based of a vertex and fragment shader.

    Parameters

    • Optional vertexSrc: string

      The source of the vertex shader.

    • Optional fragmentSrc: string

      The source of the fragment shader.

    • Optional uniforms: Dict<any>

      Custom uniforms to use to augment the built-in ones.

    Returns Shader

    A shiny new PixiJS shader!

Settings

Member Visibility

Theme

On This Page

constructorautoFitdisposeRunnerenabledhorizontallegacymultisamplepaddingpassesprogramstatestrengthuniformGroupSOURCE_KEY_MAPdefaultMultisampledefaultResolutionblendModeblurqualityresolutionuniformsdefaultFragmentSrcdefaultVertexSrcapplycheckUniformExistsdestroyfrom

Generated using TypeDoc