CanvasRenderer | DuckEngine

classdesc: Creates a DuckEngine CanvasRenderer
description: The CanvasRenderer Class. Renders everything using the RendererPipeline to pool what to draw
since: 2.1.0

Hierarchy

BaseRenderer
- CanvasRenderer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CanvasRenderer(game: Game, poolingInterval?: number): CanvasRenderer

Overrides BaseRenderer.constructor
- Defined in core/renderer/canvas/canvasRenderer.ts:40
description
Creates a CanvasRenderer instance

since
2.1.0

Parameters
- game: Game
  
  Game instance
- poolingInterval: number = ...
Returns CanvasRenderer

Properties

ctx

ctx: CanvasRenderingContext2D

memberof: CanvasRenderer
description: The Canvas rendering context
since: 2.1.0

game

game: Game

pipeline

pipeline: RendererPipeline

memberof: CanvasRenderer
description: The RenderingPipeline, handles and manages what needs to be drawn and updated
since: 2.1.0

Methods

clearFrame

clearFrame(): void

Overrides BaseRenderer.clearFrame
- Defined in core/renderer/canvas/canvasRenderer.ts:221
memberof
CanvasRenderer

description
Clears the screen

since
2.1.0

Returns void

clearRect

clearRect(x: number, y: number, w: number, h: number): void

- Defined in core/renderer/canvas/canvasRenderer.ts:240
memberof
CanvasRenderer

description
Clears an area

since
2.1.0

Parameters
- x: number
  
  X position
- y: number
  
  Y position
- w: number
  
  Width of area to clear
- h: number
  
  Height of area to clear
Returns void

drawCircle

drawCircle(x: number, y: number, r: number, color: string): void

Overrides BaseRenderer.drawCircle
- Defined in core/renderer/canvas/canvasRenderer.ts:268
memberof
CanvasRenderer

description
Fills a circle

since
2.1.0

Parameters
- x: number
  
  X position
- y: number
  
  Y position
- r: number
  
  Radius of circle
- color: string
  
  Color to fill circle with
Returns void

drawRect

drawRect(x: number, y: number, w: number, h: number, color: string): void

Overrides BaseRenderer.drawRect
- Defined in core/renderer/canvas/canvasRenderer.ts:254
memberof
CanvasRenderer

description
Fills a rectangle

since
2.1.0

Parameters
- x: number
  
  X position
- y: number
  
  Y position
- w: number
  
  Width of rect
- h: number
  
  Height of rect
- color: string
  
  Color to fill rect with
Returns void

drawRoundRect

drawRoundRect(x: number, y: number, w: number, h: number, r: number, color: string): void

Overrides BaseRenderer.drawRoundRect
- Defined in core/renderer/canvas/canvasRenderer.ts:287
memberof
CanvasRenderer

description
Fills a roundRect

since
2.1.0

Parameters
- x: number
  
  X position
- y: number
  
  Y position
- w: number
  
  Width of roundRect
- h: number
  
  Height of roundRect
- r: number
  
  Radius of roundRect
- color: string
  
  Color to fill roundRect with
Returns void

drawSprite

drawSprite(x: number, y: number, w: number, h: number, texture: TextureBase<"image">, currentRow?: number, currentCol?: number): void

Overrides BaseRenderer.drawSprite
- Defined in core/renderer/canvas/canvasRenderer.ts:320
memberof
CanvasRenderer

description
Draws a sprite

since
2.1.0

Parameters
- x: number
  
  X position
- y: number
  
  Y position
- w: number
  
  Width of roundRect
- h: number
  
  Height of roundRect
- texture: TextureBase<"image">
  
  Texture to use for the Sprite
- Optional currentRow: number
- Optional currentCol: number
Returns void

drawText

drawText(text: string, x: number, y: number, maxWidth?: number): void

Overrides BaseRenderer.drawText
- Defined in core/renderer/canvas/canvasRenderer.ts:199
memberof
CanvasRenderer

description
Draws text to the screen, must set font with this.setFont first and color with this.setFillColor

since
2.1.0

Parameters
- text: string
  
  Text to draw
- x: number
  
  X Position
- y: number
  
  Y Position
- Optional maxWidth: number
Returns void

measureText

measureText(font: string, text: string): TextMetrics

Overrides BaseRenderer.measureText
- Defined in core/renderer/canvas/canvasRenderer.ts:155
memberof
CanvasRenderer

description
Measures the text using the font

since
2.1.0

Parameters
- font: string
  
  Font to set to
- text: string
  
  Text measure
Returns TextMetrics

render

render(deltaTime: number): void

- Defined in core/renderer/canvas/canvasRenderer.ts:56
memberof
CanvasRenderer

description
Gets the poolStack from the pipeline and ticks, updates, and renders the scene and renderables

since
2.1.0

Parameters
- deltaTime: number
  
  Time passed since last frame
Returns void

restore

restore(): void

Overrides BaseRenderer.restore
- Defined in core/renderer/canvas/canvasRenderer.ts:89
memberof
CanvasRenderer

description
Calls this.ctx.restore

since
2.1.0

Returns void

save

save(): void

