fix(font-atlas): give glyphs that find no room a cell when the next frame begins, evicting the least recently drawn
The atlas packed glyphs onto shelves and never gave a place back (#55). Once its 1024x1024 image was full, EnsureAndGet returned nullptr for each new glyph before caching anything, so every new string holding one rasterised it again, and ShapeText dropped it together with its advance: the rest of the line closed up over the gap, and stayed that way. FontAtlas - A glyph is measured, not rasterised, until it gets a cell. One that finds no free room keeps its advance and box and draws blank for a frame. EnsureAndGet always returns the glyph, now a reference; Glyph::Resident() says whether it has a cell, Glyph::handle which one (slot and generation). - Evictions wait for the next frame: its first EnsureAndGet, Touch or Update places the glyphs that waited, once every glyph the frame before drew has been marked. Evicting while a frame is still asking for glyphs took ones it drew further down, which then took others in turn: a page switched back to could rasterise most of itself again rather than what it was missing, and on the DOM backend an over-full view could do so every frame. - A glyph keeps its cell for framesInFlight + 1 frames after it was drawn. The frame loop waits frame u's fence at the start of frame u + framesInFlight, but Device::frameCounter reads that from the end of the frame before, and input callbacks and onBeforeUpdate run in between. - FontAtlas::Packer places glyphs. Until the rows run out it fills shelves exactly as before. Then a glyph takes the same columns of one shelf at least as tall, or of several in a row as tall together, the free rows below the last shelf counting as one more: free texels, and, when the frame begins, glyphs nothing in flight draws, the least recently drawn first. A glyph spanning shelves lets in one taller than every shelf, and a few glyphs drawn every frame pin only their columns. Merging whole shelves instead, tried first, left a random workload without room for a glyph while a median 43% of the atlas was in flight; spanning, at 65%. - A box that found no room in a frame is remembered, with every box at least as big, as a small set per mode, until the frame ends or (without eviction) something is evicted: a saturated atlas no longer searches every shelf for each of its missing glyphs. - An evicted glyph is forgotten, and its texels are zeroed and uploaded with the glyph that takes its place: a neighbour's filtering at its edge must read padding or zero, not a stale glyph. - Touch(handles) marks every glyph whose handle still holds its cell, and says whether all did. InvalidateFont(font) forgets the font's glyphs and those waiting for a cell, whose Font* the next frame would read. The glyph index is looked up at rasterisation, so a Font replaced in place never gets one past its glyphs. GlyphsRasterized() counts, for tests. UIRenderer - A shaped run keeps a handle per glyph it draws. A hit touches them all, so the atlas keeps what is drawn every frame, and shapes the run again when one was evicted or one had no room. A glyph without room draws blank but advances the pen. - InvalidateFont clears the atlas's glyphs of the font too, as its comment and AGENTS.md always said it did. - Record calls the atlas's Update before onBuild, every frame, so the waiting glyphs are placed and uploaded first. Dispatch uploads the atlas before any kernel, a Tier 1 one sampling FontAtlasImageSlot() included: a glyph placed earlier in onBuild can sit in a cell another glyph had. DispatchText and DispatchFused no longer do it themselves. Device, Window (DOM) - Device::frameCounter and Device::framesInFlight exist on the DOM backend too, the counter bumped at the end of Window::Render, with one frame in flight: a frame's writeTexture lands before that frame's submit but after every earlier one. HelloUI - One set of item buffers and slots per frame in flight, by frameIdx. A frame still on the GPU read the items the next frame's onBuild was rewriting; with cells changing hands, those can name cells it drew other glyphs in. Tests - FontAtlasPacker: the packer with made-up boxes and no device: the fill order, least recently drawn first, framesInFlight + 1 frames held, nothing without evict, wide glyphs, tall glyphs spanning shelves and the free rows, Touch past a stale handle, stale handles, dirty spans, and the invariants over a random workload placed the way the atlas places. - FontAtlasEviction: fills the atlas through ShapeText frame by frame. The line that no longer fits keeps its advance and its glyphs' places; its missing glyphs aren't rasterised while nothing can go; when only line 0 is cold, only its glyphs give way; a frame's own misses evict nothing in it; a frame later the line and twenty more are whole, pixel for pixel, line 0 losing a larger share than the glyphs drawn after it; a stale cached run is shaped again; no stale texel is left; InvalidateFont reaches the atlas. Against master, with its two calls to the new API stubbed out, an earlier version failed ten checks. - UIDispatchAtlasFlush: a custom ui.Dispatch after ShapeText leaves the atlas uploaded. Needs a compositor. - ShapeTextCache: a hit rasterises nothing; after InvalidateFont the re-shaped run draws the same, from new cells. Docs - README and AGENTS.consumer.md: the atlas's eviction, the frame a glyph waits, shaping text every frame into per-frame item buffers, InvalidateFont, EnsureAndGet's signature and Lookup's lifetime, and that the atlas, like the deletion queue, assumes one rendering window and evicts nothing without one. - AGENTS.md: FontAtlas::Packer among the pure-logic helpers, eviction without a Window, and InvalidateFont. Breaking: FontAtlas::EnsureAndGet returns const Glyph& and never fails; check Glyph::Resident() before drawing from its UVs. FontAtlas::Touch is no longer noexcept. A GlyphItem is good for the frame it was shaped for, once the atlas has filled up, and item buffers must be per frame. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
578a3c6dc4
commit
a4be6f1a9c
17 changed files with 1632 additions and 187 deletions
38
project.cpp
38
project.cpp
|
|
@ -408,6 +408,18 @@ extern "C" Configuration CrafterBuildProject(std::span<const std::string_view> a
|
|||
parityTest.config.files.emplace_back(fs::path("examples/HelloUI/font.ttf"));
|
||||
cfg.tests.push_back(std::move(parityTest));
|
||||
|
||||
// Issue #55: a glyph ShapeText places may take a cell another
|
||||
// glyph had, so every kernel UIRenderer dispatches uploads the font
|
||||
// atlas first, a Tier 1 one through ui.Dispatch included. Shapes
|
||||
// new glyphs in onBuild and checks the atlas is clean after a
|
||||
// custom ui.Dispatch. Loads the UI kernels like UIFallbackParity.
|
||||
// Needs the Wayland backend + a real compositor.
|
||||
Test atlasFlushTest = LibraryTest("UIDispatchAtlasFlush");
|
||||
atlasFlushTest.config.shaders = cfg.shaders;
|
||||
atlasFlushTest.config.buildFiles = cfg.buildFiles;
|
||||
atlasFlushTest.config.files.emplace_back(fs::path("examples/HelloUI/font.ttf"));
|
||||
cfg.tests.push_back(std::move(atlasFlushTest));
|
||||
|
||||
// Issue #160: a swapchain has as many images as its present mode
|
||||
// needs, and the frame loop takes any count. Every offered mode
|
||||
// is kept (no fallback to FIFO), and every frame presents what it
|
||||
|
|
@ -538,10 +550,19 @@ extern "C" Configuration CrafterBuildProject(std::span<const std::string_view> a
|
|||
// text on both backends).
|
||||
cfg.tests.push_back(LibraryTest("FontAtlasDirtyRect"));
|
||||
|
||||
// Issue #55: FontAtlas::Packer, the atlas's shelves and its evictions
|
||||
// once full: the fill order, least recently used first, never a glyph
|
||||
// a frame in flight may sample, nothing without `evict`, a glyph taller
|
||||
// than every shelf spanning several (and the free rows below), Touch
|
||||
// past a stale handle, dirty spans over everything it hands out or
|
||||
// clears, and the invariants over a random workload. Pure CPU, with
|
||||
// made-up boxes: no GPU device at runtime.
|
||||
cfg.tests.push_back(LibraryTest("FontAtlasPacker"));
|
||||
|
||||
// Issue #52: shaped-run cache for UIRenderer::ShapeText. Shapes a
|
||||
// string against a real CPU-side FontAtlas and asserts that a cache
|
||||
// hit is byte-equivalent to the uncached path, that hits don't touch
|
||||
// the atlas, and that translate / alignment / truncation /
|
||||
// hit is byte-equivalent to the uncached path, that hits rasterise
|
||||
// nothing into the atlas, and that translate / alignment / truncation /
|
||||
// InvalidateFont all behave. Needs a headless Vulkan device (the
|
||||
// atlas image is a real GPU image) but no swapchain — same native
|
||||
// build settings as the others. The font file is copied next to the
|
||||
|
|
@ -550,6 +571,19 @@ extern "C" Configuration CrafterBuildProject(std::span<const std::string_view> a
|
|||
textTest.config.files = { fs::path("tests/ShapeTextCache/font.ttf") };
|
||||
cfg.tests.push_back(std::move(textTest));
|
||||
|
||||
// Issue #55: a glyph without free room keeps its advance, is not
|
||||
// rasterised until it gets a cell, and gets one when the next frame
|
||||
// begins, from the glyphs drawn least recently but never one a frame
|
||||
// in flight may sample. Fills the atlas through ShapeText frame by
|
||||
// frame on Device::frameCounter and checks the layout, the frames in
|
||||
// flight, the order of the evictions, the recovery, the cleared
|
||||
// texels and InvalidateFont. Needs a headless Vulkan device (the
|
||||
// atlas is a real GPU image) and the ShapeTextCache font, which covers
|
||||
// enough codepoints to fill the atlas.
|
||||
Test evictionTest = LibraryTest("FontAtlasEviction");
|
||||
evictionTest.config.files = { fs::path("tests/ShapeTextCache/font.ttf") };
|
||||
cfg.tests.push_back(std::move(evictionTest));
|
||||
|
||||
// Issue #59: Device::GetMemoryType gained a `preferred` mask and a
|
||||
// required-only fallback so callers combining a mandatory flag with a
|
||||
// perf-only one (HOST_VISIBLE | DEVICE_LOCAL descriptor heaps) no
|
||||
|
|
|
|||
Loading…
Reference in a new issue