Class Canvas

constructor

• new Canvas(container: Container, engine: Engine): Canvas

  Constructor of canvas manager

  Parameters

  • container: Container

    the parent container

  • engine: Engine

    the engine managing the whole library

  Returns Canvas

Optionalelement

Readonlysize

settings

• get settings(): CanvasRenderingContext2DSettings | undefined

  Returns CanvasRenderingContext2DSettings | undefined

canvasClear

• canvasClear(): void

  Returns void

clear

• clear(): void

  Clears the canvas content

  Returns void

destroy

• destroy(): void

  Destroying object actions

  Returns void

draw

• draw<T>(cb: (context: CanvasRenderingContext2D) => T): T | undefined

  Generic draw method for drawing stuff on the canvas context

  Type Parameters

  • T

  Parameters

  • cb: (context: CanvasRenderingContext2D) => T

  Returns T | undefined

  the result of the callback

drawParticle

• drawParticle(particle: Particle, delta: IDelta): void

  Draws the specified particle in the canvas

  Parameters

  • particle: Particle

    the particle to draw

  • delta: IDelta

    the frame delta time values

  Returns void

drawParticlePlugins

• drawParticlePlugins(particle: Particle, delta: IDelta): void

  Draws stuff using the given plugin, using the given particle

  Parameters

  • particle: Particle

    the particle used

  • delta: IDelta

    the frame delta time values

  Returns void

drawParticles

• drawParticles(delta: IDelta): void

  Parameters

  • delta: IDelta

  Returns void

init

• init(): void

  Initializes the canvas element

  Returns void

initBackground

• initBackground(): void

  Initializes the canvas background

  Returns void

initPlugins

• initPlugins(): void

  Initializes the plugins needed by canvas

  Returns void

initUpdaters

• initUpdaters(): void

  Initializes the updaters needed by canvas

  Returns void

loadCanvas

• loadCanvas(canvas: HTMLCanvasElement): void

  Loads the canvas HTML element

  Parameters

  • canvas: HTMLCanvasElement

    the canvas HTML element

  Returns void

paint

• paint(): void

  Paints the canvas background

  Returns void

paintBase

• paintBase(baseColor?: string): void

  Parameters

  • OptionalbaseColor: string

  Returns void

paintImage

• paintImage(image: HTMLImageElement, opacity: number): void

  Parameters

  • image: HTMLImageElement
  • opacity: number

  Returns void

resize

• resize(): boolean

  Calculates the size of the canvas

  Returns boolean

  true if the size changed

setPointerEvents

• setPointerEvents(type: string): void

  Parameters

  • type: string

  Returns void

stop

• stop(): void

  Returns void

windowResize

• windowResize(): Promise<void>

  The window resize event handler

  Returns Promise<void>