Skip to content

Documentation / scene / FontAsset

Class: FontAsset ​

Defined in: libs/scene/src/text/font/font_asset.ts:89

Minimal runtime font asset for TrueType outlines.

Accessors ​

metrics ​

Get Signature ​

get metrics(): FontMetrics

Defined in: libs/scene/src/text/font/font_asset.ts:159

Returns ​

FontMetrics


msdfAtlasSettings ​

Get Signature ​

get msdfAtlasSettings(): FontAssetMSDFAtlasSettings

Defined in: libs/scene/src/text/font/font_asset.ts:162

Returns ​

FontAssetMSDFAtlasSettings


msdfAtlasPageSize ​

Get Signature ​

get msdfAtlasPageSize(): number

Defined in: libs/scene/src/text/font/font_asset.ts:165

Returns ​

number


msdfGlyphSize ​

Get Signature ​

get msdfGlyphSize(): number

Defined in: libs/scene/src/text/font/font_asset.ts:168

Returns ​

number

Methods ​

fromBuffer() ​

static fromBuffer(buffer, options?): FontAsset

Defined in: libs/scene/src/text/font/font_asset.ts:156

Parameters ​

buffer ​

ArrayBuffer

options? ​

FontAssetFetchOptions

Returns ​

FontAsset


getGlyphIndex() ​

getGlyphIndex(codePoint): number

Defined in: libs/scene/src/text/font/font_asset.ts:171

Parameters ​

codePoint ​

number

Returns ​

number


getKerning() ​

getKerning(leftGlyphIndex, rightGlyphIndex): number

Defined in: libs/scene/src/text/font/font_asset.ts:183

Parameters ​

leftGlyphIndex ​

number

rightGlyphIndex ​

number

Returns ​

number


getPairAdjustment() ​

getPairAdjustment(leftGlyphIndex, rightGlyphIndex): PairAdjustment

Defined in: libs/scene/src/text/font/font_asset.ts:190

Parameters ​

leftGlyphIndex ​

number

rightGlyphIndex ​

number

Returns ​

PairAdjustment


getGlyph() ​

getGlyph(glyphIndex): GlyphData

Defined in: libs/scene/src/text/font/font_asset.ts:193

Parameters ​

glyphIndex ​

number

Returns ​

GlyphData

Released under the MIT License.