Rewrite documentation and complete shortcut and feature lists

This commit is contained in:
Samuel Onoja committed 2026-10-02 10:13:53 +01:00
1 parent bbb1eac189
commit 17243464f6
18 files changed
+257 -222

No files matched your search

+8 -8
View File
@@ -9,18 +9,18 @@ WAYLAND_DEBUG=1 FERESE_TRACE_PERFORMANCE=1 \
target/release/ferese-shell 2>/tmp/ferese-resize.log
```
Use a wallpaper, drag each edge of the host window, and repeatedly maximize and
restore it. Check that the wallpaper and bar follow without long stalls, including
at fractional scaling.
Set a wallpaper, then drag each edge of the host window and repeatedly maximize
and restore it. The wallpaper and bar should resize without long stalls. Check
this at fractional scaling too.
## Compare renderers
Repeat with `ICED_BACKEND=wgpu` and `ICED_BACKEND=tiny-skia`. The shell enables
wgpu; software fallback can be slower when resampling wallpaper.
Trace the whole sequence: host resize, layer configure, client acknowledgement,
new buffer commit, then compositor rendering. A quick acknowledgement does not
mean the client has finished drawing. `FERESE_TRACE_PERFORMANCE` measures compositor
Follow the trace from host resize through layer configure, client acknowledgement,
new buffer commit and compositor rendering. A quick acknowledgement does not mean
the client has finished drawing. `FERESE_TRACE_PERFORMANCE` measures compositor
work, not shell rasterization.
## Historical check
@@ -28,8 +28,8 @@ work, not shell rasterization.
A KDE Wayland check at 175% scale used debug binaries and protocol tracing.
Median configure acknowledgement was 1.35 ms with tiny-skia and 2.27 ms with
wgpu. Wallpaper buffer intervals were 5919 ms with tiny-skia (only two buffers)
and 9.85 ms median with wgpu. Capture durations differed, so these are diagnostic
observations rather than throughput benchmarks. GPU intervals also had stalls
and 9.85 ms median with wgpu. The captures had different durations, so these
observations do not establish comparative throughput. GPU intervals also had stalls
up to about 200 ms.
Repeat on the current build. A nested result does not establish direct-session