Class RendererAPI

API that provides rendering utilities and view management

Offers methods for view intersection testing, bounds calculation, and direct access to the underlying PIXI.js application

Index

Methods

addFilterEffect clearFilterEffects getBounds getFilterEffects getRenderingContext intersectsWithPoint intersectsWithRectangle reloadShaders removeFilterEffect

Methods

addFilterEffect

addFilterEffect(config: FilterEffectConfig): void
Adds a post-processing effect that applies to the entire scene. Effects are applied in the order they are added.
Parameters
- config: FilterEffectConfig
  Filter effect config with name and options
Returns void

clearFilterEffects

clearFilterEffects(): void

Clears all active filter effects.

Returns void

getBounds

getBounds(actor: Actor): Bounds | null
Returns the bounds of an actor If the actor has several views, the bounds will be the smallest rectangle that contains all views
Parameters
- actor: Actor
  Actor to get the bounds of
Returns Bounds | null
Bounds of the actor or null if the actor has no available views

getFilterEffects

getFilterEffects(): FilterEffectConfig[]

Returns the current filter effect configs in the order they were added.

Returns FilterEffectConfig[]
Effect config objects

getRenderingContext

getRenderingContext(): Application

Returns the underlying PIXI.js application

Returns Application
PIXI.js application instance

intersectsWithPoint

intersectsWithPoint(x: number, y: number): Actor[]
Returns the actors that intersect with a point
Parameters
- x: number
  X coordinate of the point in scene coordinates
- y: number
  Y coordinate of the point in scene coordinates
Returns Actor[]
Actors that intersect with the point

intersectsWithRectangle

intersectsWithRectangle(
    minX: number,
    minY: number,
    maxX: number,
    maxY: number,
): Actor[]
Returns the actors that intersect with a rectangle All coordinates should be passed in scene coordinates
Parameters
- minX: number
  X coordinate of the minimum point
- minY: number
  Y coordinate of the minimum point
- maxX: number
  X coordinate of the maximum point
- maxY: number
  Y coordinate of the maximum point
Returns Actor[]
Actors that intersect with the rectangle

reloadShaders

reloadShaders(classDefinitions: ShaderConstructor[]): void
Reloads shader classes registered in the renderer.
Parameters
- classDefinitions: ShaderConstructor[]
  Shader constructors to register
Returns void

removeFilterEffect

removeFilterEffect(config: FilterEffectConfig): void
Removes a filter effect by config object reference.
Parameters
- config: FilterEffectConfig
  Same config object passed to addFilterEffect
Returns void