summaryrefslogtreecommitdiff
path: root/docs/render-pipeline.md
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-11-05 22:21:45 -0300
committerGabriel Schneider <[email protected]>2026-11-05 23:08:36 -0300
commit71e5a0f4a8685b385fac762995d45575b638179f (patch)
treebf643875b0567b45cf659c1b3ad4b872f311a774 /docs/render-pipeline.md
parentd8e5fc18f5923c4213de1cb4105a677e725200af (diff)
downloadpardes-71e5a0f4a8685b385fac762995d45575b638179f.tar.gz
pardes-71e5a0f4a8685b385fac762995d45575b638179f.zip
kinds #1, the paint contract: a picture over the cells is one Placement (raster: ptr, w, h, stride; src in pixels; dst in the frame's cells; at, where in them in pixels, or none for the frontend to fit; key, the pixels' identity by pane serial, page and revision; a terminal program's kitty z; dirty, the rows changed since an older key; art, the pane's Petscii, Palette and Ascii), where ImagePlace carried native.{revision, page, fit, pan_x, pan_y, geometry, pixel_offset_y, paper_bg, exact}, cell rects and an ImageCacheKey of three shapes by build; a PDF strip's scroll is its body region's scroll_px, whose fraction the window draws as pixel_offset_y was; glyph art leaves the core for src/Art.zig, the frontends' (the matcher, both palettes and a cache by key, ex image.zig's GlyphArt and TerminalImages' glyph cache): the core always hands an image pane, a PDF's pages and a terminal's kitty images as placements, whatever the frontend shows, and the tty draws them as glyph art without kitty graphics or when the pane asks, the window when the pane asks; the four words set the same pane bytes as before and the frontend reads them off the placement, so config.zig, builtins.zig and exec.zig are untouched; /screen lists a frame's placements as images (only a frame with pictures has the field); no golden changes: the snapshot goldens are the tty's, which draws the same art (images.snap and tagbottomimage.snap pass unchanged, and the tty's bytes for an image, its Palette and its Ascii are byte-identical to the base's), no /screen golden holds a picture, and the window's goldens hash the same; tests: kitty.zig's glyph-art case becomes its core half (a placement over the 8x4 cells, the cells the pane's) with the art in tui.zig's own test, terminal.zig's glyph-art case the same, surface.zig's two ImageCacheKey cases one keyOf case, the GlyphArt cases move to Art.zig with a frame case; gates: core-test 959/959, behaviour-test 244/244, unit-test 1486/1487 tui and 1530/1531 gui, pane-test 171/172, snap all ok, process-test 0 of 37 failed on both, hxdiff 19 and hxparity 6 mismatches by the base's names, replicas, gui-golden, monkey-gui, kitty-test 44/44, kitty-harness and image-harness on both, daemon.py main and window-clients
Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
Diffstat (limited to 'docs/render-pipeline.md')
-rw-r--r--docs/render-pipeline.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/render-pipeline.md b/docs/render-pipeline.md
index 49180ad3..64fa4e65 100644
--- a/docs/render-pipeline.md
+++ b/docs/render-pipeline.md
@@ -23,8 +23,21 @@ frontend keeps the little it draws on its own.
the snapshot goldens, the tty), the regions (each part's rectangle,
owner and focus; a body's first line and the text it shows,
`Region.line` and `Region.doc`), the layers a pixel shell draws at the
- tagline's pitch and with compact context rows, the images, the cursor
- and the palette (`Chrome`). Nothing on it moves.
+ tagline's pitch and with compact context rows, the placements, the
+ cursor and the palette (`Chrome`). Nothing on it moves.
+- A placement (surface.zig's `Placement`) is a picture over the cells, a
+ pane's at a time and lowest first: its pixels (`raster`: RGBA, straight
+ alpha), the part shown (`src`), the cells it lies over and is clipped to
+ (`dst`), where in them in pixels (`at`; none for an image pane, which
+ the frontend fits there), a `key` that names those pixels (pane serial,
+ page, revision) so a frontend keeps what it uploaded under it, a
+ terminal program's kitty `z`, the rows that alone changed since an
+ older key (`dirty`, a PDF's highlight), and how the pane wants it as
+ glyph art (`art`: Petscii, Palette, Ascii). A PDF's body region carries
+ its strip's scroll (`scroll_px`): its pictures lie at the whole pixel
+ and a pixel frontend draws them the fraction higher. The core never
+ draws a picture in the cells, so `/screen` (whose `images` lists the
+ placements) is the same on every client.
## The frontends' own
@@ -40,6 +53,7 @@ frames itself while they move (the last frame again: the tty's
| a jump's trail (`JumpTrail`, jump_trail.zig) | the ground behind the cursor, truecolor terminals | drawn over it, in the overlay | the cursor between two frames |
| `InactiveDim` | (kept, not drawn) | the unfocused panes' ink faded, never below its contrast floor | the regions' focus |
| `Pet` | (unsupported) | a sprite in the workspace tag's blank end (gui/pet.zig) | the grid's first row; SDL's ticks |
+| a placement | a kitty image placed over its cells, or glyph art in them (Art.zig) without kitty graphics or when its pane asks | a texture by key, scissored to its cells, or glyph art when its pane asks | the frame's placements |
The settings these read are plain bytes in the core's settings, dumped
and replicated as any other; nothing a frontend keeps goes back to the