Class FilterSystemAdvanced

constructor

• new FilterSystem(renderer: Renderer): FilterSystem

  Parameters

  • renderer: Renderer

  Returns FilterSystem

Readonlyrenderer

activeBackTexture

• get activeBackTexture(): Texture<TextureSource<any>>

  The back texture of the currently active filter. Requires the filter to have blendRequired set to true.

  Returns Texture<TextureSource<any>>

applyFilter

• applyFilter(
      filter: Filter,
      input: Texture,
      output: RenderSurface,
      clear: boolean,
  ): void

  Applies a filter to a texture.

  Parameters

  • filter: Filter

    The filter to apply.
  • input: Texture

    The input texture.
  • output: RenderSurface

    The output render surface.
  • clear: boolean

    Whether to clear the output surface before applying the filter.

  Returns void

calculateSpriteMatrix

• calculateSpriteMatrix(outputMatrix: Matrix, sprite: Sprite): Matrix

  Multiply input normalized coordinates to this matrix to get sprite texture normalized coordinates.

  Use outputMatrix * vTextureCoord in the shader.

  Parameters

  • outputMatrix: Matrix

    The matrix to output to.
  • sprite: Sprite

    The sprite to map to.

  Returns Matrix

  The mapped matrix.

destroy

• destroy(): void

  Generic destroy methods to be overridden by the subclass

  Returns void

generateFilteredTexture

• generateFilteredTexture(
      params: { filters: Filter[]; texture: Texture },
  ): Texture

  Applies filters to a texture.

  This method takes a texture and a list of filters, applies the filters to the texture, and returns the resulting texture.

  Parameters

  • params: { filters: Filter[]; texture: Texture }

    The parameters for applying filters.

    • filters: Filter[]

      The filters to apply.

    • texture: Texture

      The texture to apply filters to.

  Returns Texture

  The resulting texture after all filters have been applied.

  Example

  // Create a texture and a list of filters
  const texture = new Texture(...);
  const filters = [new BlurFilter(), new ColorMatrixFilter()];
  
  // Apply the filters to the texture
  const resultTexture = filterSystem.applyToTexture({ texture, filters });
  
  // Use the resulting texture
  sprite.texture = resultTexture;
  Copy

  Key Points:

  1. padding is not currently supported here - so clipping may occur with filters that use padding.
  2. If all filters are disabled or skipped, the original texture is returned.

getBackTexture

• getBackTexture(
      lastRenderSurface: RenderTarget,
      bounds: Bounds,
      previousBounds?: Bounds,
  ): Texture<TextureSource<any>>

  Copies the last render surface to a texture.

  Parameters

  • lastRenderSurface: RenderTarget

    The last render surface to copy from.
  • bounds: Bounds

    The bounds of the area to copy.
  • OptionalpreviousBounds: Bounds

    The previous bounds to use for offsetting the copy.

  Returns Texture<TextureSource<any>>