Interface FilterComponent

FilterComponent is a wrapper around a Pixi.js filter. It provides a clean interface by which:

  1. Programmers can wrap arbitrary Pixi filters
  2. Programmers can attach filters to a Z plane or to WORLD/OVERLAY/HUD
  3. Programmers can leverage custom logic for updating their filters
interface FilterComponent {
    getFilters(): Filter[];
    preRender(elapsedMs): boolean;
}

Methods

getFilters preRender

Methods

getFilters

  • getFilters(): Filter[]

  • Return the Pixi.Filter object(s) for this FilterComponent

    Returns Filter[]

preRender

  • preRender(elapsedMs): boolean

  • Run an update task on each render step. This is useful for filters that change dynamically.

    Parameters

    • elapsedMs: number

      The time since the last call to preRender()

    Returns boolean

    A boolean indicating whether this filter should be applied during this render step or not.

Settings

Member Visibility

Theme

On This Page