Class CanvasTerminal

Renders a display by writing fonts to a canvas.

Hierarchy

BaseTerminal
- CanvasTerminal

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CanvasTerminal(config: CanvasTerminalConfig): CanvasTerminal

Overrides BaseTerminal.constructor
- Defined in terminal/canvas-terminal.ts:32
Creates a new CanvasTerminal.

Parameters
- config: CanvasTerminalConfig
  
  The config for the CanvasTerminal
Returns CanvasTerminal

Properties

backColor

backColor: Color

Readonly display

display: Display

Readonly font

font: Font

foreColor

foreColor: Color

Readonly height

height: number

Readonly scale

scale: number = window.devicePixelRatio

Readonly width

width: number

Methods

clear

clear(): void

Inherited from BaseTerminal.clear
- Defined in terminal/terminal.ts:33
Returns void

delete

delete(): void

Overrides BaseTerminal.delete
- Defined in terminal/canvas-terminal.ts:136
Deletes the terminal, removing the canvas.

Returns void

drawCharCode

drawCharCode(pos: Vector2, charCode: number, foreColor?: Color, backColor?: Color): void

Inherited from BaseTerminal.drawCharCode
- Defined in terminal/terminal.ts:67
Parameters
- pos: Vector2
- charCode: number
- Default value foreColor: Color = this.foreColor
- Default value backColor: Color = this.backColor
Returns void

drawGlyph

drawGlyph(pos: Vector2, glyph: Glyph): void

Overrides BaseTerminal.drawGlyph
- Defined in terminal/canvas-terminal.ts:84
Draws a glyph on the display.

Parameters
- pos: Vector2
  
  Vector2 - Position of the Glyph
- glyph: Glyph
  
  Glyph - The Glyph to render
Returns void

fill

fill(v1: Vector2, v2: Vector2, glyph: Glyph): void

Inherited from BaseTerminal.fill
- Defined in terminal/terminal.ts:41
Parameters
- v1: Vector2
- v2: Vector2
- glyph: Glyph
Returns void

render

render(): void

- Defined in terminal/canvas-terminal.ts:92
Renders the display to the canvas. Usually drawn once per animation frame.

Returns void

size

size(): Vector2

Inherited from BaseTerminal.size
- Defined in terminal/terminal.ts:26
Returns Vector2

windowToTilePoint

windowToTilePoint(pixel: Vector2): Vector2

Overrides BaseTerminal.windowToTilePoint
- Defined in terminal/canvas-terminal.ts:125
Parameters
- pixel: Vector2
Returns Vector2

writeAt

writeAt(pos: Vector2, text: string, fore?: Color, back?: Color): void

Inherited from BaseTerminal.writeAt
- Defined in terminal/terminal.ts:49
Parameters
- pos: Vector2
- text: string
- Default value fore: Color = this.foreColor
- Default value back: Color = this.backColor
Returns void

Generated using TypeDoc