Overrides BaseRenderer.save
- Defined in core/renderer/canvas/canvasRenderer.ts:80
memberof
CanvasRenderer

description
Calls this.ctx.save

since
2.1.0

Returns void

scale

scale(x: number, y: number): void

Overrides BaseRenderer.scale
- Defined in core/renderer/canvas/canvasRenderer.ts:133
memberof
CanvasRenderer

description
Scales the canvas using this.ctx.scale

since
2.1.0

Parameters
- x: number
  
  X scale
- y: number
  
  Y scale
Returns void

setBlendMode

setBlendMode(blendMode: "color" | "multiply" | "source-over" | "source-in" | "source-out" | "source-atop" | "destination-over" | "destination-in" | "destination-out" | "destination-atop" | "lighter" | "copy" | "xor" | "screen" | "overlay" | "darken" | "lighten" | "color-dodge" | "color-burn" | "hard-light" | "soft-light" | "difference" | "exclusion" | "hue" | "saturation" | "luminosity"): void

Overrides BaseRenderer.setBlendMode
- Defined in core/renderer/canvas/canvasRenderer.ts:354
memberof
CanvasRenderer

description
Sets the blend mode / globalCompositionOperation

since
2.1.0

Parameters
- blendMode: "color" | "multiply" | "source-over" | "source-in" | "source-out" | "source-atop" | "destination-over" | "destination-in" | "destination-out" | "destination-atop" | "lighter" | "copy" | "xor" | "screen" | "overlay" | "darken" | "lighten" | "color-dodge" | "color-burn" | "hard-light" | "soft-light" | "difference" | "exclusion" | "hue" | "saturation" | "luminosity"
  
  Blend Mode
Returns void

setFillColor

setFillColor(color: string): void

Overrides BaseRenderer.setFillColor
- Defined in core/renderer/canvas/canvasRenderer.ts:166
memberof
CanvasRenderer

description
Sets the fillStyle using this.ctx.fillStyle =

since
2.1.0

Parameters
- color: string
  
  Color to set to
Returns void

setFont

setFont(font: string): void

Overrides BaseRenderer.setFont
- Defined in core/renderer/canvas/canvasRenderer.ts:143
memberof
CanvasRenderer

description
Sets the font using this.ctx.font =

since
2.1.0

Parameters
- font: string
  
  Font to set to
Returns void

setLineWidth

setLineWidth(width: number): void

Overrides BaseRenderer.setLineWidth
- Defined in core/renderer/canvas/canvasRenderer.ts:186
memberof
CanvasRenderer

description
Sets the lineWidth using this.ctx.lineWidth =

since
2.1.0

Parameters
- width: number
  
  Width to set as
Returns void

setStrokeColor

setStrokeColor(color: string): void

Overrides BaseRenderer.setStrokeColor
- Defined in core/renderer/canvas/canvasRenderer.ts:176
memberof
CanvasRenderer

description
Sets the strokeStyle using this.ctx.fillStyle =

since
2.1.0

Parameters
- color: string
  
  Color to set to
Returns void

strokeText

strokeText(text: string, x: number, y: number, maxWidth?: number): void

Overrides BaseRenderer.strokeText
- Defined in core/renderer/canvas/canvasRenderer.ts:212
memberof
CanvasRenderer

description
Strokes text to the screen, must set font with this.setFont first and color with this.setStrokeColor

since
2.1.0

Parameters
- text: string
  
  Text to draw
- x: number
  
  X Position
- y: number
  
  Y Position
- Optional maxWidth: number
Returns void

transform

transform(a: number, b: number, c: number, d: number, e: number, f: number): void

Overrides BaseRenderer.transform
- Defined in core/renderer/canvas/canvasRenderer.ts:115
memberof
CanvasRenderer

description
Transforms the canvas using this.ctx.transform

since
2.1.0

Parameters
- a: number
- b: number
- c: number
- d: number
- e: number
- f: number
Returns void

translate

translate(x: number, y: number): void

Overrides BaseRenderer.translate
- Defined in core/renderer/canvas/canvasRenderer.ts:100
memberof
CanvasRenderer

description
Calls this.ctx.translate

since
2.1.0

Parameters
- x: number
  
  X position
- y: number
  
  Y position
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

game: Game

poolingInterval: number = ...

Returns CanvasRenderer

Properties

ctx

game

pipeline

Methods

clearFrame

Returns void

clearRect

Parameters

x: number

y: number

w: number

h: number

Returns void

drawCircle

Parameters

x: number

y: number

r: number

color: string

Returns void

drawRect

Parameters

x: number

y: number

w: number

h: number

color: string

Returns void

drawRoundRect

Parameters

x: number

y: number

w: number

h: number

r: number

color: string

Returns void

drawSprite

Parameters

x: number

y: number

w: number

h: number

texture: TextureBase<"image">

Optional currentRow: number

Optional currentCol: number

Returns void

drawText

Parameters

text: string

x: number

y: number

Optional maxWidth: number

Returns void

measureText

Parameters

font: string

text: string

Returns TextMetrics

render

Parameters

deltaTime: number

Returns void

restore

Returns void

save

Returns void

scale