Options
All
  • Public
  • Public/Protected
  • All
Menu

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

param horizontal

If the pass is horizontal (true) or vertical (false).

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
    • AlphaBlurFilterPass

Index

Constructors

  • new AlphaBlurFilterPass(horizontal: any, strength?: number, quality?: number, resolution?: any, kernelSize?: number): AlphaBlurFilterPass
  • Parameters

    • horizontal: any
    • strength: number = 8
    • quality: number = 4
    • resolution: any = PIXI.settings.FILTER_RESOLUTION
    • kernelSize: number = 5

    Returns AlphaBlurFilterPass

Properties

horizontal: boolean
strength: number
passes: number
resolution: any
padding: number
GAUSSIAN_VALUES: Object = ...

The kernels containing the gaussian constants.

Accessors

  • get quality(): number
  • set quality(value: number): void
  • The quality of the filter is defined by its number of passes.

    Returns number

  • The quality of the filter is defined by its number of passes.

    Parameters

    • value: number

    Returns void

  • get blur(): number
  • set blur(value: number): void
  • The strength of the blur filter in pixels.

    Returns number

  • The strength of the blur filter in pixels.

    Parameters

    • value: number

    Returns void

Methods

  • apply(filterManager: any, input: any, output: any, clearMode: any): any
  • override

    Parameters

    • filterManager: any
    • input: any
    • output: any
    • clearMode: any

    Returns any

  • fragTemplate(kernelSize: number): string
  • The fragment template generator

    Parameters

    • kernelSize: number

      The number of kernels to use.

    Returns string

    The generated fragment shader.

  • vertTemplate(kernelSize: number, horizontal: boolean): string
  • The vertex template generator

    Parameters

    • kernelSize: number

      The number of kernels to use.

    • horizontal: boolean

      If the vertex should handle horizontal or vertical pass.

    Returns string

    The generated vertex shader.

  • generateBlurFragSource(kernelSize: number): string
  • Generating the dynamic part of the blur in the fragment

    Parameters

    • kernelSize: number

      The number of kernels to use.

    Returns string

    The dynamic blur part.

  • generateBlurVertSource(kernelSize: number, horizontal: boolean): string
  • Generating the dynamic part of the blur in the vertex

    Parameters

    • kernelSize: number

      The number of kernels to use.

    • horizontal: boolean

      If the vertex should handle horizontal or vertical pass.

    Returns string

    The dynamic blur part.