RendererPlugin

Interface that defines an Excalibur Renderer that can be called with .draw() in the ExcaliburGraphicsContext

Index

Properties

• priority
• type

Methods

• dispose
• draw
• flush
• hasPendingDraws
• initialize

Properties

priority

priority: number

Render priority tie breaker when drawings are at the same z index

Lower number means higher priority and is drawn first. Higher number means lower priority and is drawn last.

readonlytype

type: string

Unique type name for this renderer plugin

Methods

dispose

• dispose(): void

• Clear out any allocated memory

  ---

  Returns void

draw

• draw(...args: any[]): void

• Issue a draw command to draw something to the screen

  ---

  Parameters

  • rest...args: any[]

  Returns void

flush

• flush(): void

• Flush any pending graphics draws to the screen

  ---

  Returns void

hasPendingDraws

• hasPendingDraws(): boolean

• ---

  Returns boolean

  if there are any pending draws in the renderer

initialize

• initialize(gl: WebGL2RenderingContext, context: ExcaliburGraphicsContextWebGL): void

• Initialize your renderer

  ---

  Parameters

  • gl: WebGL2RenderingContext

  • context: ExcaliburGraphicsContextWebGL

  Returns void