Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Canvas

Abstraction over the HTMLCanvasElement

Hierarchy

  • Canvas

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Canvas(width?: number, height?: number, background?: string): Canvas

  • Initialize a new Canvas

    Parameters

    • width: number = 400
    • height: number = 400
    • background: string = "#FFFFFF"

      background color

    Returns Canvas

Properties

Private Optional _ctx

_ctx?: CanvasRenderingContext2D

Readonly canElement

canElement: HTMLCanvasElement

Readonly height

height: number

Readonly width

width: number

Accessors

ctx

  • get ctx(): CanvasRenderingContext2D

  • Returns CanvasRenderingContext2D

rect

  • Returns Rect

size

  • Returns Vec2

Methods

attach

  • attach(parent?: Node, id?: string): Canvas

  • Parameters

    • Optional parent: Node
    • Optional id: string

    Returns Canvas

boundingRect

  • boundingRect(): Rect

  • Returns Rect

clear

  • Returns Canvas

drawText

  • drawText(text: string, pos: Vec2, options?: Record<string, unknown>): void

  • Parameters

    • text: string
    • pos: Vec2
    • Optional options: Record<string, unknown>

    Returns void

smooth

  • smooth(enabled: boolean): Canvas

  • Parameters

    • enabled: boolean

    Returns Canvas

Static quickSetup

  • quickSetup(options: Record<string, unknown>): Canvas

  • A simple shortcut covering the most common case

    Parameters

    • options: Record<string, unknown>

    Returns Canvas

Generated using TypeDoc