UWAL / MSDFFont

Classes

MSDFFont

MSDF font management class, designed exclusively for internal usage.

Constructors

Constructor

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

Parameters

Parameter	Type	Default value	Description
label?	string	"MSDFFont"	Font label.
generated?	boolean	false	Whether the font was generated here.

Returns

MSDFFont

Methods

GetBindGroupLayoutEntries()

static GetBindGroupLayoutEntries(Renderer): BindGroupLayoutEntry[];

Create font layout entries for the MSDFText pipeline layout.

Parameters

Parameter	Type	Description
Renderer	RenderStage	Renderer instance to create layout entries.

Returns

BindGroupLayoutEntry[]

GetCharacter()

GetCharacter(code): Char;

Get character information by its code.

Parameters

Parameter	Type	Description
code	number	Character code.

Returns

Char

GetXAdvance()

GetXAdvance(code, nextCode?): number;

Get the distance in pixels the cursor 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	Character code.
nextCode?	number	-1	Next character code.

Returns

number

CreateBindGroupResources()

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

Load and parse a font from a valid source file and save its characters info into a storage buffer.

Parameters

Parameter	Type	Description
Pipeline	RenderPipelineInstance	MSDFText pipeline.
url	string	Font source path.
requestOptions?	RequestInit	fetch request options.

Returns

Promise<Record<string, GPUBindingResource>>

Destroy()

Destroy(): void;

Destroy all page textures.

Returns

void

Accessors

BindGroupResources

Get Signature

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

Throws

ERROR.FONT_RESOURCES_NOT_FOUND if the font has not yet been loaded with MSDFText.LoadFont.

Returns

Record<string, GPUBindingResource>

Font bind group resources.

LineHeight

Get Signature

get LineHeight(): number;

Returns

number

Font line height.

Generated

Get Signature

get Generated(): boolean;

Returns

boolean

Whether the font was generated here.