Class AlphaBlurFilterPass

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

Strength of the blur (distance of sampling).

Param: quality

Number of passes to generate the blur. More passes = Higher quality = Lower Perf.

Param: resolution

Resolution of the filter.

Param: kernelSize

Number of kernels to use. More kernels = Higher quality = Lower Perf.

Hierarchy

  • any
    • AlphaBlurFilterPass

Properties

horizontal strength passes GAUSSIAN_VALUES

Accessors

quality blur

Methods

apply fragTemplate vertTemplate generateBlurFragSource generateBlurVertSource

Properties

horizontal

horizontal: boolean

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

strength

strength: number

Strength of the blur (distance of sampling).

passes

passes: number

The number of passes to generate the blur.

Static GAUSSIAN_VALUES

GAUSSIAN_VALUES: Record<number, number[]> = ...

The kernels containing the gaussian constants.

Accessors

quality

  • get quality(): number

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

    Returns number

blur

  • get blur(): number

  • The strength of the blur filter in pixels.

    Returns number

Methods

apply

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

  • Parameters

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

    Returns any

Static fragTemplate

  • fragTemplate(kernelSize): string

  • The fragment template generator

    Parameters

    • kernelSize: number

      The number of kernels to use.

    Returns string

    The generated fragment shader.

Static vertTemplate

  • vertTemplate(kernelSize, horizontal): 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.

Static generateBlurFragSource

  • generateBlurFragSource(kernelSize): 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.

Static generateBlurVertSource

  • generateBlurVertSource(kernelSize, horizontal): 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.

Settings

Member Visibility

Theme

On This Page

horizontalstrengthpassesGAUSSIAN_VALUESqualityblurapplyfragTemplatevertTemplategenerateBlurFragSourcegenerateBlurVertSource