Class CanvasTextRenderer

Hierarchy

TextRenderer<CanvasTextRendererState>
- CanvasTextRenderer

Constructors

constructor

new CanvasTextRenderer(stage): CanvasTextRenderer
Parameters
- stage: Stage
Returns CanvasTextRenderer
Overrides TextRenderer<CanvasTextRendererState>.constructor
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:94

Properties

`Protected`canvas

canvas: OffscreenCanvas | HTMLCanvasElement

`Protected`context

context: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D

`Readonly`set

set: Readonly<TrPropSetters<CanvasTextRendererState>>

`Protected`stage

stage: Stage

type

type: "canvas" | "sdf" = 'canvas'

Methods

addFontFace

addFontFace(fontFace): void
Called by the TrFontManager to add a font face to the renderer's font registry.
Parameters
- fontFace: TrFontFace
Returns void
Remarks
This method MUST ONLY be called for a fontFace that previously passed the isFontFaceSupported check.
Overrides TextRenderer.addFontFace
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:239

calculateRenderInfo

calculateRenderInfo(state): RenderInfo
Parameters
- state: CanvasTextRendererState
Returns RenderInfo
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:411

canRenderFont

canRenderFont(props): boolean
Given text renderer properties (particularly the specific properties related to font selection) returns whether or not the renderer can render it.
Parameters
- props: TrFontProps
Returns boolean
Overrides TextRenderer.canRenderFont
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:228

createState

createState(props, node): CanvasTextRendererState
Parameters
- props: TrProps
- node: CoreTextNode
Returns CanvasTextRendererState
Overrides TextRenderer.createState
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:263

destroyState

destroyState(state): void
Destroy/Clean up the state object
Parameters
- state: CanvasTextRendererState
Returns void
Remarks
Opposite of createState(). Frees any event listeners / resources held by the state that may not reliably get garbage collected.
Overrides TextRenderer.destroyState
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:450

getPropertySetters

getPropertySetters(): Partial<TrPropSetters<CanvasTextRendererState>>
Called by constructor to get a map of property setter functions for this renderer.

Returns Partial<TrPropSetters<CanvasTextRendererState>>
Overrides TextRenderer.getPropertySetters
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:128

isFontFaceSupported

isFontFaceSupported(fontFace): boolean
Called by the TrFontManager to find out if a newly added font face is supported by this renderer.
Parameters
- fontFace: TrFontFace
Returns boolean
Overrides TextRenderer.isFontFaceSupported
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:235

loadFont

loadFont(state): void
Parameters
- state: CanvasTextRendererState
Returns void
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:386

renderQuads

renderQuads(): void
Returns void
Overrides TextRenderer.renderQuads
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:444

renderSingleCanvasPage

renderSingleCanvasPage(state): void
Parameters
- state: CanvasTextRendererState
Returns void
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:336

scheduleUpdateState

scheduleUpdateState(state): void
Schedule a state update via queueMicrotask
Parameters
- state: CanvasTextRendererState
Returns void
Remarks
This method is used to schedule a state update via queueMicrotask. This method should be called whenever a state update is needed, and it will ensure that the state is only updated once per microtask.
Inherited from TextRenderer.scheduleUpdateState
- Defined in src/core/text-rendering/renderers/TextRenderer.ts:532

setIsRenderable

setIsRenderable(state, renderable): void
Allows the CoreTextNode to communicate changes to the isRenderable state of the itself.
Parameters
- state: CanvasTextRendererState
- renderable: boolean
Returns void
Inherited from TextRenderer.setIsRenderable
- Defined in src/core/text-rendering/renderers/TextRenderer.ts:470

setStatus

setStatus(state, status, error?): void
Parameters
- state: CanvasTextRendererState
- status:
      | "loaded"
      | "failed"
      | "loading"
      | "initialState"
      | "destroyed"
- Optionalerror: Error
Returns void
Inherited from TextRenderer.setStatus
- Defined in src/core/text-rendering/renderers/TextRenderer.ts:454

updateState

updateState(state): void
Parameters
- state: CanvasTextRendererState
Returns void
Overrides TextRenderer.updateState
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:296

Class CanvasTextRenderer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CanvasTextRenderer

Properties

Protectedcanvas

Protectedcontext

Readonlyset

Protectedstage

type

Methods

addFontFace

Parameters

Returns void

Remarks

calculateRenderInfo

Parameters

Returns RenderInfo

canRenderFont

Parameters

Returns boolean

createState

Parameters

Returns CanvasTextRendererState

destroyState

Parameters

Returns void

Remarks

getPropertySetters

Returns Partial<TrPropSetters<CanvasTextRendererState>>

isFontFaceSupported

Parameters

Returns boolean

loadFont

Parameters

Returns void

renderQuads

Returns void

renderSingleCanvasPage

Parameters

Returns void

scheduleUpdateState

Parameters

Returns void

Remarks

setIsRenderable

Parameters

Returns void

setStatus

Parameters

Returns void

updateState

Parameters

Returns void

Settings

On This Page

`Protected`canvas

`Protected`context

`Readonly`set

`Protected`stage