Class GlowOverlayFilter

A filter which implements an inner or outer glow around the source texture. Inspired from https://github.com/pixijs/filters/tree/main/filters/glow

License

MIT

Hierarchy (view full)

Properties

padding innerStrength outerStrength animated defaultUniforms vertexShader fragmentShader

Methods

apply createFragmentShader create

Properties

padding

padding: number = 6

innerStrength

innerStrength: number = 3

The inner strength of the glow.

outerStrength

outerStrength: number = 3

The outer strength of the glow.

animated

animated: boolean = true

Should this filter auto-animate?

Static defaultUniforms

defaultUniforms: {
    distance: number;
    glowColor: number[];
    quality: number;
    time: number;
    knockout: boolean;
    alpha: number;
} = ...

The default uniforms used by the filter

Type declaration

  • distance: number
  • glowColor: number[]
  • quality: number
  • time: number
  • knockout: boolean
  • alpha: number

Static vertexShader

vertexShader: string = ...

The vertex shader which renders this filter.

Static fragmentShader

fragmentShader: string = undefined

The fragment shader which renders this filter.

Methods

apply

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

  • Parameters

    • filterManager: any
    • input: any
    • output: any
    • clear: any

    Returns void

Static createFragmentShader

  • createFragmentShader(quality, distance): string

  • Dynamically create the fragment shader used for filters of this type.

    Parameters

    • quality: number
    • distance: number

    Returns string

Static create

  • create(initialUniforms?): GlowOverlayFilter

  • A factory method for creating the filter using its defined default values.

    Parameters

    • initialUniforms: {} = {}

      Initial uniform values which override filter defaults

      Returns GlowOverlayFilter

      The constructed AbstractFilter instance.

    Settings

    Member Visibility

    Theme

    On This Page

    paddinginnerStrengthouterStrengthanimateddefaultUniformsvertexShaderfragmentShaderapplycreateFragmentShadercreate