Class Canvas2DHeadless

constructor

• new Canvas2DHeadless(
      canvas: OffscreenCanvas,
      context: OffscreenCanvasRenderingContext2D,
      options?: Partial<Canvas2DOptions>,
  ): Canvas2DHeadless

  Constructs a new Canvas2DHeadless.

  Parameters

  • canvas: OffscreenCanvas

    The offscreen canvas we're drawing to.
  • context: OffscreenCanvasRenderingContext2D

    The rendering context to use for the canvas.
  • options: Partial<Canvas2DOptions> = {}

    The configuration for this canvas.

  Returns Canvas2DHeadless

buffer

Readonlyoptions

context

• get context(): OffscreenCanvasRenderingContext2D

  Retrieves the rendering context of the canvas.

  Returns OffscreenCanvasRenderingContext2D

  The rendering context of the canvas.

blendWith

• blendWith(color: number): void

  Fills the entire back buffer with the given color.

  Parameters

  • color: number

    The color to fill the back buffer with.

  Returns void

bufferReadBack

• bufferReadBack(): void

  Reads the front buffer back into the back buffer.

  Returns void

clearWith

• clearWith(color: number): void

  Fills the entire back buffer with the given color.

  Parameters

  • color: number

    The color to fill the back buffer with.

  Returns void

fade

• fade(color?: number): void

  Draws a slightly transparent, black rectangle over the canvas, and then reads the result back into the buffer.

  Parameters

  • color: number = ...

    The color to fade the buffer with. The alpha component of the color defines how strong the fade is. 0 is not at all, 255 makes it instantly black.

  Returns void

getPixel32

• getPixel32(x: number, y: number): number

  Returns the color of a pixel in the back buffer.

  Parameters

  • x: number

    The X coordinate to retrieve.
  • y: number

    The X coordinate to retrieve.

  Returns number

  The color of the pixel at the given local.

refreshCanvasNode

• refreshCanvasNode(): void

  Recreate internal buffers in reaction to a change in our target OffscreenCanvas.

  Returns void

render

• render(): void

  Draws the offscreen canvas into the DOM canvas.

  Returns void

renderFpsInfo

• renderFpsInfo(frameTimes: number[], frameTime: number, timeDelta: number): void

  Draw FPS information onto the canvas.

  Parameters

  • frameTimes: number[]

    Durations of previous frame draws.
  • frameTime: number

    The duration of the previous frame draw.
  • timeDelta: number

    The time elapsed since the last frame.

  Returns void

setPixel32

• setPixel32(x: number, y: number, color: number): void

  Colors a pixel in the back buffer.

  Parameters

  • x: number

    The X coordinate to color.
  • y: number

    The Y coordinate to color.
  • color: number

    The color to place at the coordinate.

  Returns void

update

• update(): void

  Draws the back buffer onto the canvas.

  Returns void