Html5Canvas

Defined in: src/renderers/Html5Canvas.ts:33

Flipnote renderer for the HTML5 2D canvas API

Implements

• CanvasInterface

Constructors

new Html5Canvas()

new Html5Canvas(parent, width, height, options): Html5Canvas

Defined in: src/renderers/Html5Canvas.ts:114

Parameters

Parameter	Type
parent	Element
width	number
height	number
options	Partial<Html5CanvasOptions>

Returns

Html5Canvas

Properties

defaultOptions

static defaultOptions: Html5CanvasOptions

Defined in: src/renderers/Html5Canvas.ts:35

---

note

note: BaseParser

Defined in: src/renderers/Html5Canvas.ts:53

Implementation of

CanvasInterface.note

---

canvas

canvas: HTMLCanvasElement

Defined in: src/renderers/Html5Canvas.ts:57

Canvas HTML element being used as a rendering surface

---

ctx

ctx: CanvasRenderingContext2D

Defined in: src/renderers/Html5Canvas.ts:61

Rendering context

---

width

width: number

Defined in: src/renderers/Html5Canvas.ts:65

View width (CSS pixels)

Implementation of

CanvasInterface.width

---

height

height: number

Defined in: src/renderers/Html5Canvas.ts:69

View height (CSS pixels)

Implementation of

CanvasInterface.height

---

dstWidth

dstWidth: number

Defined in: src/renderers/Html5Canvas.ts:74

Backing canvas width (real pixels) Note that this factors in device pixel ratio, so it may not reflect the size of the canvas in CSS pixels

Implementation of

CanvasInterface.dstWidth

---

dstHeight

dstHeight: number

Defined in: src/renderers/Html5Canvas.ts:79

Backing canvas height (real pixels) Note that this factors in device pixel ratio, so it may not reflect the size of the canvas in CSS pixels

Implementation of

CanvasInterface.dstHeight

---

srcWidth

srcWidth: number

Defined in: src/renderers/Html5Canvas.ts:83

Implementation of

CanvasInterface.srcWidth

---

srcHeight

srcHeight: number

Defined in: src/renderers/Html5Canvas.ts:87

Implementation of

CanvasInterface.srcHeight

---

frameIndex

frameIndex: number

Defined in: src/renderers/Html5Canvas.ts:91

Implementation of

CanvasInterface.frameIndex

---

supportedStereoscopeModes

supportedStereoscopeModes: CanvasStereoscopicMode[]

Defined in: src/renderers/Html5Canvas.ts:95

Implementation of

CanvasInterface.supportedStereoscopeModes

---

stereoscopeMode

stereoscopeMode: CanvasStereoscopicMode = CanvasStereoscopicMode.None

Defined in: src/renderers/Html5Canvas.ts:101

Implementation of

CanvasInterface.stereoscopeMode

---

stereoscopeStrength

stereoscopeStrength: number = 0

Defined in: src/renderers/Html5Canvas.ts:105

Implementation of

CanvasInterface.stereoscopeStrength

Methods

isSupported()

static isSupported(): boolean

Defined in: src/renderers/Html5Canvas.ts:40

Returns

boolean

---

setCanvasSize()

setCanvasSize(width, height): void

Defined in: src/renderers/Html5Canvas.ts:136

Resize the canvas surface

Parameters

Parameter	Type	Description
width	number	New canvas width, in CSS pixels
height	number	New canvas height, in CSS pixels The ratio between width and height should be 3:4 for best results

Returns

void

Implementation of

CanvasInterface.setCanvasSize

---

setNote()

setNote(note): void

Defined in: src/renderers/Html5Canvas.ts:154

Parameters

Parameter	Type
note	BaseParser

Returns

void

Implementation of

CanvasInterface.setNote

---

clear()

clear(color?): void

Defined in: src/renderers/Html5Canvas.ts:175

Clear the canvas

Parameters

Parameter	Type	Description
color?	[number, number, number, number]	optional RGBA color to use as a background color

Returns

void

Implementation of

CanvasInterface.clear

---

drawFrame()

drawFrame(frameIndex): void

Defined in: src/renderers/Html5Canvas.ts:188

Parameters

Parameter	Type
frameIndex	number

Returns

void

Implementation of

CanvasInterface.drawFrame

---

requestStereoScopeMode()

requestStereoScopeMode(mode): void

Defined in: src/renderers/Html5Canvas.ts:211

Parameters

Parameter	Type
mode	CanvasStereoscopicMode

Returns

void

Implementation of

CanvasInterface.requestStereoScopeMode

---

forceUpdate()

forceUpdate(): void

Defined in: src/renderers/Html5Canvas.ts:219

Returns

void

Implementation of

CanvasInterface.forceUpdate

---

getDataUrl()

getDataUrl(type?, quality?): string

Defined in: src/renderers/Html5Canvas.ts:224

Parameters

Parameter	Type
type?	string
quality?	any

Returns

string

Implementation of

CanvasInterface.getDataUrl

---

getBlob()

getBlob(type?, quality?): Promise<Blob>

Defined in: src/renderers/Html5Canvas.ts:228

Parameters

Parameter	Type
type?	string
quality?	any

Returns

Promise<Blob>

Implementation of

CanvasInterface.getBlob

---

destroy()

destroy(): void

Defined in: src/renderers/Html5Canvas.ts:232

Returns

void

Implementation of

CanvasInterface.destroy