Class SdfTextRenderer

Singleton class for rendering text using signed distance fields.

Remarks

SdfTextRenderer supports both single-channel and multi-channel signed distance fields.

Hierarchy

TextRenderer<SdfTextRendererState>
- SdfTextRenderer

Constructors

constructor

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

Properties

`Private` fontFamilyArray

fontFamilyArray: FontFamilyMap[] = ...

`Private` msdfFontFamilies

msdfFontFamilies: FontFamilyMap = {}

`Private` rendererBounds

rendererBounds: Bound

`Private` sdfShader

sdfShader: SdfShader

`Readonly` set

set: Readonly<TrPropSetters<SdfTextRendererState>>

`Private` ssdfFontFamilies

ssdfFontFamilies: FontFamilyMap = {}

Map of font family names to a set of font faces.

`Protected` stage

stage: Stage

type

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

Methods

addFontFace

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

canRenderFont

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

createState

createState(props): SdfTextRendererState
Parameters
- props: TrProps
Returns SdfTextRendererState
Overrides TextRenderer.createState
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:326

destroyState

destroyState(state): void
Parameters
- state: SdfTextRendererState
Returns void
Overrides TextRenderer.destroyState
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:786

getPropertySetters

getPropertySetters(): Partial<TrPropSetters<SdfTextRendererState>>
Returns Partial<TrPropSetters<SdfTextRendererState>>
Overrides TextRenderer.getPropertySetters
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:159

`Protected` invalidateLayoutCache

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

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

isFontFaceSupported

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

`Protected` releaseFontFace

releaseFontFace(state): void
Release the loaded SDF font face
Parameters
- state: SdfTextRendererState
Returns void
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:804

renderQuads

renderQuads(state, transform, clippingRect, alpha, parentHasRenderTexture, framebufferDimensions): void
Parameters
- state: SdfTextRendererState
- transform: Matrix3d
- clippingRect: Readonly<RectWithValid>
- alpha: number
- parentHasRenderTexture: boolean
- framebufferDimensions: Dimensions
Returns void
Overrides TextRenderer.renderQuads
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:597

resolveFontFace

resolveFontFace(props): undefined | SdfTrFontFace<SdfFontType>
Parameters
- props: TrFontProps
Returns undefined | SdfTrFontFace<SdfFontType>
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:793

scheduleUpdateState

scheduleUpdateState(state): void
Schedule a state update via queueMicrotask
Parameters
- state: SdfTextRendererState
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

`Protected` setElementBoundsX

setElementBoundsX(state): void
Parameters
- state: SdfTextRendererState
Returns void
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:831

`Protected` setElementBoundsY

setElementBoundsY(state): void
Parameters
- state: SdfTextRendererState
Returns void
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:838

setIsRenderable

setIsRenderable(state, renderable): void
Parameters
- state: SdfTextRendererState
- renderable: boolean
Returns void
Overrides TextRenderer.setIsRenderable
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:778

setStatus

setStatus(state, status, error?): void
Parameters
- state: SdfTextRendererState
- 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: SdfTextRendererState
Returns void
Overrides TextRenderer.updateState
- Defined in src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts:388

Class SdfTextRenderer

Remarks

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stage: Stage

Returns SdfTextRenderer

Properties

Private fontFamilyArray

Private msdfFontFamilies

Private rendererBounds

Private sdfShader

Readonly set

Private ssdfFontFamilies

Protected stage

type

Methods

addFontFace

Parameters

fontFace: TrFontFace

Returns void

canRenderFont

Parameters

props: TrFontProps

Returns boolean

createState

Parameters

props: TrProps

Returns SdfTextRendererState

destroyState

Parameters

state: SdfTextRendererState

Returns void

getPropertySetters

Returns Partial<TrPropSetters<SdfTextRendererState>>

Protected invalidateLayoutCache

Parameters

state: SdfTextRendererState

Returns void

Remarks

isFontFaceSupported

Parameters

fontFace: TrFontFace

Returns boolean

Protected releaseFontFace

Parameters

state: SdfTextRendererState

Returns void

renderQuads

Parameters

state: SdfTextRendererState

transform: Matrix3d

clippingRect: Readonly<RectWithValid>

alpha: number

parentHasRenderTexture: boolean

framebufferDimensions: Dimensions

Returns void

resolveFontFace

Parameters

props: TrFontProps

Returns undefined | SdfTrFontFace<SdfFontType>

scheduleUpdateState

Parameters

state: SdfTextRendererState

Returns void

Remarks

Protected setElementBoundsX

Parameters

state: SdfTextRendererState

Returns void

Protected setElementBoundsY

Parameters

state: SdfTextRendererState

Returns void

setIsRenderable

`Private` fontFamilyArray

`Private` msdfFontFamilies

`Private` rendererBounds

`Private` sdfShader

`Readonly` set

`Private` ssdfFontFamilies

`Protected` stage

`Protected` invalidateLayoutCache

`Protected` releaseFontFace

`Protected` setElementBoundsX

`Protected` setElementBoundsY

`Optional` error: Error