Skip to content

doc: developer docs for screencopy, virtual-pointer, rendering optimizations, and testing#97

Open
nongio wants to merge 1 commit into
mainfrom
doc/recent-features
Open

doc: developer docs for screencopy, virtual-pointer, rendering optimizations, and testing#97
nongio wants to merge 1 commit into
mainfrom
doc/recent-features

Conversation

@nongio

@nongio nongio commented Apr 14, 2026

Copy link
Copy Markdown
Owner

Summary

Adds developer documentation for features landed in PRs #92#96:

  • docs/developer/screencopy.md — wlr-screencopy-v1 usage (grim, wl-mirror), protocol flow diagram, SHM buffer architecture, limitations
  • docs/developer/virtual-pointer.md — wlr-virtual-pointer usage (wlrctl), the automation trio (virtual-keyboard + virtual-pointer + foreign-toplevel), supported events, click-to-focus behavior
  • docs/developer/rendering-optimizations.md — per-window frame callback throttling (Focused/Secondary/Occluded/Minimized/HiddenWorkspace states, rate table, Chromium 2Hz workaround), damage tracking, screencopy render forcing
  • docs/developer/testing.md — full HeadlessHandle and TestClient API reference including pointer simulation (pointer_move, pointer_click, expose_window_rects, expose_selected_title), animation control, and WLCS setup
  • CLAUDE.md — updated architecture overview with screencopy and virtual-pointer sections, added all new docs to key docs list

Test plan

  • No code changes, docs only

…timizations, and testing

New docs:
- screencopy.md — wlr-screencopy-v1 usage, protocol flow, architecture
- virtual-pointer.md — wlr-virtual-pointer usage, automation trio, event model
- rendering-optimizations.md — per-window frame callback throttling, damage tracking
- testing.md — headless integration testing framework, HeadlessHandle/TestClient APIs

Updated CLAUDE.md to reference all new docs in architecture overview and key docs list.
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