CanvasRenderer | @kiswa/kilo

Recursive rendering utilizing HTML5 canvas.

Hierarchy

Renderer
- CanvasRenderer

Index

Constructors

constructor

Properties

Accessors

canvasElement

Methods

Constructors

constructor

new CanvasRenderer(width: number, height: number, container: HTMLElement): CanvasRenderer

Overrides Renderer.constructor
- Defined in renderer/canvas-renderer.ts:17
Initialize CanvasRenderer object.

Parameters
- width: number
  
  Width of the canvas in pixels.
- height: number
  
  Height of the canvas in pixels.
- container: HTMLElement
  
  The HTMLElement to add the canvas to.
Returns CanvasRenderer

Properties

Protected canvas

canvas: HTMLCanvasElement

Canvas element for rendering.

Protected container

container: HTMLElement

Containing element for the canvas.

Protected height

height: number

Height of the canvas in pixels.

Protected width

width: number

Width of the canvas in pixels.

Accessors

canvasElement

get canvasElement(): HTMLCanvasElement

Overrides Renderer.canvasElement
- Defined in renderer/canvas-renderer.ts:15
Returns HTMLCanvasElement

Methods

Protected isInCamera

isInCamera(entity: Sprite, camera: any): boolean

Inherited from Renderer.isInCamera
- Defined in renderer/renderer.ts:61
Determines if the provided entity is visible to the camera.

Parameters
- entity: Sprite
  
  Sprite to check for visibility.
- camera: any
  
  Camera to use when determining visibility.
Returns boolean

render

render(container: Container, clear?: boolean): void

Overrides Renderer.render
- Defined in renderer/canvas-renderer.ts:47
Recursive method for rendering the provided container and all its children.

Parameters
- container: Container
  
  Container object to render recursively.
- Default value clear: boolean = true
  
  Whether or not to clear the canvas before rendering.
Returns void