summaryrefslogtreecommitdiff
path: root/docs/macos.md
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-30 17:35:06 -0300
committerGabriel Schneider <[email protected]>2026-10-30 17:35:06 -0300
commit6d8da8721141284cf33bb901168b26135893eb86 (patch)
tree791d63401d4e85fbca1d597a8ce0326e70efd545 /docs/macos.md
parentefd43a3a2cf03bb741366331158b368abf9ac583 (diff)
parentbf6810a8f9d6cc82050e7d9c0cfb06358301b574 (diff)
downloadpardes-6d8da8721141284cf33bb901168b26135893eb86.tar.gz
pardes-6d8da8721141284cf33bb901168b26135893eb86.zip
Merge latest upstream into the macOS branch for Zig 0.17
Retain the macOS branch history and local Acme selection color while adopting upstream's current core and platform changes. Pin Zig and ZLS to 0.17.0, and fetch the existing zstbi compatibility commit through upstream after its original fork was removed.
Diffstat (limited to 'docs/macos.md')
-rw-r--r--docs/macos.md35
1 files changed, 16 insertions, 19 deletions
diff --git a/docs/macos.md b/docs/macos.md
index e104d3a6..3ee55d0a 100644
--- a/docs/macos.md
+++ b/docs/macos.md
@@ -102,8 +102,8 @@ asking for a thin insert caret instead of a block. `Surface.images` crosses
separately as `pardes_frame_images` / `pardes_frame_image_list` — see "Pixel
attachments" below.
-`pardes_scene` is the matching full-window snapshot: a bit each for CRT,
-ripple, and glitch, plus the 60 Hz time/frame that animates them. It is returned
+`pardes_scene` is the matching full-window snapshot: a bit for CRT, plus the
+60 Hz time/frame that animates it. It is returned
by value, so the renderer never holds a pointer into live core state. A zero
flags word is also the fast-path contract: draw the CoreText frame directly.
@@ -355,8 +355,8 @@ The dirty half needed one core watermark. `File` counted `revision` but never
recorded which edit was last *written*, so no shell could derive "unsaved" —
`File.saved_revision` is that watermark, advanced by `Save` at the moment the
write is asked for and by a successful external-file reload whose bytes
-already came from disk. The core renders the same answer as ` *` after the
-path in every tagline, while this host also puts it in the native close button.
+already came from disk. The core shows the same answer on each pane's grip
+button, while this host also puts it in the native close button.
Save is marked at ask-time rather than on completion because `save_file`
carries none back, which makes both indicators exactly as honest as the Save
request.
@@ -462,7 +462,7 @@ after `cd` and after an idle tick.
Nested launches use the same inherited 9P address and pane serial as other
native hosts. They do not inspect ancestor processes or executable names.
-See [the control filesystem](fs.md) for paths and transports.
+See [the control filesystem](typ/reference.typ) for paths and transports.
Two more things this host cannot inherit from its launcher, because a `.app`
has none:
@@ -495,7 +495,7 @@ has none:
The face is the shell's business and the size is the window's, so the two are
reached differently on purpose.
-`Font <name>` and the `FontSel` picker are ordinary core builtins, enabled by
+`Font <name>` and the `Fonts` picker are ordinary core builtins, enabled by
`pardes.font_picker` — the frontends that draw their own text, which is now the
SDL shell and this one. `src/fonts.zig` moved out of `gui/` for that reason. It
walks the platform's font directories and reads four small sfnt tables per file
@@ -525,7 +525,7 @@ what is on screen.
Cmd+=, Cmd- and Cmd+0 change the point size, rebuild `Metrics`, and report the
new cell through the same resize path a window drag uses. They also observe the
-effective face/point tuple through `pardes_font_observe`, so the single `Config`
+effective face/point tuple through `pardes_font_observe`, so the single `DumpConfig`
report follows a host-owned zoom without resolving a pending face request. The
initial system face is observed the same way. Cmd+= rather than Cmd++ because
AppKit matches the character and `=` is what is under the finger.
@@ -662,8 +662,7 @@ longer leaves a dark titlebar over a cream grid.
## Scene effects
-`Crt`, `Ripple`, and `Glitch` are three switches over one postprocess, not three
-stacked filters. Their canonical macOS source is `shaders/crt.ci.metal`, which
+`Crt` is one full-window postprocess. Its canonical macOS source is `shaders/crt.ci.metal`, which
the build installs as `pardes.app/Contents/Resources/crt.ci.metal`. The Swift
shell loads that exact asset with `CIKernel.kernels(withMetalString:)` and runs
it through a `CIContext` created from the system Metal device. The source is
@@ -673,14 +672,12 @@ The ordinary CoreText/attachment/cursor pass is one function. With any scene
bit or panel track it targets a retained, backing-scale bitmap; kernels then
sample the complete frame into the flipped view. PDFs, image panes, taglines,
rules, and the caret therefore receive the same effect. With every bit off and
-no panel track the bitmap and Core Image context are bypassed entirely. Ripple
-and glitch alter sample coordinates only, preserving theme colors; CRT works
+no panel track the bitmap and Core Image context are bypassed entirely. CRT works
in linear light with restrained bloom, scan/mask, vignette, hum, and noise
instead of applying a broad color remap.
The scene kernel alone receives a `clampedToExtent` image and the final output
-is cropped back to the original finite extent. Coordinate tears and chroma
-samples therefore clamp to the edge exactly like SDL's scene sampler instead
+is cropped back to the original finite extent. Chroma samples therefore clamp to the edge exactly like SDL's scene sampler instead
of acquiring transparent-black seams from Core Image's finite source image.
The Zig side owns the clock. `pardes_animation_tick` increments its wrapped
@@ -689,8 +686,8 @@ from that integer. Input bursts cannot accelerate the shader.
Pointer input follows the same destination-to-source transform as the last
presented scene frame before it is divided by the cell metrics. The view keeps
-that exact `pardes_scene_s` snapshot and mirrors the Metal barrel, ripple and
-glitch sampling arithmetic in `ScenePostprocessor.sourcePoint`; pixels outside
+that exact `pardes_scene_s` snapshot and mirrors the Metal barrel arithmetic
+in `ScenePostprocessor.sourcePoint`; pixels outside
the CRT tube have no cell. The resulting displayed-grid cell then reaches the
core, whose panel-track mapping resolves it to canonical pane content.
@@ -716,8 +713,8 @@ while `pardesComposedInCore` effects only clip the already-composed core cells;
pixel attachments have no character value and pass through unchanged.
Because the input is the finished bitmap rather than a glyph-only
batch, backgrounds, glyphs, taglines, rules, the caret, PDF pages, and image
-panes move and dissolve together. Scene CRT/ripple/glitch runs once after the
-panel composition.
+panes move and dissolve together. The scene CRT runs once after the panel
+composition.
With no scene bit and no panel track the retained bitmap, Core Image context,
and Metal passes are bypassed. `EffectCode Panel*` links to this Metal
@@ -762,7 +759,7 @@ separation is currently macOS-specific; other hosts keep the opaque raster path.
`WindowBlur <0..100>` controls the strength of that native backdrop independently
of `WindowOpacity`. It is a macOS-only builtin, also accepted in the startup
-config and reported by `Config`. It defaults to 0 (off); 100 shows the full
+config and reported by `DumpConfig`. It defaults to 0 (off); 100 shows the full
AppKit material and intermediate values blend the material with the unblurred
backdrop using the effect view's alpha. An opaque themed background hides the
effect; lowering `WindowOpacity` makes the remembered strength visible again.
@@ -1143,7 +1140,7 @@ used for the table and is not folded into the direct-path claim.
`src/macos.zig` never calls `takeAttach`, so the word does nothing at all and
says nothing either. Wiring it up means a unix-socket frontend loop beside
the AppKit one, which is `src/detached/client.zig`'s job in the tty and SDL
- shells; see `docs/detached.md`.
+ shells; see `docs/typ/building.typ`.
- **IME and marked text.** Only finished characters reach `pardes_key`, so a
dead key composes nothing and Option is Alt rather than a compose modifier.
Real composition means implementing `NSTextInputClient` *and* giving the core