Skip to content

docs(architecture): add the framework and rendering sections - #10

Merged
erthoaers merged 4 commits into
mainfrom
docs/framework
Nov 14, 2026
Merged

erthoaers merged 4 commits into
mainfrom
docs/framework

Conversation

@erthoaers

Copy link
Copy Markdown
Contributor

Adds the design rules of the framework and of rendering, text and determinism to docs/architecture.md. No code changes.

  • Framework: the application model and the eight passes of a round; the layout pass; the control tree with slot-and-generation identities; effects, the job port and the result slot; the event loop, the single-round entry and the clock; how job reports enter the loop (polling while jobs are outstanding); dispatch and hit testing; focus and generation checks; the command table and key bindings; the platform interface with its nine traits, its errors and its test hooks; the headless backend and scripts; the display server backend; the accessibility entry point.
  • Rendering, text and determinism: the renderer interface; the raster library and its features; glyph coverage and subpixel positions; the text stack; the two interface fonts; pixel formats and buffer descriptions; the 26.6 fixed-point representation; where transcendental functions may come from; the cross-host determinism rules; the direct external dependencies with exact versions and features.
  • The component table describes the framework rows; earlier sentences on job polling, script lines and the headless backend now match these sections, and the scope's open question on rendering libraries points to them.

cargo xtask check passes locally, and each commit passes on its own.

Add the rules of the framework: the application model and the eight
passes of a round, the control tree, effects, the execution port and
the result slot, the single-threaded event loop with its clock and
timers, polling of job reports, dispatch and hit testing, focus checks,
command tables and key bindings, the nine traits of the platform
interface, the headless and display server backends with event
scripts, and the accessibility hook.

Add the rules of rendering, text and determinism: the renderer
interface, vello_cpu as the raster library, glyph coverage and offset
steps, the parley text stack, the two bundled fonts, pixel formats and
buffer descriptions, the 26.6 fixed-point representation, the source
of transcendental functions, the remaining determinism rules and the
external dependencies with their exact versions and features.
Name what the framework runtime, layout, accessibility, rendering,
text, platform interface, backends, test support and shared types rows
cover, following the framework and rendering sections. Crates, roles
and levels are unchanged.
The framework's event loop takes job reports by polling once per round,
so a report is taken in the round after it arrives, within the bound
that the job reports section states.

The headless frontend is the script runner of the test support with the
headless backend: the runner reads the scripts and drives the backend,
which receives only injected events, and only its driver advances its
virtual clock. The key lines of scripts run through both the framework
and the display server are presses and releases only, and the framework
section defines the other lines of a script.

Link the event record and the platform boundary to the sections that
now hold the framework clock and the determinism rules.
@erthoaers
erthoaers merged commit 8c6830f into main Nov 14, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant