Options
All
  • Public
  • Public/Protected
  • All
Menu

An effect used to manipulate a Pixi filter.

Hierarchy

  • PixiFilter

Implements

Index

Methods

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

    Parameters

    Returns boolean

  • Check if an effect is enabled.

    Parameters

    Returns boolean

    true if the filter is enabled

  • 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(parameterName: string, value: number): void
  • The function to be called to update a parameter (with a number)

    Parameters

    • parameterName: string
    • value: number

    Returns void

  • 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

Constructors

Properties

filterCreator: PixiFilterCreator
pixiFilter: Filter

The PIXI filter

Generated using TypeDoc