ParticleRenderer

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

Implements

• RendererPlugin

Index

Constructors

• constructor

Properties

• priority
• type

Methods

• dispose
• draw
• flush
• hasPendingDraws
• initialize

Constructors

constructor

• new ParticleRenderer(): ParticleRenderer

• Returns ParticleRenderer

Properties

publicpriority

priority: number = 0

Implementation of RendererPlugin.priority

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.

publicreadonlytype

type: ex.particle = ...

Implementation of RendererPlugin.type

Unique type name for this renderer plugin

Methods

dispose

• dispose(): void

• Implementation of RendererPlugin.dispose

  Clear out any allocated memory

  ---

  Returns void

draw

• draw(renderer: GpuParticleRenderer, elapsedMs: number): void

• Implementation of RendererPlugin.draw

  Issue a draw command to draw something to the screen

  ---

  Parameters

  • renderer: GpuParticleRenderer

  • elapsedMs: number

  Returns void

flush

• flush(): void

• Implementation of RendererPlugin.flush

  Flush any pending graphics draws to the screen

  ---

  Returns void

hasPendingDraws

• hasPendingDraws(): boolean

• Implementation of RendererPlugin.hasPendingDraws

  ---

  Returns boolean

  if there are any pending draws in the renderer

initialize

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

• Implementation of RendererPlugin.initialize

  Initialize your renderer

  ---

  Parameters

  • gl: WebGL2RenderingContext

  • context: ExcaliburGraphicsContextWebGL

  Returns void