handle2 methods, 1 field
A font face produced by bytes:font() or datumhue.font.builtin(). Set it as a text surface's font, as datumhue.font.default, or a fallback via datumhue.font.fallback. bytes:font() checks the bytes before it returns, so the face is ready at once.
datumhue.font.builtin, Bytes:font, datumhue.font.defaultdatumhue.font.fallback, UiElement:update, UiElement:label, datumhue.font.defaultThe examples on this page start from:
local face = datumhue.font.builtin()| Field | Type | Access | Description |
|---|---|---|---|
state | ReadyState | read-only | Completion state of this operation. Reading it never raises or suspends; a failed operation's error surfaces at :ready(). |
Font:ready() -> FontWait until this asset is fully loaded, then return it for chaining. An in-memory asset returns at once; one still loading (a file read or remote fetch) yields the coroutine until it lands. A load failure raises; format errors on playable assets still surface at use time.
Font:metrics(size: number | string) -> font.MetricsVertical metrics of this face at size — a number (px) or a unit string like "1.5rem"/"50vw" — as text set in it is laid out. Use them to align text baselines with other drawing, or to size rows before laying text out.
-- A size in px, or with a unit; the metrics come back in px.
local m = face:metrics(20)
print(m.ascent, m.descent, m.line_height) --> 22.0 5.0 24.0
local large = face:metrics("2rem")
print(large.line_height) --> 48.0returns font.Metrics record 3 keys
| Key | Type | Description |
|---|---|---|
| ascent | number | Baseline to the top of the em box, in pixels. |
| descent | number | Baseline to the bottom of the em box, in pixels (a positive distance downward). |
| line_height | number | Vertical advance between consecutive baselines, in pixels. |