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:95

Properties

`Protected` canvas

canvas: OffscreenCanvas | HTMLCanvasElement

`Protected` context

context: CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D

`Private` fontFamilies

fontFamilies: FontFamilyMap = {}

Font family map used to store web font faces that were added to the canvas text renderer.

`Private` fontFamilyArray

fontFamilyArray: FontFamilyMap[] = ...

`Readonly` set

set: Readonly<TrPropSetters<CanvasTextRendererState>>

`Protected` stage

stage: Stage

type

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

Methods

addFontFace

addFontFace(fontFace): void
Parameters
- fontFace: TrFontFace
Returns void
Overrides TextRenderer.addFontFace
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:240

calculateRenderInfo

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

canRenderFont

canRenderFont(props): boolean
Parameters
- props: TrFontProps
Returns boolean
Overrides TextRenderer.canRenderFont
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:229

createState

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

destroyState

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

getPropertySetters

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

`Private` invalidateLayoutCache

invalidateLayoutCache(state): void
Invalidate the layout cache stored in the state. This will cause the text to be re-rendered on the next update.
Parameters
- state: CanvasTextRendererState
Returns void

Remarks
This also invalidates the visible window cache.
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:470

isFontFaceSupported

isFontFaceSupported(fontFace): boolean
Parameters
- fontFace: TrFontFace
Returns boolean
Overrides TextRenderer.isFontFaceSupported
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:236

loadFont

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

`Private` onFontLoadError

onFontLoadError(state, cssString, error): void
Parameters
- state: CanvasTextRendererState
- cssString: string
- error: Error
Returns void
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:487

`Private` onFontLoaded

onFontLoaded(state, cssString): void
Parameters
- state: CanvasTextRendererState
- cssString: string
Returns void
- Defined in src/core/text-rendering/renderers/CanvasTextRenderer.ts:476

renderQuads

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

renderSingleCanvasPage

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

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"
- Optional error: 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:299

Class CanvasTextRenderer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stage: Stage

Returns CanvasTextRenderer

Properties

Protected canvas

Protected context

Private fontFamilies

Private fontFamilyArray

Readonly set

Protected stage

type

Methods

addFontFace

Parameters

fontFace: TrFontFace

Returns void

calculateRenderInfo

Parameters

state: CanvasTextRendererState

Returns RenderInfo

canRenderFont

Parameters

props: TrFontProps

Returns boolean

createState

Parameters

props: TrProps

node: CoreTextNode

Returns CanvasTextRendererState

destroyState

Parameters

state: CanvasTextRendererState

Returns void

getPropertySetters

Returns Partial<TrPropSetters<CanvasTextRendererState>>

Private invalidateLayoutCache

Parameters

state: CanvasTextRendererState

Returns void

Remarks

isFontFaceSupported

Parameters

fontFace: TrFontFace

Returns boolean

loadFont

Parameters

state: CanvasTextRendererState

Returns void

Private onFontLoadError

Parameters

state: CanvasTextRendererState

cssString: string

error: Error

Returns void

Private onFontLoaded

Parameters

state: CanvasTextRendererState

cssString: string

Returns void

renderQuads

Returns void

renderSingleCanvasPage

Parameters

state: CanvasTextRendererState

Returns void

scheduleUpdateState

Parameters

state: CanvasTextRendererState

Returns void

Remarks

setIsRenderable

Parameters

`Protected` canvas

`Protected` context

`Private` fontFamilies

`Private` fontFamilyArray

`Readonly` set

`Protected` stage

`Private` invalidateLayoutCache

`Private` onFontLoadError

`Private` onFontLoaded

`Optional` error: Error