font

associates a ttf resource to a .fontc file.

const font_hash = hash("/assets/fonts/roboto.fontc");
const ttf_hash = hash("/assets/fonts/Roboto/Roboto-Bold.ttf");
font.add_font(font_hash, ttf_hash);

Parameters

• fontc: string | Hash — The path to the .fontc resource
• ttf: string | Hash — The path to the .ttf resource

associates a ttf resource to a .fontc file

const font_hash = hash("/assets/fonts/roboto.fontc");
const ttf_hash = hash("/assets/fonts/Roboto/Roboto-Bold.ttf");
font.remove_font(font_hash, ttf_hash);

Parameters

• fontc: string | Hash — The path to the .fontc resource
• ttf: string | Hash — The path to the .ttf resource

prepopulates the font glyph cache with rasterised glyphs

const font_hash = hash("/assets/fonts/roboto.fontc");
font.prewarm_text(font_hash, "Some text", (self, request_id, result, errstring) => {
  // cache is warm, show the text!
});

Parameters

• fontc: string | Hash — The path to the .fontc resource
• text: string — The text to layout
• callback?: function(self, request_id, result, errstring) — (optional) A callback function that is called after the request is finished

self object The current object. request_id number The request id result boolean True if request was succesful errstring string nil if the request was successful

Returns

• request_id: number — Returns the asynchronous request id

Gets information about a font, such as the associated font files

Parameters

• fontc: string | Hash — The path to the .fontc resource

Returns

• info: Record<string | number, unknown> — the information table contains these fields:

path hash The path hash of the current file. fonts

table An array of associated font (e.g. .ttf) files. Each item is a table that contains:

path string The path of the font file path_hash hash The path of the font file