Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Filter

An effect.

Hierarchy

  • Filter

Implemented by

Index

Methods

Methods

applyEffect

  • Apply the effect on the PixiJS DisplayObject. Called after the effect is initialized.

    Parameters

    Returns boolean

isEnabled

  • Check if an effect is enabled.

    Parameters

    Returns boolean

    true if the filter is enabled

removeEffect

setEnabled

  • Enable an effect.

    Parameters

    • target: EffectsTarget
    • enabled: boolean

      Set to true to enable, false to disable

    Returns boolean

updateBooleanParameter

  • updateBooleanParameter(parameterName: string, value: boolean): void

  • The function to be called to update a parameter (with a boolean)

    Parameters

    • parameterName: string
    • value: boolean

    Returns void

updateDoubleParameter

  • updateDoubleParameter(parameterName: string, value: number): void

  • The function to be called to update a parameter (with a number)

    Parameters

    • parameterName: string
    • value: number

    Returns void

updatePreRender

  • The function to be called to update the filter at every frame before the rendering.

    Parameters

    Returns any

updateStringParameter

  • updateStringParameter(parameterName: string, value: string): void

  • The function to be called to update a parameter (with a string)

    Parameters

    • parameterName: string
    • value: string

    Returns void

Generated using TypeDoc