UWAL / MSDFFont

Type Aliases

Kernings

type Kernings = Map<number, Map<number, number>>;

Type Parameters

Type Parameter

Interfaces

Char

Properties

c

c: number;

x

x: number;

y

y: number;

id

id: number;

char

char: string;

chnl

chnl: number;

page

page: number;

index

index: number;

width

width: number;

height

height: number;

xoffset

xoffset: number;

yoffset

yoffset: number;

xadvance

xadvance: number;

---

Common

Properties

base

base: number;

redChnl

redChnl: number;

greenChnl

greenChnl: number;

blueChnl

blueChnl: number;

alphaChnl

alphaChnl: number;

lineHeight

lineHeight: number;

scaleW

scaleW: number;

scaleH

scaleH: number;

packed

packed: number;

pages

pages: number;

---

Kerning

Properties

first

first: number;

second

second: number;

amount

amount: number;

---

Font

Properties

chars

chars: Char[];

common

common: Common;

pages

pages: string[];

kernings?

optional kernings?: Kerning[];

Classes

MSDFFont

An MSDF font management class, mostly for internal usage.

Constructors

Constructor

new MSDFFont(label?, generated?): MSDFFont;

Parameters

Parameter	Type	Default value	Description
label?	string	"MSDFFont"	Name of the font
generated?	boolean	false	Whether the font was generated with this tool

Returns

MSDFFont

Methods

GetBindGroupLayoutEntries()

static GetBindGroupLayoutEntries(Renderer): BindGroupLayoutEntry[];

Create layout entries for the text bind group layout.

Parameters

Parameter	Type	Description
Renderer	RenderStage	Renderer instance to create layout entries

Returns

BindGroupLayoutEntry[]

GetCharacter()

GetCharacter(code): Char;

Get character information when measuring the text.

Parameters

Parameter	Type	Description
code	number	Character code to get info about

Returns

Char

CreateBindGroupResources()

CreateBindGroupResources(
   Pipeline, 
   url, 
requestOptions?): Promise<Record<string, GPUBindingResource>>;

Load and parse the font from a URL and save its character info into a storage buffer.

Parameters

Parameter	Type	Description
Pipeline	RenderPipelineInstance	Text pipeline
url	string	URL to load the font from
requestOptions?	RequestInit	Optional fetch request options

Returns

Promise<Record<string, GPUBindingResource>>

GetXAdvance()

GetXAdvance(code, nextCode?): number;

Get the distance in pixels a line should advance for a given character. If the next character is given, any kerning between the two characters will be taken into account.

Parameters

Parameter	Type	Default value	Description
code	number	undefined	Code of the character to advance
nextCode?	number	-1	Code of the next character

Returns

number

Destroy()

Destroy(): undefined;

Destroy font and page textures.

Returns

undefined

Accessors

BindGroupResources

Get Signature

get BindGroupResources(): Record<string, GPUBindingResource>;

Returns

Record<string, GPUBindingResource>

Font bind group resources.

LineHeight

Get Signature

get LineHeight(): number;

Returns

number

Line height defined by the font.

Generated

Get Signature

get Generated(): boolean;

Returns

boolean

Whether the font was generated with this tool.