GlyphPreload

Defined in: sdk/src/ui/text/glyph-preload.ts:22

File

core-ui.ts

Brief

The stable UI surface promoted into the top-level esengine namespace (text, UINode box visuals, interaction, layout, theme).

This is the curated public UI API. The complete UI module surface — which also includes low-level text/atlas internals and engine-internal composition glue (e.g. EntityStateMap, ensureComponent) — lives in ./ui and is imported module-directly by the SDK code that needs it. Those internals are intentionally NOT re-exported here, so the public esengine namespace stays a stable, intentional surface.

Re-exported wholesale by core.ts.

Properties

done

readonly done: Promise<void>

Defined in: sdk/src/ui/text/glyph-preload.ts:26

Resolves when every character is on the atlas, or the preload was released first.

---

progress

readonly progress: number

Defined in: sdk/src/ui/text/glyph-preload.ts:24

Characters done over characters asked for, 0 to 1.

Methods

release()

release(): void

Defined in: sdk/src/ui/text/glyph-preload.ts:32

Stop, if it has not finished, and let the atlas pages go. Preloaded glyphs keep their pages until this is called, since a page no text is showing is otherwise released at the next frame: call it when the chapter they were for is over. Text showing them keeps what it uses.

Returns

void