Compare commits

..
Author SHA1 Message Date
Hermenix 15d96e7cda spike: grim-rs capture producer for the frozen harness
Long-lived zwlr-screencopy client (grim-rs 0.2.0, shm only) that prints
the contract JSON. Rust stays in a spike-local shell, not the repo flake.
2026-10-11 14:42:44 +00:00
327 changed files with 12 additions and 15119 deletions

No files matched your search

-136
View File
@@ -1,136 +0,0 @@
# The measurement contract — frozen
Two people are building capture producers in two worktrees. If each invents its
own timing, the comparison is worthless. So this file is the interface, and it is
**frozen**: implement to it exactly, do not improve it.
## The producer command
Every route is a command that captures frames and reports its own timings as one
JSON object. Same argv, same output, whatever language it is written in.
```
<producer> --output <wl_output_name> --frames <N> --warmup <W> \
--mode {raw|jpeg} --json
<producer> --all --frames <N> --warmup <W> --mode {raw|jpeg} --json
```
| Flag | Meaning |
|---|---|
| `--output NAME` | capture exactly this `wl_output` (e.g. `hh-<session-id>`, or the main output) |
| `--all` | capture **every** output and stitch them, left to right, into one image — this is the 2560×720 geometry `hhstream` publishes today. Mutually exclusive with `--output`. |
| `--frames N` | **measured** frames (after warm-up) |
| `--warmup W` | discarded frames, taken first, on the same connection |
| `--mode raw` | the frame is complete in a userspace buffer; **no encode, no format conversion** |
| `--mode jpeg` | the frame is complete as JPEG bytes |
| `--json` | print the result object (below) as the **last line of stdout** |
Anything else the producer wants to say goes to **stderr**. Stdout carries
exactly one JSON object, so a runner can parse it without guessing.
## What is timed
**One frame = from just before the capture is requested, to the moment that
frame's bytes are complete in the producer's own userspace buffer.**
- `--mode raw`: stop when the compositor's frame is ready and the buffer is
mapped and readable. Do **not** convert ARGB→RGB, do not apply transforms, do
not touch the pixels. Reads that a consumer would do (stride, checksum) are
outside the measurement.
- `--mode jpeg`: stop when the encoded bytes are complete in the buffer, however
you encode them (library, subprocess, hardware). Encoding is inside the
measurement, because encoding is what a live stream pays.
- For the **subprocess baseline** (`grim`), the timed span is the whole
`fork`+`exec`+run+read: spawn, write to a pipe, read to EOF. That is the honest
cost of the route we are trying to beat, and the fork cost is the point.
- Exclude warm-up frames from every statistic. Use a monotonic clock.
- The first frame after a connection is established is a warm-up frame by
definition — allocate buffers and settle the protocol before measuring.
## The result object
```json
{
"route": "grim-subprocess", // short id of the implementation
"language": "python", // python | rust
"protocol": "zwlr-screencopy-v1", // what actually served the frames
"output": "hh-chromium-yrfadn", // or "all"
"geometry": [1280, 720],
"mode": "jpeg",
"warmup": 10,
"frames": 300,
"frame_ms": { "min": 0.0, "p50": 0.0, "mean": 0.0, "p95": 0.0, "max": 0.0 },
"fps_sustained": 0.0, // frames / (sum of frame_ms / 1000)
"wall_ms": 0.0, // total wall time of the measured run
"cpu_ms_per_frame": null, // process CPU time / frames, or null if unknown
"bytes_p50": null, // frame size in bytes (jpeg mode), else null
"persistent": true, // one long-lived connection, or a process per frame
"notes": "" // anything a reader must know to read the numbers
}
```
### Resource fields (added 2026-10-11 — the operator's requirement)
Speed alone does not decide this. A route that hits 15 fps by burning a core is
not a route we can ship on a machine that also renders. Five more fields are
**required**, measured over the same measured window as `frame_ms`:
```json
"rss_peak_mb": 0.0, // peak RSS of the producer (children included for subprocess routes)
"rss_peak_kb_raw": 0, // the unrounded value, so nobody re-derives a rounded one
"system_cpu_ms_per_frame": 0.0, // every process on the machine, from /proc/stat
"compositor_cpu_ms_per_frame": 0.0, // the compositor's own utime+stime, from /proc/<hyprland>/stat
"machine_cpu_pct": 0.0, // system_cpu over the window, as % of one core (can exceed 100)
"frames_bytes_allocated_p50": null, // bytes of buffer the route holds per frame (raw mode: the whole frame)
```
- `system_cpu_ms_per_frame` is the honest "what this costs the machine" number,
and it is the one that catches a route which is fast only because the
compositor did extra work. Report it even when it is unflattering.
- `compositor_cpu_ms_per_frame` separates "the capture is expensive" from "the
capture made the compositor expensive". Read `/proc/<pid>/stat` fields 14+15
(utime+stime, in clock ticks — divide by `os.sysconf("SC_CLK_TCK")`). If the
file is unreadable, say so in `notes` rather than reporting zero.
- `rss_peak_mb`: `resource.getrusage(RUSAGE_SELF).ru_maxrss` for a persistent
route; `RUSAGE_CHILDREN` for a subprocess-per-frame route (it is the peak of
the children, which is what actually matters there). ru_maxrss is in **KiB**
on Linux, despite the name.
- These are measured *around the measured loop only* — warm-up excluded — so
they line up with `frame_ms`.
### The conditions a run is reported under
- `protocol` must name what really ran, not what you hoped: if
`ext-image-copy-capture-v1` is unavailable and you fell back to
`zwlr-screencopy-v1`, say so. If you had to fall back at runtime, say that too.
- `persistent` separates "one connection, N frames" from "a process per frame" —
the two are not comparable and the table must not mix them silently.
- `cpu_ms_per_frame` is process CPU (`/proc/self/stat` utime+stime, or
`getrusage`) divided by frames. A route that is fast by pinning a core is not
fast; report it.
- Numbers with no measurement behind them stay `null`. Never estimate a field.
## The conditions a run is reported under
The runner runs every route under identical conditions and records them:
1. **Geometry**: `--output <one container>` (1280×720) and `--all` (2560×720).
2. **Screen**: a *still* pass and a *moving* pass. Motion is made by a session
printing in a loop or a page being scrolled; the runner starts it, waits for
it to be visibly moving, and destroys it afterwards. A still screen can make a
damage-driven capture wait — if that happens, it is a **finding** and goes in
the verdict, not in a footnote.
3. **Mode**: `raw` and `jpeg`.
4. **Repetition**: every cell twice; report both runs, not just the better one.
## The rule that keeps this honest
**The baseline is `grim` as it runs today.** Whatever beats it, beats that, and
the verdict has to say by how much — or that nothing did. A route that is only
faster in a mode the live stream does not use (raw pixels, when the wire carries
JPEG) must be labelled as such rather than presented as a win.
And the environment caveat that goes in every verdict: **this VM has no GPU.**
Hyprland renders through software (kms_swrast / llvmpipe). Zero-copy dma-buf
paths cannot help here, so a route must not be tuned to take one; say what a
GPU machine would change, but do not claim it as measured.
-132
View File
@@ -1,132 +0,0 @@
# SPIKE BRIEF — two capture routes, measured head to head
An experiment, in a fresh worktree: `/var/lib/hermes/worktrees/hhs-capture-speed`,
branch `spike/capture-speed`, forked from `main` at `f3ac9ad`. Read
`README.dev.md` and `docs/CONTRACT.md` first; the repo's conventions apply
(docstrings that say *why*, `nix develop`, no CLI shims where a socket will do).
This is a **spike**, not production: `spikes/` is throwaway code, but the numbers
must be real. See the `spike` convention: decompose → research → build → verdict.
## The question the operator asked
> Which approach lets us render images faster — the existing `grim` subprocess, a
> Rust library (`grim-rs`), or a raw Python Wayland client? This is for **live
> streaming the workspaces to the web, and for agent eyes.**
"Render images faster" means, concretely: **time from "wake up and ask" to
"pixels/JFIF bytes in a buffer I can publish"**, sustained, and the frame rate
that follows. Encode cost is part of it, because what gets published is JPEG.
## The three routes
Measure all three with **one harness**, in this order (baseline first, so the
comparison is anchored):
- **000 — baseline: `grim` as a subprocess.** The shipped path:
`grim -c -t jpeg -q 80 -o <output> -` per frame. One process per frame.
A prior measurement in this repo says ~46 ms/frame at 1280x720 q80 **— do not
trust it, re-measure it here.**
- **001a — `grim-rs`.** The Rust crate (crates.io `grim-rs`, ~0.2): native
capture over `ext-image-copy-capture-v1` with a `zwlr_screencopy_manager_v1`
fallback, PNG/JPEG encoders included. Measure **two variants separately** and
label which number came from which:
- **(a1)** a long-lived Rust producer process — one connection, N frames
captured and encoded in a loop (the "another grim, but persistent" model);
- **(a2)** in-process from Python via PyO3/maturin, **if it fits in the
spike**. If it does not, say so plainly and leave a1 as the number. Do not
fake a2.
- **001b — raw Python.** `pywayland` + vendored protocol XML for
`ext-image-copy-capture-v1` (Hyprland has supported it since 0.52.1; this
machine runs 0.56.2 and ships `src/protocols/ImageCopyCapture.cpp`), with a
`zwlr_screencopy` fallback if the newer protocol turns out to be unavailable
in practice. **Follow the precedent already in this repo**: the input driver
vendors its protocol bindings under `src/hhstream_pointer/_protocol/` and
documents how to regenerate them (`regenerate.py`) — do the same in the spike,
and say where you got the XML.
Research before building (that is the point of the research step): read the
`grim-rs` API and the `ext-image-copy-capture-v1` spec, and check what
`pywayland` needs to bind a new protocol. Pick approaches and say why.
## Environment facts — get these right or the numbers are meaningless
- The compositor is **headless Hyprland 0.56.2 running as a system service**, not
in your shell. The published Wayland socket is
**`WAYLAND_DISPLAY=/run/hypr-stream/wayland-1`** (an absolute path).
**Do NOT set `XDG_RUNTIME_DIR=/run/hypr-stream`** — that directory is owned by
the `hhstream` user and libwayland refuses a runtime dir the caller does not
own; the failure reads as "failed to create display".
- The frame socket is `/run/hypr-stream/stream.sock` (`hhstream status` reports
all of this). `hhstream shot --output <name>` is the quickest way to prove a
capture path works before you time it.
- **There is no GPU.** The compositor renders through software (kms_swrast /
llvmpipe). So: **do not use the zero-copy dma-buf / GPU paths to make the Rust
route look good** — they cannot help on this box, and a benchmark that silently
takes a GPU path and falls back would not be honest. Measure the CPU path, and
say in the verdict what a GPU box would change.
- Geometries to measure (both, always): **1280×720** (one session container) and
**2560×720** (the whole desktop as `hhstream` publishes it today — this is the
geometry on the wire now).
- Measure **a moving screen and a still one.** A still screen with damage-driven
capture can block or go quiet, which is exactly the kind of thing that decides
a live-stream design — the current `hhstream` path re-encodes the same frame on
a timer instead. If a route behaves differently on a still screen, that is a
finding, not a nuisance. To make motion: start a session
(`hhstream session start chromium -- --ozone-platform=wayland --new-window
https://example.com` — the allowlist is in the NixOS module) or use
`examples/agent-eyes-demo.py`, which already drives a page. A `foot` session
with something printing in a loop is cheaper and moves plenty.
- A live session for testing may already exist (`hhstream session list`); you may
start your own. **Do not kill another agent's session without saying so.**
## The harness (build this once, use it for all routes)
- Warm-up frames excluded; then **≥300 measured frames per cell**; report
**p50 / p95 / max per-frame ms**, sustained fps, and **CPU time per frame**
(`time.process_time` / `/proc` for the subprocess cases) — a route that is fast
by pinning a core is not fast.
- Separate the two stages so the verdict can say where the time goes:
**(i) frame ready in a buffer**, **(ii) + JPEG encode**. Report both. If a
route cannot separate them, say so.
- Same output, same geometry, same content for every route; run each cell at
least twice and report the spread, not one lucky run.
- Print a machine-readable line per cell (JSON) **and** a human table, and write
the raw runs to a file so the numbers in the README can be re-derived.
## Deliverables
1. `spikes/capture-speed/README.md` — the question, the method, the head-to-head
table, and a `## Verdict` (VALIDATED / PARTIAL / INVALIDATED) with what worked,
what didn't, surprises, and a recommendation for the real build. The existing
`grim` route and the two new ones all get a row.
2. `spikes/capture-speed/001a-grim-rs/README.md` and `001b-pywayland/README.md`
with their own verdicts and the raw evidence.
3. **A chart PNG** (frame time and sustained fps per route, both geometries).
`ad-hoc-charts` conventions if you want a recipe; matplotlib via
`nix shell nixpkgs#python3Packages.matplotlib` is fine.
4. **Something the operator can watch** — this matters more than the table. The
cheapest honest version: run each *winning-capable* backend behind an MJPEG
endpoint the operator can open in a browser, both at once or one at a time,
with the achieved fps printed on the page or in its sidecar `status.json`.
Reuse `src/hhstream_live/` (its publisher takes a capture command/loop) rather
than writing a second web app; if reuse turns out to be the harder path, say
so and keep the demo small. Bind it sensibly: the guest is in NAT mode, so a
browser on the host may or may not reach a port — say what you bound and how
you verified it with `curl`, and do not touch the system firewall.
5. A short "what a production version would take" section: which file in
`src/hhstream/` the winner would replace, what dependencies it adds, and what
the repo's stdlib-only policy would cost.
## Rules
- **Do not touch the running system**: no `nixos-rebuild`, no edits under
`/etc/nixos`, no changes to the running `hhstream` units. You may run the CLI
and start/stop your own sessions.
- Keep Rust out of the repo's main flake: a spike-local `shell.nix`/flake under
`spikes/capture-speed/` is the place for `cargo`, `rustc`, `maturin`.
`cargo`/`rustc` 1.98 are in nixpkgs and crates.io is reachable from here.
- Commit on `spike/capture-speed` as you go. Do not merge, do not touch `main`.
- Every number in a README must be reproducible by a command you paste next to
it. If something did not work, it goes in the README as a finding, not a
silent omission.
-4
View File
@@ -1,4 +0,0 @@
# The Rust build tree: reproducible from Cargo.lock, and huge.
001a-grim-rs/target/
__pycache__/
generated/**/__pycache__/
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol zwlr-screencopy-v1 mode jpeg target all warmup 10 frames 300
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 2/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 3/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 4/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 5/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 6/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 7/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 8/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 9/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 10/10 2560x720 bytes 284962 nonzero 281335
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"zwlr-screencopy-v1","output":"all","geometry":[2560,720],"mode":"jpeg","warmup":10,"frames":300,"frame_ms":{"min":114.651,"p50":196.918,"mean":207.359,"p95":304.217,"max":471.059},"fps_sustained":4.823,"wall_ms":62207.988,"cpu_ms_per_frame":13.017,"bytes_p50":284962.0,"persistent":true,"notes":"grim-rs 0.2.0 via Grim::new_wlr(); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 281335."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol zwlr-screencopy-v1 mode jpeg target all warmup 10 frames 300
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 2/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 3/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 4/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 5/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 6/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 7/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 8/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 9/10 2560x720 bytes 284962 nonzero 281335
grimrs-capture: warmup 10/10 2560x720 bytes 284962 nonzero 281335
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"zwlr-screencopy-v1","output":"all","geometry":[2560,720],"mode":"jpeg","warmup":10,"frames":300,"frame_ms":{"min":115.964,"p50":185.942,"mean":200.869,"p95":280.883,"max":344.797},"fps_sustained":4.978,"wall_ms":60261.001,"cpu_ms_per_frame":13.072,"bytes_p50":284962.0,"persistent":true,"notes":"grim-rs 0.2.0 via Grim::new_wlr(); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 281335."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol zwlr-screencopy-v1 mode raw target all warmup 10 frames 300
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 2/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 3/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 4/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 5/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 6/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 7/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 8/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 9/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 10/10 2560x720 bytes 7372800 nonzero 7353441
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"zwlr-screencopy-v1","output":"all","geometry":[2560,720],"mode":"raw","warmup":10,"frames":300,"frame_ms":{"min":105.174,"p50":179.929,"mean":191.042,"p95":269.35,"max":486.399},"fps_sustained":5.234,"wall_ms":57312.833,"cpu_ms_per_frame":2.41,"bytes_p50":null,"persistent":true,"notes":"grim-rs 0.2.0 via Grim::new_wlr(); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 7353441."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol zwlr-screencopy-v1 mode raw target all warmup 10 frames 300
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 2/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 3/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 4/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 5/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 6/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 7/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 8/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 9/10 2560x720 bytes 7372800 nonzero 7353441
grimrs-capture: warmup 10/10 2560x720 bytes 7372800 nonzero 7353441
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"zwlr-screencopy-v1","output":"all","geometry":[2560,720],"mode":"raw","warmup":10,"frames":300,"frame_ms":{"min":100.09,"p50":175.426,"mean":189.164,"p95":267.965,"max":595.464},"fps_sustained":5.286,"wall_ms":56749.543,"cpu_ms_per_frame":2.415,"bytes_p50":null,"persistent":true,"notes":"grim-rs 0.2.0 via Grim::new_wlr(); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 7353441."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol zwlr-screencopy-v1 mode jpeg target hh-foot-utjcf2 warmup 10 frames 300
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 2/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 3/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 4/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 5/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 6/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 7/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 8/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 9/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 10/10 1280x720 bytes 92861 nonzero 90786
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"zwlr-screencopy-v1","output":"hh-foot-utjcf2","geometry":[1280,720],"mode":"jpeg","warmup":10,"frames":300,"frame_ms":{"min":43.254,"p50":119.493,"mean":126.816,"p95":212.019,"max":329.716},"fps_sustained":7.885,"wall_ms":38044.93,"cpu_ms_per_frame":6.721,"bytes_p50":92861.0,"persistent":true,"notes":"grim-rs 0.2.0 via Grim::new_wlr(); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 90786."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol zwlr-screencopy-v1 mode jpeg target hh-foot-utjcf2 warmup 10 frames 300
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 2/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 3/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 4/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 5/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 6/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 7/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 8/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 9/10 1280x720 bytes 92861 nonzero 90786
grimrs-capture: warmup 10/10 1280x720 bytes 92861 nonzero 90786
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"zwlr-screencopy-v1","output":"hh-foot-utjcf2","geometry":[1280,720],"mode":"jpeg","warmup":10,"frames":300,"frame_ms":{"min":46.294,"p50":112.667,"mean":112.794,"p95":171.372,"max":257.709},"fps_sustained":8.866,"wall_ms":33838.267,"cpu_ms_per_frame":6.66,"bytes_p50":92861.0,"persistent":true,"notes":"grim-rs 0.2.0 via Grim::new_wlr(); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 90786."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol zwlr-screencopy-v1 mode raw target hh-foot-utjcf2 warmup 10 frames 300
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 2/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 3/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 4/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 5/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 6/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 7/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 8/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 9/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 10/10 1280x720 bytes 3686400 nonzero 3679565
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"zwlr-screencopy-v1","output":"hh-foot-utjcf2","geometry":[1280,720],"mode":"raw","warmup":10,"frames":300,"frame_ms":{"min":51.409,"p50":110.264,"mean":109.115,"p95":177.876,"max":215.254},"fps_sustained":9.165,"wall_ms":32734.584,"cpu_ms_per_frame":1.445,"bytes_p50":null,"persistent":true,"notes":"grim-rs 0.2.0 via Grim::new_wlr(); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 3679565."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol zwlr-screencopy-v1 mode raw target hh-foot-utjcf2 warmup 10 frames 300
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 2/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 3/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 4/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 5/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 6/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 7/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 8/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 9/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 10/10 1280x720 bytes 3686400 nonzero 3679565
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"zwlr-screencopy-v1","output":"hh-foot-utjcf2","geometry":[1280,720],"mode":"raw","warmup":10,"frames":300,"frame_ms":{"min":46.687,"p50":106.48,"mean":103.438,"p95":157.55,"max":262.651},"fps_sustained":9.668,"wall_ms":31031.55,"cpu_ms_per_frame":1.386,"bytes_p50":null,"persistent":true,"notes":"grim-rs 0.2.0 via Grim::new_wlr(); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-foot-utjcf2@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 3679565."}
@@ -1,134 +0,0 @@
PID USER CMD
1 root /run/current-system/systemd/lib/systemd/systemd --switched-root --system --deserialize=47
2 root [kthreadd]
3 root [pool_workqueue_release]
4 root [kworker/R-rcu_gp]
5 root [kworker/R-sync_wq]
6 root [kworker/R-kvfree_rcu_reclaim]
7 root [kworker/R-slub_flushwq]
8 root [kworker/R-netns]
10 root [kworker/0:0H-events_highpri]
13 root [kworker/R-mm_percpu_wq]
15 root [ksoftirqd/0]
16 root [rcu_preempt]
17 root [rcu_exp_par_gp_kthread_worker/0]
18 root [rcu_exp_gp_kthread_worker]
19 root [migration/0]
20 root [idle_inject/0]
21 root [cpuhp/0]
22 root [cpuhp/1]
23 root [idle_inject/1]
24 root [migration/1]
25 root [ksoftirqd/1]
27 root [kworker/1:0H-events_highpri]
28 root [kdevtmpfs]
29 root [kworker/R-inet_frag_wq]
30 root [rcu_tasks_kthread]
31 root [rcu_tasks_rude_kthread]
32 root [rcu_tasks_trace_kthread]
33 root [kauditd]
34 root [khungtaskd]
35 root [oom_reaper]
37 root [kworker/R-writeback]
39 root [kcompactd0]
40 root [ksmd]
41 root [khugepaged]
42 root [kworker/R-kblockd]
43 root [kworker/R-blkcg_punt_bio]
44 root [kworker/R-kintegrityd]
45 root [irq/9-acpi]
46 root [kworker/R-tpm_dev_wq]
47 root [kworker/R-devfreq_wq]
48 root [kworker/R-quota_events_unbound]
49 root [kworker/1:1H-kblockd]
50 root [kswapd0]
51 root [kdamond.0]
52 root [kworker/R-kthrotld]
53 root [kworker/R-mld]
54 root [kworker/R-ipv6_addrconf]
55 root [kworker/R-kstrp]
56 root [kworker/u9:0]
57 root [kworker/0:1H-kblockd]
59 root [hwrng]
126 root [kworker/R-ata_sff]
128 root [scsi_eh_0]
129 root [kworker/R-scsi_tmf_0]
130 root [scsi_eh_1]
131 root [kworker/R-scsi_tmf_1]
132 root [scsi_eh_2]
133 root [kworker/R-scsi_tmf_2]
134 root [scsi_eh_3]
135 root [kworker/R-scsi_tmf_3]
136 root [scsi_eh_4]
137 root [kworker/R-scsi_tmf_4]
138 root [scsi_eh_5]
139 root [kworker/R-scsi_tmf_5]
167 root [jbd2/vda2-8]
168 root [kworker/R-ext4-rsv-conversion]
176 root [jbd2/vdb-8]
177 root [kworker/R-ext4-rsv-conversion]
305 root /nix/store/baxgs06659w4i6ggsfr56srjrb52v1h8-systemd-261.2/lib/systemd/systemd-journald
308 systemd+ /nix/store/baxgs06659w4i6ggsfr56srjrb52v1h8-systemd-261.2/lib/systemd/systemd-oomd
330 systemd+ /nix/store/baxgs06659w4i6ggsfr56srjrb52v1h8-systemd-261.2/lib/systemd/systemd-timesyncd
338 systemd+ /nix/store/baxgs06659w4i6ggsfr56srjrb52v1h8-systemd-261.2/lib/systemd/systemd-resolved
347 root /nix/store/baxgs06659w4i6ggsfr56srjrb52v1h8-systemd-261.2/lib/systemd/systemd-udevd
391 root [psimon]
472 systemd+ /nix/store/baxgs06659w4i6ggsfr56srjrb52v1h8-systemd-261.2/lib/systemd/systemd-networkd
490 root [watchdogd]
491 root [kworker/R-cfg80211]
498 root [kworker/R-edac-poller]
569 message+ /nix/store/wqy7b0gz66x4gmkwsyf8dwmmbjp9vdi1-dbus-broker-37/bin/dbus-broker-launch --scope system --audit
571 message+ dbus-broker --log 10 --controller 9 --machine-id f5d8c9d86761459a85062f59346f1e37 --max-bytes 536870912 --max-fds 4096 --max-matches 16384 --audit
575 nscd /nix/store/agzqciyfjb2i3vj3ln9vgfmbgxw4xhzj-nsncd-1.5.2/bin/nsncd
578 root /nix/store/606qg4ms8vkri6cpja5b3p84xm9ximfc-qemu-host-cpu-only-11.1.0-ga/bin/qemu-ga --statedir /run/qemu-ga
580 root sshd: /nix/store/5j1k7bxsljgrgql1cmr98wng8lpk2idn-openssh-10.5p1/bin/sshd -D -f /etc/ssh/sshd_config [listener] 0 of 10-100 startups
592 root /nix/store/zs0ldgp3mgzpxz5y7igqcpj9gpsr8mny-tailscale-1.102.4/bin/tailscaled --state=/var/lib/tailscale/tailscaled.state --socket=/run/tailscale/tailscaled.sock --port=41641 --tun tailscale0 --state=/var/lib/hermes/tailscale/tailscaled.state
593 hhstream /nix/store/pgpmwfkh9xgby9iqv17cf9zhqm7njybw-hyprland-0.56.2/bin/Hyprland --config /nix/store/jbjf3qk6q1jkyhh8x39087dvcsfznx82-hyprland.conf
601 root /nix/store/baxgs06659w4i6ggsfr56srjrb52v1h8-systemd-261.2/lib/systemd/systemd-logind
615 root /nix/store/mqvbf0flamqaq9c3ihb496aahag897n0-util-linux-2.42.3-bin/bin/agetty --login-program /nix/store/wbsjibdqfdcs4gcyx87sb94c4wy3jx05-shadow-4.20.2/bin/login --issue-file /etc/issue:/etc/issue.d:/run/issue:/run/issue.d --noclear --keep-baud tty1 115200,38400,9600 linux
651 hermes /run/current-system/systemd/lib/systemd/systemd --user --deserialize=38
661 hermes (sd-pam)
670 hermes /var/lib/hermes/.hermes/tools/python-3.14.7+20260901-linux-x64/bin/python3 -I -c import os, re, sys os.environ.pop('PYTHONHOME', None) os.environ.pop('PYTHONPATH', None) sys.path.insert(0, '/var/lib/hermes/.hermes/hermes-agent') if sys.argv[1:2] == ['--print-runtime-command']: sys.dont_write_bytecode = True from hermes_constants import get_default_hermes_root os.environ['HERMES_HOME'] = os.environ.get('HERMES_HOME') or str(get_default_hermes_root()) if sys.argv[1:2] == ['--print-runtime-command']: from pathlib import Path from hermes_cli._launchers import print_runtime_command print_runtime_command(Path('/var/lib/hermes/.hermes/hermes-agent'), sys.argv[2:]) sys.exit(0) import hermes_bootstrap if sys.argv[1:2] == ['--run-module']: import runpy if len(sys.argv) < 3: sys.exit('hermes: --run-module needs a module') module = sys.argv.pop(2) del sys.argv[1] runpy.run_module(module, run_name='__main__', alter_sys=True) sys.exit(0) from hermes_cli.main import main sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) sys.exit(main()) gateway run
677 hhstream /nix/store/pgpmwfkh9xgby9iqv17cf9zhqm7njybw-hyprland-0.56.2/bin/Hyprland --config /nix/store/jbjf3qk6q1jkyhh8x39087dvcsfznx82-hyprland.conf
698 hhstream /nix/store/rk9kpnq5rd72yhfyw91a8kp5bix1ywfp-swaybg-1.2.2/bin/swaybg -i /nix/store/p6c8877bwk2h7rqq1j33p7rgs2naik9a-agent-eyes.jpg -m fill
724 caddy /nix/store/z7n5vmb63i55f9xzish6fhyxlmwy6mrf-caddy-2.11.4/bin/caddy run --config /etc/caddy/caddy_config --adapter caddyfile
725 hermes /var/lib/hermes/.hermes/tools/python-3.14.7+20260901-linux-x64/bin/python3 -I -c import sys, runpy; sys.path.insert(0, '/var/lib/hermes/.hermes/hermes-agent'); sys.argv = ['/var/lib/hermes/.hermes/hermes-agent/hermes', 'dashboard', '--no-open', '--host', '0.0.0.0', '--skip-build']; runpy.run_path('/var/lib/hermes/.hermes/hermes-agent/hermes', run_name='__main__')
4200 root determinate-nixd --nix-bin /nix/store/cf9fsbghaiv71lpl7jp6v6ha68skrqkb-determinate-nix-3.22.4/bin daemon
4248 root /nix/store/cf9fsbghaiv71lpl7jp6v6ha68skrqkb-determinate-nix-3.22.4/bin/nix-daemon --option json-log-path /nix/var/determinate/determinate-nixd-logger.socket
4254 root /nix/store/myj3yayd9yk0kwbdnf9ixdx3m8x9sm5w-sentry-native-0.13.5/bin/crashpad_handler --no-rate-limit --database=/root/.cache/nix/sentry --metrics-dir=/root/.cache/nix/sentry --url=https://o4506062689927168.ingest.us.sentry.io:443/api/4511237220532224/minidump/?sentry_client=sentry.native/0.13.5&sentry_key=0c7a3f7635bd9f9e92056c3c6e5f0b3a --attachment=/root/.cache/nix/sentry/b5fab905-3ada-49d0-9846-2cab69756924.run/__sentry-event --attachment=/root/.cache/nix/sentry/b5fab905-3ada-49d0-9846-2cab69756924.run/__sentry-breadcrumb1 --attachment=/root/.cache/nix/sentry/b5fab905-3ada-49d0-9846-2cab69756924.run/__sentry-breadcrumb2 --report-id=eb0aa806-28e3-453b-730a-ca337915324b --initial-client-fd=6 --shared-client-connection
6941 hermes /nix/store/wqy7b0gz66x4gmkwsyf8dwmmbjp9vdi1-dbus-broker-37/bin/dbus-broker-launch --scope user
6942 hermes dbus-broker --log 11 --controller 10 --machine-id f5d8c9d86761459a85062f59346f1e37 --max-bytes 100000000000000 --max-fds 25000000000000 --max-matches 5000000000
55730 hermes /nix/store/499dwp4ljzzbx5i5fhlxm6lwzncgqz61-tmux-3.7c/bin/tmux new-session -d -s hhs-pr1-merge -x 200 -y 50 cd /var/lib/hermes/projects/hhstream-keyboard && claude --model opus --effort high "Read CLAUDE-MERGE-BRIEF.md in full and do exactly what it says."; exec bash -i
55731 hermes bash -c cd /var/lib/hermes/projects/hhstream-keyboard && claude --model opus --effort high "Read CLAUDE-MERGE-BRIEF.md in full and do exactly what it says."; exec bash -i
55734 hermes claude --model opus --effort high Read CLAUDE-MERGE-BRIEF.md in full and do exactly what it says.
70277 hermes bash -c cd /var/lib/hermes/projects/pptx-deck/decks/neuralink && claude --model opus --effort high "Read COMMENTS-BRIEF.md in full and do exactly what it says. Do not modify the pptx."; exec bash -i
70280 hermes claude --model opus --effort high Read COMMENTS-BRIEF.md in full and do exactly what it says. Do not modify the pptx.
259625 hermes bash -c cd /var/lib/hermes/worktrees/hhs-mcp && claude --model opus --effort high "Read MCP-BRIEF.md in full and do exactly what it says."; exec bash -i
259628 hermes claude --model opus --effort high Read MCP-BRIEF.md in full and do exactly what it says.
758065 hermes /nix/store/d64q19q1xjdwfhqx6czvrjgrhq0n3lcc-python3-3.14.7/bin/python3.14 /nix/store/4a7ci3sfbkl7zsjpz6r8xsj6lic4z7px-hhstream-mcp-0.1.0/bin/.hhstream-mcp-wrapped
758066 hermes /var/lib/hermes/.hermes/tools/python-3.14.7+20260901-linux-x64/bin/python3 /var/lib/hermes/.hermes/hermes-agent/tools/mcp_death_supervisor.py --parent-pgid 670
807466 root [psimon]
807486 hermes /nix/store/d64q19q1xjdwfhqx6czvrjgrhq0n3lcc-python3-3.14.7/bin/python3.14 /nix/store/wsqlzgwh8f3k6n4pkj3x3ixk25y4rngq-hhstream-0.1.0/bin/.hhstream-pointer-wrapped --socket /run/hhstream/pointer.sock --compositor-runtime-dir /run/hypr-stream --xkb-layout us --xkb-model pc105 --xkb-variant --xkb-options
807487 hermes /nix/store/d64q19q1xjdwfhqx6czvrjgrhq0n3lcc-python3-3.14.7/bin/python3.14 /nix/store/wsqlzgwh8f3k6n4pkj3x3ixk25y4rngq-hhstream-0.1.0/bin/.hhstreamd-wrapped --socket /run/hhstream/control.sock --runtime-dir /run/hhstream --state-dir /var/lib/hermes/hhstream-sessions --config /nix/store/nd8xlpliw4c7s3y3yr2qwbn8056g79yg-hhstream-sessions.toml --compositor-runtime-dir /run/hypr-stream
807511 hhstream /nix/store/d64q19q1xjdwfhqx6czvrjgrhq0n3lcc-python3-3.14.7/bin/python3.14 /nix/store/wsqlzgwh8f3k6n4pkj3x3ixk25y4rngq-hhstream-0.1.0/bin/.hhstream-server-wrapped --socket /run/hypr-stream/stream.sock --fps 30 --format jpeg --capture-command grim --capture-command -c --capture-command -t --capture-command jpeg --capture-command -q --capture-command 80 --capture-command -
831259 root [kworker/0:1-events]
833646 hermes bash -c cd /var/lib/hermes/worktrees/hhs-chat && claude --model opus --effort high "Read COMPANION-CONTEXT.md in full, then stop and wait for my questions — this session is for conversation about the project, not for starting work."; exec bash -i
833649 hermes claude --model opus --effort high Read COMPANION-CONTEXT.md in full, then stop and wait for my questions — this session is for conversation about the project, not for starting work.
847221 root [kworker/u8:3-events_unbound]
863435 root [kworker/u8:2-events_power_efficient]
884175 hermes bash -c cd /var/lib/hermes/worktrees/hhs-capture-speed && claude --model opus --effort high "Read SPIKE-BRIEF.md in full and do exactly what it says."; exec bash -i
884178 hermes claude --model opus --effort high Read SPIKE-BRIEF.md in full and do exactly what it says.
890506 root [kworker/u8:1-flush-253:0]
892374 root [kworker/1:0-events]
898144 hermes /run/current-system/sw/bin/bash -lic set +m; cd /var/lib/hermes/worktrees/hhs-grimrs && env -u XAI_API_KEY grok -p "Read GRIMRS-BRIEF.md in full and do exactly what it says." --cwd /var/lib/hermes/worktrees/hhs-grimrs --max-turns 100 --always-approve --output-format json 2>&1
898162 hermes grok -p Read GRIMRS-BRIEF.md in full and do exactly what it says. --cwd /var/lib/hermes/worktrees/hhs-grimrs --max-turns 100 --always-approve --output-format json
898165 root [kworker/1:1-events]
899058 hermes node /var/lib/hermes/.hermes/lsp/bin/pyright-langserver --stdio
900395 root [kworker/0:0-events]
903719 root [kworker/u8:5-flush-253:0]
906223 root [kworker/1:2-cgroup_release]
911709 root [kworker/0:2]
914615 hermes /nix/store/6nhmbaws8lqd8bvzsx4m0gw36ssyg2iy-foot-1.28.0/bin/foot -H -f monospace:size=20 /nix/store/s4hlzmy3ll1bphdsy8vjdpcw447vbr93-cowsay-3.8.4/bin/cowsay hahaha I can see the world now
915090 hermes /bin/sh /var/lib/hermes/worktrees/hhs-grimrs/spikes/capture-speed/001a-grim-rs/run-cells.sh hh-foot-utjcf2
915093 hermes /run/current-system/sw/bin/bash -O extglob -c snap=$(command cat <&3); builtin shopt -s extglob 2>/dev/null; builtin shopt -s expand_aliases 2>/dev/null; builtin eval -- "$snap"; builtin export GROK_AGENT=1; builtin export PWD="$(builtin pwd)"; unalias find 2>/dev/null || true; find() { local __grok_bin=''; [ -x "$__grok_bin" ] || __grok_bin=$(command -v bfs 2>/dev/null) || __grok_bin=''; if [ -z "$__grok_bin" ]; then command find "$@"; return; fi; if [[ -z ${ZSH_VERSION-} ]] && (( BASH_SUBSHELL > 0 )); then exec -a find "$__grok_bin" "$@"; else (exec -a find "$__grok_bin" "$@"); fi; }; __grok_shadow_find=1; unalias grep 2>/dev/null || true; grep() { local __grok_bin=''; [ -x "$__grok_bin" ] || __grok_bin=$(command -v ugrep 2>/dev/null) || __grok_bin=''; if [ -z "$__grok_bin" ]; then command grep "$@"; return; fi; if [[ -z ${ZSH_VERSION-} ]] && (( BASH_SUBSHELL > 0 )); then exec -a grep "$__grok_bin" -G --ignore-files --hidden -I --exclude-dir=.git --exclude-dir=.svn --exclude-dir=.hg --exclude-dir=.bzr --exclude-dir=.jj --exclude-dir=.sl "$@"; else (exec -a grep "$__grok_bin" -G --ignore-files --hidden -I --exclude-dir=.git --exclude-dir=.svn --exclude-dir=.hg --exclude-dir=.bzr --exclude-dir=.jj --exclude-dir=.sl "$@"); fi; }; __grok_shadow_grep=1; __grok_user_cmd="$1"; builtin declare +x __grok_user_cmd 2>/dev/null; builtin set --; builtin eval "$__grok_user_cmd" 2>&1 -- cd /var/lib/hermes/worktrees/hhs-grimrs && git add \ spikes/capture-speed/001a-grim-rs/shell.nix \ spikes/capture-speed/001a-grim-rs/.gitignore \ spikes/capture-speed/001a-grim-rs/Cargo.toml \ spikes/capture-speed/001a-grim-rs/Cargo.lock \ spikes/capture-speed/001a-grim-rs/src/main.rs \ spikes/capture-speed/001a-grim-rs/run-cells.sh && git status --short && git commit -m "$(cat <<'EOF' spike: grim-rs capture producer for the frozen harness Long-lived zwlr-screencopy client (grim-rs 0.2.0, shm only) that prints the contract JSON. Rust stays in a spike-local shell, not the repo flake. EOF )" && git status --short && git log -1 --oneline
915106 hermes ps -eo pid,user,cmd
+12 -230
View File
@@ -50,48 +50,6 @@ struct Args {
frames: u32,
warmup: u32,
mode: Mode,
backend: BackendChoice,
}
/// Which constructor to use. `Grim::new()` auto-detects and prefers
/// `ext-image-copy-capture-v1`; the two forcing constructors exist so the
/// table can show what the protocol choice is worth instead of assuming.
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
enum BackendChoice {
Auto,
Wlr,
Ext,
}
impl BackendChoice {
fn open(self) -> Result<(Grim, &'static str), String> {
match self {
BackendChoice::Wlr => Grim::new_wlr()
.map(|grim| (grim, "zwlr-screencopy-v1"))
.map_err(|err| format!("Grim::new_wlr failed: {err}")),
BackendChoice::Ext => Grim::new_ext()
.map(|grim| (grim, "ext-image-copy-capture-v1"))
.map_err(|err| format!("Grim::new_ext failed: {err}")),
// new() prefers ext and falls back to wlr. The crate does not
// report which it chose, so we ask it the same question twice:
// if new_ext() succeeds, new() took ext.
BackendChoice::Auto => {
let probe = Grim::new_ext().is_ok();
Grim::new()
.map(|grim| {
(
grim,
if probe {
"ext-image-copy-capture-v1 (auto)"
} else {
"zwlr-screencopy-v1 (auto, ext unavailable)"
},
)
})
.map_err(|err| format!("Grim::new failed: {err}"))
}
}
}
}
struct Held {
@@ -138,12 +96,14 @@ fn run() -> Result<(), String> {
);
}
// Neither backend imports a dma-buf: grim-rs 0.2.0 creates a
// NamedTempFile and mmaps it inside every capture call, on both paths
// (see src/platform/wayland/capture.rs). So measuring both is honest on
// a machine with no GPU -- there is no zero-copy path to accidentally
// take, and the protocol choice is the only variable.
let (mut grim, protocol) = args.backend.open()?;
// Force zwlr-screencopy. Grim::new() prefers ext-image-copy-capture-v1,
// which is the dma-buf-capable path this machine must not take.
let mut grim = Grim::new_wlr().map_err(|err| {
format!(
"Grim::new_wlr failed ({err}). Refusing to fall back to \
ext-image-copy-capture-v1"
)
})?;
let outputs = grim.get_outputs().map_err(|err| err.to_string())?;
if outputs.is_empty() {
@@ -159,7 +119,7 @@ fn run() -> Result<(), String> {
}
eprintln!(
"grimrs-capture: route {ROUTE} protocol {protocol} \
"grimrs-capture: route {ROUTE} protocol zwlr-screencopy-v1 \
mode {} target {} warmup {} frames {}",
args.mode.as_str(),
args.target.label(),
@@ -194,7 +154,6 @@ fn run() -> Result<(), String> {
}
let cpu_before = process_cpu_ms()?;
let machine_before = MachineSample::take();
let wall_start = Instant::now();
let mut samples_ms: Vec<f64> = Vec::with_capacity(args.frames as usize);
let mut jpeg_sizes: Vec<u64> = Vec::new();
@@ -226,29 +185,8 @@ fn run() -> Result<(), String> {
}
let wall_ms = wall_start.elapsed().as_secs_f64() * 1000.0;
let cpu_after = process_cpu_ms()?;
let machine_after = MachineSample::take();
let (width, height) = geometry.ok_or("no measured frames")?;
let per_frame = |delta: Option<f64>| -> Option<f64> {
delta.map(|value| value * 1000.0 / f64::from(args.frames))
};
let system_cpu_ms_per_frame = match (machine_before.system_cpu, machine_after.system_cpu) {
(Some(before), Some(after)) if after >= before => per_frame(Some(after - before)),
_ => None,
};
let compositor_cpu_ms_per_frame =
match (machine_before.compositor_cpu, machine_after.compositor_cpu) {
(Some(before), Some(after)) if after >= before => per_frame(Some(after - before)),
_ => None,
};
let machine_cpu_pct = match (machine_before.system_cpu, machine_after.system_cpu, wall_ms) {
(Some(before), Some(after), wall) if after >= before && wall > 0.0 => {
Some((after - before) * 1000.0 / wall * 100.0)
}
_ => None,
};
let rss_peak = rss_peak_kb();
let cpu_ms_per_frame = match (cpu_before, cpu_after) {
(Some(before), Some(after)) if after >= before => {
Some((after - before) / f64::from(args.frames))
@@ -256,13 +194,8 @@ fn run() -> Result<(), String> {
_ => None,
};
let opened = match args.backend {
BackendChoice::Auto => "Grim::new() (auto-detect)",
BackendChoice::Wlr => "Grim::new_wlr()",
BackendChoice::Ext => "Grim::new_ext()",
};
let mut notes = format!(
"grim-rs 0.2.0 via {opened}; copy target is a wl_shm buffer \
"grim-rs 0.2.0 via Grim::new_wlr(); copy target is a wl_shm buffer \
created inside each capture_* call, not a dma-buf the producer \
imports. Cursor not overlaid (the frozen argv has no cursor flag; \
hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, \
@@ -293,7 +226,7 @@ fn run() -> Result<(), String> {
let report = Report {
route: ROUTE,
language: "rust",
protocol,
protocol: "zwlr-screencopy-v1",
output: args.target.label().to_string(),
geometry: [width, height],
mode: args.mode.as_str(),
@@ -309,12 +242,6 @@ fn run() -> Result<(), String> {
None
},
persistent: true,
rss_peak_mb: rss_peak.map(|kb| (kb as f64 / 1024.0 * 100.0).round() / 100.0),
rss_peak_kb_raw: rss_peak,
system_cpu_ms_per_frame: system_cpu_ms_per_frame.map(|v| (v * 1000.0).round() / 1000.0),
compositor_cpu_ms_per_frame: compositor_cpu_ms_per_frame.map(|v| (v * 1000.0).round() / 1000.0),
machine_cpu_pct: machine_cpu_pct.map(|v| (v * 10.0).round() / 10.0),
frames_bytes_allocated_p50: Some(u64::from(width) * u64::from(height) * 4),
notes,
};
@@ -404,95 +331,6 @@ fn timeval_ms(value: libc::timeval) -> f64 {
value.tv_sec as f64 * 1000.0 + value.tv_usec as f64 / 1000.0
}
// -- resource counters -------------------------------------------------------
//
// Added by Hermenix after the operator asked for RAM and CPU alongside speed:
// a route that reaches 15 fps by burning a core is not one this machine can
// ship while it is also rendering. Three angles, all sampled around the
// *measured* loop only, so they line up with frame_ms:
//
// * this process (getrusage: CPU and peak RSS)
// * the whole machine (/proc/stat)
// * the compositor (/proc/<Hyprland>/stat)
//
// ru_maxrss is in KiB on Linux despite the name.
fn ticks_per_second() -> f64 {
let value = unsafe { libc::sysconf(libc::_SC_CLK_TCK) };
if value > 0 {
value as f64
} else {
100.0
}
}
fn rss_peak_kb() -> Option<u64> {
let mut usage: libc::rusage = unsafe { std::mem::zeroed() };
let rc = unsafe { libc::getrusage(libc::RUSAGE_SELF, &mut usage) };
if rc != 0 {
return None;
}
Some(usage.ru_maxrss as u64)
}
/// Everything on the machine, all cores, in seconds of CPU.
fn system_cpu_seconds() -> Option<f64> {
let text = std::fs::read_to_string("/proc/stat").ok()?;
let line = text.lines().next()?;
// user nice system idle iowait irq softirq steal ...: sum the busy ones
// (idle and iowait excluded), matching the Python producer's definition.
let values: Vec<f64> = line
.split_whitespace()
.skip(1)
.filter_map(|value| value.parse::<f64>().ok())
.collect();
let busy = values.first()? + values.get(1)? + values.get(2)?
+ values.get(5)? + values.get(6)? + values.get(7)?;
Some(busy / ticks_per_second())
}
/// One process's utime+stime, in seconds.
fn pid_cpu_seconds(pid: u32) -> Option<f64> {
let text = std::fs::read_to_string(format!("/proc/{pid}/stat")).ok()?;
// The comm field is parenthesised and may contain spaces, so split after it.
let after_comm = text.rsplit_once(')')?.1;
let fields: Vec<&str> = after_comm.split_whitespace().collect();
let utime: f64 = fields.get(11)?.parse().ok()?;
let stime: f64 = fields.get(12)?.parse().ok()?;
Some((utime + stime) / ticks_per_second())
}
fn hyprland_pid() -> Option<u32> {
let entries = std::fs::read_dir("/proc").ok()?;
for entry in entries.flatten() {
let name = entry.file_name();
let name = name.to_string_lossy();
let Ok(pid) = name.parse::<u32>() else { continue };
let Ok(comm) = std::fs::read_to_string(format!("/proc/{pid}/comm")) else {
continue;
};
if comm.contains("Hyprland") {
return Some(pid);
}
}
None
}
struct MachineSample {
system_cpu: Option<f64>,
compositor_cpu: Option<f64>,
}
impl MachineSample {
fn take() -> Self {
let pid = hyprland_pid();
MachineSample {
system_cpu: system_cpu_seconds(),
compositor_cpu: pid.and_then(pid_cpu_seconds),
}
}
}
struct Summary {
min: f64,
p50: f64,
@@ -557,12 +395,6 @@ struct Report {
cpu_ms_per_frame: Option<f64>,
bytes_p50: Option<f64>,
persistent: bool,
rss_peak_mb: Option<f64>,
rss_peak_kb_raw: Option<u64>,
system_cpu_ms_per_frame: Option<f64>,
compositor_cpu_ms_per_frame: Option<f64>,
machine_cpu_pct: Option<f64>,
frames_bytes_allocated_p50: Option<u64>,
notes: String,
}
@@ -589,12 +421,6 @@ impl Report {
"cpu_ms_per_frame": self.cpu_ms_per_frame.map(round3),
"bytes_p50": self.bytes_p50.map(round3),
"persistent": self.persistent,
"rss_peak_mb": self.rss_peak_mb,
"rss_peak_kb_raw": self.rss_peak_kb_raw,
"system_cpu_ms_per_frame": self.system_cpu_ms_per_frame,
"compositor_cpu_ms_per_frame": self.compositor_cpu_ms_per_frame,
"machine_cpu_pct": self.machine_cpu_pct,
"frames_bytes_allocated_p50": self.frames_bytes_allocated_p50,
"notes": self.notes,
})
}
@@ -611,7 +437,6 @@ fn parse_args(args: impl IntoIterator<Item = String>) -> Result<Args, String> {
let mut frames: Option<u32> = None;
let mut warmup: Option<u32> = None;
let mut mode: Option<Mode> = None;
let mut backend = BackendChoice::Auto;
let mut json = false;
let mut index = 0;
while index < args.len() {
@@ -650,19 +475,6 @@ fn parse_args(args: impl IntoIterator<Item = String>) -> Result<Args, String> {
}
});
}
"--backend" => {
let value = need_value(&args, &mut index, "--backend")?;
backend = match value.as_str() {
"auto" => BackendChoice::Auto,
"wlr" => BackendChoice::Wlr,
"ext" => BackendChoice::Ext,
other => {
return Err(format!(
"--backend must be auto, wlr or ext, got {other:?}"
))
}
};
}
"--help" | "-h" => {
return Err(usage());
}
@@ -699,7 +511,6 @@ fn parse_args(args: impl IntoIterator<Item = String>) -> Result<Args, String> {
frames,
warmup,
mode,
backend,
})
}
@@ -722,7 +533,7 @@ fn parse_u32(value: &str, flag: &str) -> Result<u32, String> {
fn usage() -> String {
"usage: grimrs-capture (--output NAME | --all) --frames N --warmup W \
--mode raw|jpeg [--backend auto|wlr|ext] --json"
--mode raw|jpeg --json"
.to_string()
}
@@ -750,23 +561,6 @@ mod tests {
assert_eq!(all.mode, Mode::Jpeg);
}
#[test]
fn backend_defaults_to_the_crates_own_choice() {
// The default must be the crate's own auto-detect: forcing a backend
// is an experiment, not the route a production build would take.
let args = parse("--all --frames 1 --warmup 0 --mode raw --json").unwrap();
assert_eq!(args.backend, BackendChoice::Auto);
for (flag, want) in [
("wlr", BackendChoice::Wlr),
("ext", BackendChoice::Ext),
("auto", BackendChoice::Auto),
] {
let line = format!("--all --frames 1 --warmup 0 --mode raw --backend {flag} --json");
assert_eq!(parse(&line).unwrap().backend, want);
}
assert!(parse("--all --frames 1 --warmup 0 --mode raw --backend gpu --json").is_err());
}
#[test]
fn rejects_mixed_targets_and_missing_json() {
assert!(parse("--all --output x --frames 1 --warmup 0 --mode raw --json").is_err());
@@ -817,12 +611,6 @@ mod tests {
cpu_ms_per_frame: None,
bytes_p50: Some(100.5),
persistent: true,
rss_peak_mb: Some(12.5),
rss_peak_kb_raw: Some(12800),
system_cpu_ms_per_frame: Some(1.0),
compositor_cpu_ms_per_frame: Some(2.0),
machine_cpu_pct: Some(99.9),
frames_bytes_allocated_p50: Some(3686400),
notes: "n".to_string(),
};
let value = report.to_json();
@@ -841,12 +629,6 @@ mod tests {
"cpu_ms_per_frame",
"bytes_p50",
"persistent",
"rss_peak_mb",
"rss_peak_kb_raw",
"system_cpu_ms_per_frame",
"compositor_cpu_ms_per_frame",
"machine_cpu_pct",
"frames_bytes_allocated_p50",
"notes",
] {
assert!(value.get(key).is_some(), "missing {key}");
Binary file not shown.
-57
View File
@@ -1,57 +0,0 @@
# What crashes the compositor, and exactly when
Recorded from the delegated Claude session that spent its run on this, before that
session was shut down. Its finding is sharper than the one the benchmark itself
produced, so it is written down here rather than left in a tmux transcript.
## The trigger
Reproduced deliberately, not just observed:
1. Hold a live capture session on a **session's headless output** (route 001b's
`--protocol ext` producer, i.e. `ext-image-copy-capture-v1`).
2. Run `hhstream session kill` on that session, which destroys its output.
3. Call `create_frame` on the now-dangling capture session.
→ `SIGSEGV`, core dumped.
The kill is **not** the crash: the compositor dies inside
`ext-image-copy-capture`'s frame creation, on an output that no longer exists.
## The stack
```
#0 CScreenshareFrame::transform() const
#1 CImageCopyCaptureFrame::CImageCopyCaptureFrame(...)
#2 CExtImageCopyCaptureManagerV1Options... (createFrame)
#3 _CExtImageCopyCaptureSessionV1CreateFrame
...
#4 ffi_call_unix64
#10 wl_display_run
```
## Why it matters, and what was done about it
- It explains **three** compositor deaths during the benchmark (the two whose
stack reached `CScreenshareFrame::transform()`, and one in `libaquamarine`),
including one that happened mid-run and invalidated cells: the harness kills a
session between passes while a producer may still hold a capture session on it.
So the harness, not the protocol by itself, was pulling the trigger.
- It is the reason the candidate that was measured and **not** adopted is not
adopted: `ext-image-copy-capture-v1` measured no faster than
`zwlr-screencopy-v1` (78.0 vs 77.7 ms; compositor 67.5 vs 67.2 ms) and its
frame-creation path is the one that segfaults the compositor.
The `feat/pywayland-capture` branch therefore keeps the deprecated
`zwlr-screencopy-v1`, with the switch documented as one constant.
- The crash is in Hyprland (0.56.2, software rendering), not in the harness or in
pywayland. Anything that wants to propose it upstream will need this trigger,
because it is the reproducible part: hold a capture session, destroy the
output underneath it, then ask for a frame.
## Not established
- Whether `zwlr-screencopy-v1` survives the same dangling-output sequence. The
in-process backend in `feat/pywayland-capture` does handle the nearest
equivalent (`global_remove` drops the output, and the next `grab()` reconnects
and re-selects) — but that path has not been exercised against a real session
kill, which is the obvious next experiment.
-163
View File
@@ -1,163 +0,0 @@
# capture-speed — can we drop `grim`, and what would it buy?
**Question** (the operator's): which capture route renders images faster for live
streaming the workspaces to the web and for agent eyes — the shipped `grim`
subprocess, the Rust `grim-rs` crate, or a raw `pywayland` client? And what does
each cost in RAM and CPU?
**Answer**: in-process wins, decisively and cheaply — **~1.5× the frame rate,
~2.8× less of our own CPU, and ~42% less CPU *inside the compositor*** — and
neither Rust nor the newer capture protocol is needed to get it. `grim-rs` is no
faster than the subprocess it would replace and costs **746 MB** of RSS to grim's
18 MB.
## Method
One frozen contract (`HARNESS.md`), one runner (`bench.py`), one target per pass.
- **Target**: a Chromium session on a **CSS-animated** page (no JavaScript, no
timers) so the screen genuinely changes; frames verified to differ between
captures before any run. The still half of the contract lives in `results/still/`
and `results/final-still/` (partial — see "What went wrong").
- **Cells**: one session's container at 1280×720, `raw` and `jpeg q80`, **200
measured frames per run, 2 runs each** (the contract asks 300; 200 is stated
here rather than hidden).
- **Baseline**: `grim` exactly as it ships — one process per frame, fork and
encode inside the timed span.
- **Resources**: producer CPU/RSS (`getrusage`), machine CPU (`/proc/stat`), the
**compositor's own** CPU (`/proc/<Hyprland>/stat`), and an idle **control**
sample with nothing capturing, so an animating page's cost is not attributed
to a route.
- **No GPU**: Hyprland renders through software (kms_swrast/llvmpipe). No route
was tuned to a dma-buf path, and none is claimed. Each producer reports which
protocol actually served its frames.
## Head-to-head — 1280×720, moving screen, one session, sessions run sequentially
| route | mode | p50 ms | fps | own CPU ms | machine CPU ms | **compositor CPU ms** | machine % | **RSS MB** |
|---|---|---|---|---|---|---|---|---|
| `grim` (subprocess, ships today) | jpeg | 117.3 | 8.1 | 5.03 | 247.9 | **116.4** | 199.1 | **18.5** |
| `grim` | raw | 121.4 | 7.9 | 3.86 | 255.2 | 118.4 | 199.4 | 20.5 |
| `grim-rs` (Rust crate) | jpeg | 124.6 | 7.5 | 6.60 | 266.7 | 123.1 | 199.2 | **746.3** |
| `grim-rs` | raw | 120.1 | 7.8 | 1.59 | 254.1 | 119.2 | 198.9 | 746.1 |
| **`pywayland` screencopy** | jpeg | **78.0** | **13.9** | **1.78** | **143.0** | **67.5** | 199.1 | 29.3 |
| `pywayland` screencopy | raw | 76.7 | 14.2 | 0.33 | 140.4 | 67.1 | 198.7 | 24.4 |
| `pywayland` ext-image-copy-capture | jpeg | 77.7 | 14.0 | 1.79 | 142.2 | 67.2 | 199.3 | 29.1 |
| `pywayland` ext-image-copy-capture | raw | 73.5 | 14.4 | 0.31 | 138.5 | 66.2 | 198.9 | 24.5 |
Idle control — nothing capturing at all: **199.1% of one core**, the compositor
alone at 94.1%. Frames are 105–130 KB as JPEG, 2.76 MB as raw PPM.
### What the table says
1. **In-process is ~1.5× faster and much cheaper**: 78 ms vs 117 ms, 13.9 fps vs
8.1, our own CPU 1.8 ms vs 5.0 ms per frame.
2. **The win that matters is the compositor's, not ours**: 67 ms vs 116 ms of
compositor CPU *per frame*. On a 2-core box that is the difference between the
desktop being starved and merely busy.
3. **`grim-rs` is not a candidate**: slightly slower than the subprocess (124.6
vs 117.3 ms), *higher* own CPU (6.6 vs 5.0 ms), and **746 MB RSS** — 40× grim.
Its own notes explain the speed: it allocates a fresh shm buffer and copies
into a `Vec` per capture. The memory figure is reproducible across runs.
4. **screencopy vs ext-image-copy-capture: no measurable difference** (78.0 vs
77.7 ms; compositor 67.5 vs 67.2 ms). The newer protocol buys nothing here, and
its frame-creation path is where one compositor crash landed — so the
recommendation is the older, deprecated-but-working protocol, which is also
what `grim` uses (apples to apples).
5. **The box is saturated in every cell (≈199% of one core)** — and the idle
control is *also* 199%. Rendering the animating screen, not capturing it, is
what fills this machine. No capture change fixes that; what changes is how much
room the compositor has left.
## Where the time actually goes (the finding that reframes it)
`grim` at 1280×720 JPEG q80 spends ~95% of each frame **waiting** — on the fork,
the connect, the compositor's round trip — not encoding: JPEG q80 of a 1280×720
frame costs **1.7 ms** in-process. So the available win is in *not paying the
round trip per frame*, which is exactly what a persistent in-process client does —
and why screencopy and ext-image-copy-capture land within noise of each other.
## What went wrong (each item cost real time; none is hidden)
- **The compositor crashed three times** during measurement (`.Hyprland-wrapped`
SEGV in `CScreenshareFrame::transform()` reached via
`ext-image-copy-capture`'s `create_frame`, plus twice in `libaquamarine`),
taking the stream/sessions/pointer units and both session outputs with it. When
that happened, cells failed and `hhstream status` hung for minutes. **The ext
stack could not be reproduced in isolation** (5 clean frames afterwards), so
this is recorded as *unstable under sustained capture load*, not as "the modern
protocol is broken".
- **Our own client segfaulted on exit 16 times** (`python3.14 … segfault …
libwayland-client.so`) — pywayland/CFFI teardown, *after* the result printed, so
green runs reported exit 139. Fixed with `os._exit(0)` after flushing. A batch
of these coincided in time with a compositor crash, so the fix may matter
beyond tidiness.
- **Two SIGTERM kills of the benchmark** (exit 143, no error line): a 40-minute
`nix-shell` tree does not belong in an agent background process. Moved to a
transient systemd unit, and the runner made resumable.
- **`grim -o NAME` must precede the trailing `-`**, or grim exits 0 having written
**637 bytes of nothing**.
- **grim's only uncompressed format is `ppm`**; `pbm`/`pnm`/`rgb`/`bmp` are
rejected. Raw is *not* cheaper than JPEG for it — writing 2.76 MB down a pipe
costs what encoding costs.
- **turbojpeg reuses a non-NULL `*jpegBuf`**: freeing it and leaving the pointer
makes the next call write into freed memory (heap-corrupting segfault with no
stack trace near the encoder).
- **`display.dispatch(block=False)` never reads the socket** — it processes only
what is already read, so a wait built on it times out against a healthy
compositor. The read is `dispatch(block=True)`.
- **`ext-image-capture-source-v1` has one manager per source kind**
(`ext_output_…`, `ext_foreign_toplevel_…`). Looking for a generic
`ext_image_capture_source_manager_v1` finds nothing and reads as "the modern
protocol is unavailable" — a wrong conclusion this spike drew once. The
toplevel variant means **single-window capture is available**, which matters
for agent eyes.
- **`--all` cells silently changed geometry** (2560→3840) once a second session
existed, so they are excluded from this table rather than averaged.
- **A `--resume` keyed on file existence skips failed cells too**, because a
failure also writes a file; it now requires a parseable result line.
## Verdict: VALIDATED — with a caveat that changes the shape of the answer
- **Replace `grim` with an in-process `pywayland` client on `zwlr-screencopy`**
for the one-session case (live streaming a workspace, agent eyes). ~1.5×
faster, ~2.8× less own CPU, and — the number that decides it — **the
compositor's per-frame CPU nearly halves**.
- **Do not adopt `grim-rs`**: no speed win, 40× the memory.
- **Do not adopt `ext-image-copy-capture` yet** on this Hyprland build: no
measured gain, and its create-frame path appears in a compositor crash stack.
- **Keep raw/ppm out of the wire path**: it is not cheaper than JPEG anywhere
measured.
- **The caveat**: on this software-rendered 2-core VM the machine is saturated by
*rendering* whatever is on screen, in every configuration including idle. The
frame-rate win is real, but no capture change buys headroom — it changes how
much of a saturated box the compositor keeps.
## What a production version would take
- Replace the subprocess behind `src/hhstream/capture.py`'s `CommandCapture` with
a pywayland screencopy client: ~250 lines, vendored protocol XML (the pattern
already used by `src/hhstream_pointer/_protocol/`), and **no new dependency** —
`pywayland` is already a dependency of the package, so the stdlib-only policy
for the frame socket, CLI and broker is untouched.
- JPEG encoding then needs libjpeg-turbo via ctypes (stdlib `zlib` PNG is the
fallback, at 2–3× the bytes) — that *is* a genuine new dependency for that
module, and the one thing worth arguing about in review.
- Single-window capture comes free via
`ext_foreign_toplevel_image_capture_source_manager_v1`; worth a follow-up spike
once the compositor's stability under sustained capture is understood.
## Files
| File | What it is |
|---|---|
| `HARNESS.md` | the frozen measurement contract (argv, JSON, timing boundary, resource fields) |
| `bench.py` | the runner: every route through every cell, raw JSON kept, table derived from the files, `--resume` |
| `producers/grim_producer.py` | route 000, the baseline |
| `producers/wayland_producer.py` | route 001b, raw `pywayland` (screencopy *and* ext-image-copy-capture) |
| `producers/resources.py` | RAM/CPU sampling shared by the Python producers |
| `001a-grim-rs/` | route 001a, the Rust `grim-rs` producer (Rust toolchain confined to its own `shell.nix`) |
| `run-final.sh`, `run-remaining.sh` | the pass drivers, meant to run in a transient systemd unit |
| `chart.py` | the two charts (`python3 chart.py results/final-motion`) |
| `results/final-motion/` | the table above, its chart, and every run's raw stdout/stderr |
| `shell.nix` | the spike's environment — deliberately not in the repo flake |
-223
View File
@@ -1,223 +0,0 @@
#!/usr/bin/env python3
"""Run every route through the frozen contract and print a head-to-head.
The point of a runner rather than a shell loop: the *same* cells get run for
every route with identical arguments, the raw JSON of every run is kept, and the
table is derived from those files instead of from what anyone remembers seeing.
./bench.py --output hh-<session> --frames 300 --runs 2
./bench.py --output hh-<session> --only grim --cells output-jpeg
Routes are commands, so a route that is not built yet simply fails and is
reported as a failed cell rather than quietly omitted.
"""
from __future__ import annotations
import argparse
import json
import os
import shlex
import subprocess
import sys
import time
HERE = os.path.dirname(os.path.abspath(__file__))
PRODUCERS = os.path.join(HERE, "producers")
RUST = os.path.join(HERE, "001a-grim-rs", "target", "release", "grimrs-capture")
ROUTES = {
# name: (description, command builder)
"grim": (
"grim subprocess per frame (shipped)",
lambda o, cell, frames, warmup: [
sys.executable, os.path.join(PRODUCERS, "grim_producer.py"),
*(["--all"] if cell["all"] else ["--output", o]),
"--frames", str(frames), "--warmup", str(warmup), "--mode", cell["mode"], "--json",
],
),
"py-screencopy": (
"pywayland in-process, zwlr-screencopy-v1",
lambda o, cell, frames, warmup: [
sys.executable, os.path.join(PRODUCERS, "wayland_producer.py"),
*(["--all"] if cell["all"] else ["--output", o]),
"--protocol", "screencopy",
"--frames", str(frames), "--warmup", str(warmup), "--mode", cell["mode"], "--json",
],
),
"py-ext": (
"pywayland in-process, ext-image-copy-capture-v1",
lambda o, cell, frames, warmup: [
sys.executable, os.path.join(PRODUCERS, "wayland_producer.py"),
*(["--all"] if cell["all"] else ["--output", o]),
"--protocol", "ext",
"--frames", str(frames), "--warmup", str(warmup), "--mode", cell["mode"], "--json",
],
),
"grim-rs": (
"grim-rs crate (Rust), long-lived process",
lambda o, cell, frames, warmup: [
RUST,
*(["--all"] if cell["all"] else ["--output", o]),
"--frames", str(frames), "--warmup", str(warmup), "--mode", cell["mode"], "--json",
],
),
}
CELLS = [
{"name": "output-raw", "all": False, "mode": "raw"},
{"name": "output-jpeg", "all": False, "mode": "jpeg"},
{"name": "all-raw", "all": True, "mode": "raw"},
{"name": "all-jpeg", "all": True, "mode": "jpeg"},
]
def idle_control(seconds: float) -> dict:
"""What the machine burns with nothing capturing at all.
Without this the resource columns are unreadable: on a software-rendered
compositor an animating page can saturate both cores on its own, and a
per-frame CPU number that includes the animation would be attributed to the
capture route. This is the number to subtract -- and it is also the reason
the verdict has to talk about *what the machine was doing*, not just fps.
"""
sys.path.insert(0, PRODUCERS)
from resources import MachineSample # noqa: E402
before = MachineSample(children=False)
time.sleep(seconds)
after = MachineSample(children=False)
window_ms = seconds * 1000.0
system_ms = None
compositor_ms = None
if before.system_cpu is not None and after.system_cpu is not None:
system_ms = (after.system_cpu - before.system_cpu) * 1000.0
if before.compositor_cpu is not None and after.compositor_cpu is not None:
compositor_ms = (after.compositor_cpu - before.compositor_cpu) * 1000.0
return {
"window_ms": round(window_ms, 1),
"system_cpu_ms": None if system_ms is None else round(system_ms, 1),
"compositor_cpu_ms": None if compositor_ms is None else round(compositor_ms, 1),
"system_cpu_pct": None if system_ms is None else round(system_ms / window_ms * 100.0, 1),
"compositor_cpu_pct": None if compositor_ms is None else round(compositor_ms / window_ms * 100.0, 1),
}
def main() -> int:
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("--output", required=True, help="the session container output to measure")
parser.add_argument("--frames", type=int, default=300)
parser.add_argument("--warmup", type=int, default=10)
parser.add_argument("--runs", type=int, default=2)
parser.add_argument("--only", action="append", help="restrict to these route names")
parser.add_argument("--cells", action="append", help="restrict to these cell names")
parser.add_argument("--results", default=os.path.join(HERE, "..", "results"))
parser.add_argument("--env", action="append", default=[], help="KEY=VALUE for the producers")
parser.add_argument("--control-seconds", type=float, default=0.0,
help="sample machine CPU with no captures for this long, as a control")
parser.add_argument("--resume", action="store_true",
help="skip any cell whose result file already exists (for re-running after a kill)")
args = parser.parse_args()
routes = {k: v for k, v in ROUTES.items() if not args.only or k in args.only}
cells = [c for c in CELLS if not args.cells or c["name"] in args.cells]
os.makedirs(args.results, exist_ok=True)
control = None
if args.control_seconds > 0:
print(f"control: sampling {args.control_seconds:.0f}s with nothing capturing...")
control = idle_control(args.control_seconds)
print(f" idle machine CPU: {control['system_cpu_pct']}% of one core "
f"({control['system_cpu_ms'] / control['window_ms'] * 1000:.0f} ms of CPU per second), "
f"compositor {control['compositor_cpu_pct']}% of one core")
with open(os.path.join(args.results, "control.json"), "w") as handle:
json.dump(control, handle, indent=2)
env = dict(os.environ)
for item in args.env:
key, _, value = item.partition("=")
env[key] = value
records: list[dict] = []
failures: list[str] = []
for route, (description, build) in routes.items():
for cell in cells:
for run in range(1, args.runs + 1):
command = build(args.output, cell, args.frames, args.warmup)
label = f"{route}/{cell['name']}/run{run}"
stem = os.path.join(args.results, f"{route}.{cell['name']}.run{run}")
if args.resume and os.path.exists(stem + ".stdout"):
# A *failed* cell also leaves a stdout file, so existence is
# not the test -- a parseable result line is. Otherwise one
# failure is skipped forever and the table shows a permanent
# gap that looks like it was never attempted.
with open(stem + ".stdout") as handle:
lines = [line for line in handle.read().splitlines() if line.startswith("{")]
if lines:
print(f" {label}: already measured, skipped (--resume)")
try:
records.append({"route": route, "description": description,
"cell": cell["name"], "run": run, "rc": 0,
**json.loads(lines[-1])})
except json.JSONDecodeError:
pass
continue
print(f" {label}: previous attempt left no result, re-running")
started = time.monotonic()
proc = subprocess.run(command, capture_output=True, text=True, env=env)
elapsed = time.monotonic() - started
with open(stem + ".stdout", "w") as handle:
handle.write(proc.stdout)
with open(stem + ".stderr", "w") as handle:
handle.write(proc.stderr)
record = {"route": route, "description": description, "cell": cell["name"],
"run": run, "command": " ".join(shlex.quote(part) for part in command),
"rc": proc.returncode, "elapsed_s": round(elapsed, 1)}
last = [line for line in proc.stdout.splitlines() if line.startswith("{")]
if proc.returncode == 0 and last:
record.update(json.loads(last[-1]))
print(f" {label}: p50 {record['frame_ms']['p50']} ms, "
f"{record['fps_sustained']} fps, cpu {record['cpu_ms_per_frame']} ms")
else:
record["error"] = (proc.stderr or proc.stdout).strip().splitlines()[-1:] or ["no output"]
failures.append(label)
print(f" {label}: FAILED rc={proc.returncode} -- {record['error']}")
records.append(record)
with open(os.path.join(args.results, "results.json"), "w") as handle:
json.dump(records, handle, indent=2)
print("\n=== head-to-head (median of runs; jpeg cells are the ones the wire carries) ===")
print("speed | machine cost | footprint")
print(f"{'route':<15} {'cell':<12} {'p50 ms':>8} {'fps':>6} {'own cpu':>8} {'sys cpu':>8} "
f"{'comp cpu':>9} {'machine%':>9} {'rss MB':>7} {'bytes':>9}")
for route in routes:
for cell in cells:
group = [r for r in records if r.get("route") == route and r.get("cell") == cell["name"]]
good = [r for r in group if "frame_ms" in r]
if not good:
print(f"{route:<15} {cell['name']:<12} {'--':>8} {'--':>6} {'--':>8} {'--':>8} {'--':>9} {'--':>9} {'--':>7} (no successful run)")
continue
def median(key, default=0.0):
values = sorted(r.get(key) or 0 for r in good)
return values[len(values) // 2] if values else default
p50 = sorted(r["frame_ms"]["p50"] for r in good)[len(good) // 2]
print(f"{route:<15} {cell['name']:<12} {p50:>8} "
f"{sorted(r['fps_sustained'] for r in good)[len(good)//2]:>6} "
f"{median('cpu_ms_per_frame'):>8} {median('system_cpu_ms_per_frame'):>8} "
f"{median('compositor_cpu_ms_per_frame'):>9} {median('machine_cpu_pct'):>9} "
f"{median('rss_peak_mb'):>7} {int(median('bytes_p50')):>9}")
if control:
print(f"\ncontrol (nothing capturing): {control['system_cpu_pct']}% of one core, "
f"compositor {control['compositor_cpu_ms']} ms/s")
print(" subtract this from 'sys cpu' before attributing CPU to a route.")
if failures:
print(f"\nfailed cells: {', '.join(failures)}")
print(f"\nraw runs: {args.results}/")
return 0
if __name__ == "__main__":
sys.exit(main())
-140
View File
@@ -1,140 +0,0 @@
#!/usr/bin/env python3
"""Turn results/results.json into the two pictures that decide this.
One chart per question, because they answer different things:
- **speed**: p50 frame time and sustained fps per route and cell -- which route is
quickest;
- **machine cost**: the compositor's CPU per frame per route -- which route leaves
the box able to render, which is the question the frame rate does not answer.
The idle control is drawn as a line on the cost chart so a reader can see how
much of the machine was busy before any capture happened.
nix-shell --run "python3 chart.py" # -> results/head-to-head.png
"""
from __future__ import annotations
import json
import os
import statistics
import sys
import matplotlib
matplotlib.use("Agg")
import matplotlib.pyplot as plt # noqa: E402
HERE = os.path.dirname(os.path.abspath(__file__))
# Which pass to chart: `python3 chart.py results/final-motion`
RESULTS = os.path.join(HERE, sys.argv[1] if len(sys.argv) > 1 else "results")
LABELS = {
"grim": "grim (subprocess)",
"grim-rs": "grim-rs (Rust)",
"py-screencopy": "pywayland\nscreencopy",
"py-ext": "pywayland\next-copy-capture",
}
ORDER = ["grim", "grim-rs", "py-screencopy", "py-ext"]
CELLS = ["output-jpeg", "output-raw", "all-jpeg", "all-raw"]
def load() -> tuple[list[dict], dict | None]:
with open(os.path.join(RESULTS, "results.json")) as handle:
records = json.load(handle)
control = None
try:
with open(os.path.join(RESULTS, "control.json")) as handle:
control = json.load(handle)
except OSError:
pass
return records, control
def cell_value(records: list[dict], route: str, cell: str, key: str) -> float | None:
values = [
r.get(key)
for r in records
if r.get("route") == route and r.get("cell") == cell and r.get(key) is not None
]
if not values:
return None
return statistics.median(values)
def main() -> int:
records, control = load()
routes = [r for r in ORDER if any(rec.get("route") == r for rec in records)]
if not routes:
print("no successful runs in results.json", file=sys.stderr)
return 1
fig, axes = plt.subplots(1, 2, figsize=(15, 6.5), facecolor="#0f1115")
for axis in axes:
axis.set_facecolor("#0f1115")
for spine in axis.spines.values():
spine.set_color("#475569")
axis.tick_params(colors="#cbd5e1", labelsize=9)
axis.grid(axis="y", color="#1e293b", linewidth=0.8)
axis.set_axisbelow(True)
width = 0.8 / len(routes)
colours = ["#f87171", "#fbbf24", "#60a5fa", "#34d399"]
# -- left: speed ---------------------------------------------------------
axis = axes[0]
for index, route in enumerate(routes):
values, positions = [], []
for cell_index, cell in enumerate(CELLS):
value = cell_value(records, route, cell, "fps_sustained")
if value is None:
continue
values.append(value)
positions.append(cell_index + index * width)
axis.bar(positions, values, width, label=LABELS.get(route, route),
color=colours[index % len(colours)], edgecolor="#0f1115")
axis.set_title("speed — sustained frames per second", color="#e2e8f0", fontsize=12)
axis.set_xticks([i + 0.4 - width / 2 for i in range(len(CELLS))])
axis.set_xticklabels([c.replace("-", "\n") for c in CELLS], fontsize=8)
axis.set_ylabel("fps", color="#cbd5e1")
axis.legend(facecolor="#111827", edgecolor="#334155", labelcolor="#e2e8f0", fontsize=8)
# -- right: what it costs the compositor --------------------------------
axis = axes[1]
for index, route in enumerate(routes):
values, positions = [], []
for cell_index, cell in enumerate(CELLS):
value = cell_value(records, route, cell, "compositor_cpu_ms_per_frame")
if value is None:
continue
values.append(value)
positions.append(cell_index + index * width)
axis.bar(positions, values, width, label=LABELS.get(route, route),
color=colours[index % len(colours)], edgecolor="#0f1115")
axis.set_title("cost — the compositor's own CPU per frame (lower is better)",
color="#e2e8f0", fontsize=12)
axis.set_xticks([i + 0.4 - width / 2 for i in range(len(CELLS))])
axis.set_xticklabels([c.replace("-", "\n") for c in CELLS], fontsize=8)
axis.set_ylabel("ms of compositor CPU per frame", color="#cbd5e1")
if control and control.get("compositor_cpu_ms") is not None:
per_frame_note = (
f"idle control: machine {control['system_cpu_pct']}% of one core "
f"with nothing capturing"
)
axis.text(0.02, 0.95, per_frame_note, transform=axis.transAxes,
color="#94a3b8", fontsize=8, va="top")
axis.legend(facecolor="#111827", edgecolor="#334155", labelcolor="#e2e8f0", fontsize=8)
fig.suptitle("hhstream capture routes — 1280×720 container and 2560×720 stitched, "
"jpeg q80 and raw, moving screen, software rendering, no GPU",
color="#e2e8f0", fontsize=11)
fig.tight_layout(rect=(0, 0, 1, 0.95))
out = os.path.join(RESULTS, "head-to-head.png")
fig.savefig(out, dpi=140, facecolor="#0f1115")
print(out)
return 0
if __name__ == "__main__":
sys.exit(main())
-77
View File
@@ -1,77 +0,0 @@
#!/usr/bin/env python3
"""What does a per-frame copy + swizzle cost? Isolating the grim-rs gap.
The suspicion this answers: a compiled Rust library should not be *slower* than a
subprocess, and pure Python should not be faster than either. The explanation
under test is that the routes are not doing the same work.
grim-rs's public API returns owned pixels -- per capture it does
`mmap.to_vec()` plus an XRGB/ARGB -> RGBA swizzle (its own source, and its own
notes in the results). Our producer hands the mapped buffer straight to the
encoder: no allocation, no copy, no conversion.
So this measures what that extra work costs on this box, on its own, with no
compositor involved: allocate a mapping the size of one 1280x720 frame, then time
(a) copying it out and (b) swizzling it, per frame, over 200 frames.
If the copy+swizzle costs about the gap between our number (~78 ms) and grim-rs's
(~124 ms), then the difference is the work, not the language -- and the honest
conclusion is "a client that reuses its buffer beats one that does not", not
"Python beats Rust".
"""
from __future__ import annotations
import mmap
import os
import statistics
import sys
import time
WIDTH, HEIGHT = 1280, 720
STRIDE = WIDTH * 4
SIZE = STRIDE * HEIGHT
FRAMES = 200
def main() -> int:
memory = mmap.mmap(-1, SIZE)
# Fill with something non-trivial so the copy is not optimised away.
memory.write(b"\x01\x02\x03\x04" * (SIZE // 4))
copies: list[float] = []
swizzles: list[float] = []
both: list[float] = []
for _ in range(FRAMES):
start = time.monotonic_ns()
pixels = bytes(memoryview(memory))
copies.append((time.monotonic_ns() - start) / 1e6)
start = time.monotonic_ns()
swapped = bytearray(len(pixels))
swapped[0::4] = pixels[2::4]
swapped[1::4] = pixels[1::4]
swapped[2::4] = pixels[2::4]
swapped[3::4] = pixels[3::4]
swizzles.append((time.monotonic_ns() - start) / 1e6)
both.append(copies[-1] + swizzles[-1])
del pixels, swapped
print(f"frame: {WIDTH}x{HEIGHT}, {SIZE / 1e6:.2f} MB, {FRAMES} frames")
for label, samples in (("copy only (mmap -> Vec)", copies),
("swizzle only (BGRX -> RGBA)", swizzles),
("copy + swizzle", both)):
print(f" {label:<28} p50 {statistics.median(samples):>6.2f} ms "
f"min {min(samples):>6.2f} max {max(samples):>6.2f}")
print("\nAdd 'copy + swizzle' to the in-process route's number to compare it "
"against a library that returns owned pixels.")
memory.close()
# Flush before `os._exit`: os._exit skips the interpreter's cleanup, so
# buffered stdout is dropped -- the first run of this printed nothing at all.
sys.stdout.flush()
os._exit(0)
if __name__ == "__main__":
raise SystemExit(main())
Whitespace-only changes.
@@ -1,30 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2018 Ilia Bozhinov
# Copyright © 2020 Isaac Freund
# Copyright © 2022 wb9688
# Copyright © 2023 i509VCB
#
# Permission to use, copy, modify, distribute, and sell this
# software and its documentation for any purpose is hereby granted
# without fee, provided that the above copyright notice appear in
# all copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of
# the copyright holders not be used in advertising or publicity
# pertaining to distribution of the software without specific,
# written prior permission. The copyright holders make no
# representations about the suitability of this software for any
# purpose. It is provided "as is" without express or implied
# warranty.
#
# THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
# SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
# FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
# SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
# AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
# ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
# THIS SOFTWARE.
from .ext_foreign_toplevel_handle_v1 import ExtForeignToplevelHandleV1 # noqa: F401
from .ext_foreign_toplevel_list_v1 import ExtForeignToplevelListV1 # noqa: F401
@@ -1,191 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2018 Ilia Bozhinov
# Copyright © 2020 Isaac Freund
# Copyright © 2022 wb9688
# Copyright © 2023 i509VCB
#
# Permission to use, copy, modify, distribute, and sell this
# software and its documentation for any purpose is hereby granted
# without fee, provided that the above copyright notice appear in
# all copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of
# the copyright holders not be used in advertising or publicity
# pertaining to distribution of the software without specific,
# written prior permission. The copyright holders make no
# representations about the suitability of this software for any
# purpose. It is provided "as is" without express or implied
# warranty.
#
# THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
# SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
# FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
# SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
# AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
# ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
# THIS SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
class ExtForeignToplevelHandleV1(Interface):
"""A mapped toplevel
A :class:`ExtForeignToplevelHandleV1` object represents a mapped toplevel
window. A single app may have multiple mapped toplevels.
"""
name = "ext_foreign_toplevel_handle_v1"
version = 1
class ExtForeignToplevelHandleV1Proxy(Proxy[ExtForeignToplevelHandleV1]):
interface = ExtForeignToplevelHandleV1
@ExtForeignToplevelHandleV1.request()
def destroy(self) -> None:
"""Destroy the :class:`ExtForeignToplevelHandleV1` object
This request should be used when the client will no longer use the
handle or after the closed event has been received to allow destruction
of the object.
When a handle is destroyed, a new handle may not be created by the
server until the toplevel is unmapped and then remapped. Destroying a
toplevel handle is not recommended unless the client is cleaning up
child objects before destroying the
:class:`~pywayland.protocol.ext_foreign_toplevel_list_v1.ExtForeignToplevelListV1`
object, the toplevel was closed or the toplevel handle will not be used
in the future.
Other protocols which extend the :class:`ExtForeignToplevelHandleV1`
interface should require destructors for extension interfaces be called
before allowing the toplevel handle to be destroyed.
"""
self._marshal(0)
self._destroy()
class ExtForeignToplevelHandleV1Resource(Resource):
interface = ExtForeignToplevelHandleV1
@ExtForeignToplevelHandleV1.event()
def closed(self) -> None:
"""The toplevel has been closed
The server will emit no further events on the
:class:`ExtForeignToplevelHandleV1` after this event. Any requests
received aside from the destroy request must be ignored. Upon receiving
this event, the client should destroy the handle.
Other protocols which extend the :class:`ExtForeignToplevelHandleV1`
interface must also ignore requests other than destructors.
"""
self._post_event(0)
@ExtForeignToplevelHandleV1.event()
def done(self) -> None:
"""All information about the toplevel has been sent
This event is sent after all changes in the toplevel state have been
sent.
This allows changes to the :class:`ExtForeignToplevelHandleV1`
properties to be atomically applied. Other protocols which extend the
:class:`ExtForeignToplevelHandleV1` interface may use this event to
also atomically apply any pending state.
This event must not be sent after the
:func:`ExtForeignToplevelHandleV1.closed()` event.
"""
self._post_event(1)
@ExtForeignToplevelHandleV1.event(
Argument(ArgumentType.String),
)
def title(self, title: str) -> None:
"""Title change
The title of the toplevel has changed.
The configured state must not be applied immediately. See
:func:`ExtForeignToplevelHandleV1.done()` for details.
:param title:
:type title:
`ArgumentType.String`
"""
self._post_event(2, title)
@ExtForeignToplevelHandleV1.event(
Argument(ArgumentType.String),
)
def app_id(self, app_id: str) -> None:
"""App_id change
The app id of the toplevel has changed.
The configured state must not be applied immediately. See
:func:`ExtForeignToplevelHandleV1.done()` for details.
:param app_id:
:type app_id:
`ArgumentType.String`
"""
self._post_event(3, app_id)
@ExtForeignToplevelHandleV1.event(
Argument(ArgumentType.String),
)
def identifier(self, identifier: str) -> None:
"""A stable identifier for a toplevel
This identifier is used to check if two or more toplevel handles belong
to the same toplevel.
The identifier is useful for command line tools or privileged clients
which may need to reference an exact toplevel across processes or
instances of the
:class:`~pywayland.protocol.ext_foreign_toplevel_list_v1.ExtForeignToplevelListV1`
global.
The compositor must only send this event when the handle is created.
The identifier must be unique per toplevel and its handles. Two
different toplevels must not have the same identifier. The identifier
is only valid as long as the toplevel is mapped. If the toplevel is
unmapped the identifier must not be reused. An identifier must not be
reused by the compositor to ensure there are no races when sharing
identifiers between processes.
An identifier is a string that contains up to 32 printable ASCII bytes.
An identifier must not be an empty string. It is recommended that a
compositor includes an opaque generation value in identifiers. How the
generation value is used when generating the identifier is
implementation dependent.
:param identifier:
:type identifier:
`ArgumentType.String`
"""
self._post_event(4, identifier)
class ExtForeignToplevelHandleV1Global(Global):
interface = ExtForeignToplevelHandleV1
ExtForeignToplevelHandleV1._gen_c()
ExtForeignToplevelHandleV1.proxy_class = ExtForeignToplevelHandleV1Proxy
ExtForeignToplevelHandleV1.resource_class = ExtForeignToplevelHandleV1Resource
ExtForeignToplevelHandleV1.global_class = ExtForeignToplevelHandleV1Global
@@ -1,150 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2018 Ilia Bozhinov
# Copyright © 2020 Isaac Freund
# Copyright © 2022 wb9688
# Copyright © 2023 i509VCB
#
# Permission to use, copy, modify, distribute, and sell this
# software and its documentation for any purpose is hereby granted
# without fee, provided that the above copyright notice appear in
# all copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of
# the copyright holders not be used in advertising or publicity
# pertaining to distribution of the software without specific,
# written prior permission. The copyright holders make no
# representations about the suitability of this software for any
# purpose. It is provided "as is" without express or implied
# warranty.
#
# THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
# SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
# FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
# SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
# AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
# ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
# THIS SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .ext_foreign_toplevel_handle_v1 import ExtForeignToplevelHandleV1
class ExtForeignToplevelListV1(Interface):
"""List toplevels
A toplevel is defined as a surface with a role similar to xdg_toplevel.
XWayland surfaces may be treated like toplevels in this protocol.
After a client binds the :class:`ExtForeignToplevelListV1`, each mapped
toplevel window will be sent using the
:func:`ExtForeignToplevelListV1.toplevel()` event.
Clients which only care about the current state can perform a roundtrip
after binding this global.
For each instance of :class:`ExtForeignToplevelListV1`, the compositor must
create a new
:class:`~pywayland.protocol.ext_foreign_toplevel_list_v1.ExtForeignToplevelHandleV1`
object for each mapped toplevel.
If a compositor implementation sends the
:func:`ExtForeignToplevelListV1.finished()` event after the global is
bound, the compositor must not send any
:func:`ExtForeignToplevelListV1.toplevel()` events.
"""
name = "ext_foreign_toplevel_list_v1"
version = 1
class ExtForeignToplevelListV1Proxy(Proxy[ExtForeignToplevelListV1]):
interface = ExtForeignToplevelListV1
@ExtForeignToplevelListV1.request()
def stop(self) -> None:
"""Stop sending events
This request indicates that the client no longer wishes to receive
events for new toplevels.
The Wayland protocol is asynchronous, meaning the compositor may send
further toplevel events until the stop request is processed. The client
should wait for a :func:`ExtForeignToplevelListV1.finished()` event
before destroying this object.
"""
self._marshal(0)
@ExtForeignToplevelListV1.request()
def destroy(self) -> None:
"""Destroy the :class:`ExtForeignToplevelListV1` object
This request should be called either when the client will no longer use
the :class:`ExtForeignToplevelListV1` or after the finished event has
been received to allow destruction of the object.
If a client wishes to destroy this object it should send a
:func:`ExtForeignToplevelListV1.stop()` request and wait for a
:func:`ExtForeignToplevelListV1.finished()` event, then destroy the
handles and then this object.
"""
self._marshal(1)
self._destroy()
class ExtForeignToplevelListV1Resource(Resource):
interface = ExtForeignToplevelListV1
@ExtForeignToplevelListV1.event(
Argument(ArgumentType.NewId, interface=ExtForeignToplevelHandleV1),
)
def toplevel(self, toplevel: ExtForeignToplevelHandleV1) -> None:
"""A toplevel has been created
This event is emitted whenever a new toplevel window is created. It is
emitted for all toplevels, regardless of the app that has created them.
All initial properties of the toplevel (identifier, title, app_id) will
be sent immediately after this event using the corresponding events for
:class:`~pywayland.protocol.ext_foreign_toplevel_list_v1.ExtForeignToplevelHandleV1`.
The compositor will use the :func:`ExtForeignToplevelHandleV1.done()
<pywayland.protocol.ext_foreign_toplevel_list_v1.ExtForeignToplevelHandleV1.done>`
event to indicate when all data has been sent.
:param toplevel:
:type toplevel:
:class:`~pywayland.protocol.ext_foreign_toplevel_list_v1.ExtForeignToplevelHandleV1`
"""
self._post_event(0, toplevel)
@ExtForeignToplevelListV1.event()
def finished(self) -> None:
"""The compositor has finished with the toplevel manager
This event indicates that the compositor is done sending events to this
object. The client should destroy the object. See
:func:`ExtForeignToplevelListV1.destroy()` for more information.
The compositor must not send any more toplevel events after this event.
"""
self._post_event(1)
class ExtForeignToplevelListV1Global(Global):
interface = ExtForeignToplevelListV1
ExtForeignToplevelListV1._gen_c()
ExtForeignToplevelListV1.proxy_class = ExtForeignToplevelListV1Proxy
ExtForeignToplevelListV1.resource_class = ExtForeignToplevelListV1Resource
ExtForeignToplevelListV1.global_class = ExtForeignToplevelListV1Global
@@ -1,27 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2022 Andri Yngvason
# Copyright © 2024 Simon Ser
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from .ext_foreign_toplevel_image_capture_source_manager_v1 import ExtForeignToplevelImageCaptureSourceManagerV1 # noqa: F401
from .ext_image_capture_source_v1 import ExtImageCaptureSourceV1 # noqa: F401
from .ext_output_image_capture_source_manager_v1 import ExtOutputImageCaptureSourceManagerV1 # noqa: F401
@@ -1,97 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2022 Andri Yngvason
# Copyright © 2024 Simon Ser
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from ..ext_foreign_toplevel_list_v1 import ExtForeignToplevelHandleV1
from .ext_image_capture_source_v1 import ExtImageCaptureSourceV1
class ExtForeignToplevelImageCaptureSourceManagerV1(Interface):
"""Image capture source manager for foreign toplevels
A manager for creating image capture source objects for
:class:`~pywayland.protocol.ext_foreign_toplevel_list_v1.ExtForeignToplevelHandleV1`
objects.
"""
name = "ext_foreign_toplevel_image_capture_source_manager_v1"
version = 1
class ExtForeignToplevelImageCaptureSourceManagerV1Proxy(Proxy[ExtForeignToplevelImageCaptureSourceManagerV1]):
interface = ExtForeignToplevelImageCaptureSourceManagerV1
@ExtForeignToplevelImageCaptureSourceManagerV1.request(
Argument(ArgumentType.NewId, interface=ExtImageCaptureSourceV1),
Argument(ArgumentType.Object, interface=ExtForeignToplevelHandleV1),
)
def create_source(self, toplevel_handle: ExtForeignToplevelHandleV1) -> Proxy[ExtImageCaptureSourceV1]:
"""Create source object for foreign toplevel
Creates a source object for a foreign toplevel handle. Images captured
from this source will show the same content as the toplevel.
:param toplevel_handle:
:type toplevel_handle:
:class:`~pywayland.protocol.ext_foreign_toplevel_list_v1.ExtForeignToplevelHandleV1`
:returns:
:class:`~pywayland.protocol.ext_image_capture_source_v1.ExtImageCaptureSourceV1`
"""
source = self._marshal_constructor(0, ExtImageCaptureSourceV1, toplevel_handle)
return source
@ExtForeignToplevelImageCaptureSourceManagerV1.request()
def destroy(self) -> None:
"""Delete this object
Destroys the manager. This request may be sent at any time by the
client and objects created by the manager will remain valid after its
destruction.
"""
self._marshal(1)
self._destroy()
class ExtForeignToplevelImageCaptureSourceManagerV1Resource(Resource):
interface = ExtForeignToplevelImageCaptureSourceManagerV1
class ExtForeignToplevelImageCaptureSourceManagerV1Global(Global):
interface = ExtForeignToplevelImageCaptureSourceManagerV1
ExtForeignToplevelImageCaptureSourceManagerV1._gen_c()
ExtForeignToplevelImageCaptureSourceManagerV1.proxy_class = ExtForeignToplevelImageCaptureSourceManagerV1Proxy
ExtForeignToplevelImageCaptureSourceManagerV1.resource_class = ExtForeignToplevelImageCaptureSourceManagerV1Resource
ExtForeignToplevelImageCaptureSourceManagerV1.global_class = ExtForeignToplevelImageCaptureSourceManagerV1Global
@@ -1,71 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2022 Andri Yngvason
# Copyright © 2024 Simon Ser
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import Global, Interface, Proxy, Resource
class ExtImageCaptureSourceV1(Interface):
"""Opaque image capture source object
The image capture source object is an opaque descriptor for a capturable
resource. This resource may be any sort of entity from which an image may
be derived.
Note, because :class:`ExtImageCaptureSourceV1` objects are created from
multiple independent factory interfaces, the
:class:`ExtImageCaptureSourceV1` interface is frozen at version 1.
"""
name = "ext_image_capture_source_v1"
version = 1
class ExtImageCaptureSourceV1Proxy(Proxy[ExtImageCaptureSourceV1]):
interface = ExtImageCaptureSourceV1
@ExtImageCaptureSourceV1.request()
def destroy(self) -> None:
"""Delete this object
Destroys the image capture source. This request may be sent at any time
by the client.
"""
self._marshal(0)
self._destroy()
class ExtImageCaptureSourceV1Resource(Resource):
interface = ExtImageCaptureSourceV1
class ExtImageCaptureSourceV1Global(Global):
interface = ExtImageCaptureSourceV1
ExtImageCaptureSourceV1._gen_c()
ExtImageCaptureSourceV1.proxy_class = ExtImageCaptureSourceV1Proxy
ExtImageCaptureSourceV1.resource_class = ExtImageCaptureSourceV1Resource
ExtImageCaptureSourceV1.global_class = ExtImageCaptureSourceV1Global
@@ -1,98 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2022 Andri Yngvason
# Copyright © 2024 Simon Ser
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from ..wayland import WlOutput
from .ext_image_capture_source_v1 import ExtImageCaptureSourceV1
class ExtOutputImageCaptureSourceManagerV1(Interface):
"""Image capture source manager for outputs
A manager for creating image capture source objects for
:class:`~pywayland.protocol.wayland.WlOutput` objects.
"""
name = "ext_output_image_capture_source_manager_v1"
version = 1
class ExtOutputImageCaptureSourceManagerV1Proxy(Proxy[ExtOutputImageCaptureSourceManagerV1]):
interface = ExtOutputImageCaptureSourceManagerV1
@ExtOutputImageCaptureSourceManagerV1.request(
Argument(ArgumentType.NewId, interface=ExtImageCaptureSourceV1),
Argument(ArgumentType.Object, interface=WlOutput),
)
def create_source(self, output: WlOutput) -> Proxy[ExtImageCaptureSourceV1]:
"""Create source object for output
Creates a source object for an output. Images captured from this source
will show the same content as the output. Some elements may be omitted,
such as cursors and overlays that have been marked as transparent to
capturing.
:param output:
:type output:
:class:`~pywayland.protocol.wayland.WlOutput`
:returns:
:class:`~pywayland.protocol.ext_image_capture_source_v1.ExtImageCaptureSourceV1`
"""
source = self._marshal_constructor(0, ExtImageCaptureSourceV1, output)
return source
@ExtOutputImageCaptureSourceManagerV1.request()
def destroy(self) -> None:
"""Delete this object
Destroys the manager. This request may be sent at any time by the
client and objects created by the manager will remain valid after its
destruction.
"""
self._marshal(1)
self._destroy()
class ExtOutputImageCaptureSourceManagerV1Resource(Resource):
interface = ExtOutputImageCaptureSourceManagerV1
class ExtOutputImageCaptureSourceManagerV1Global(Global):
interface = ExtOutputImageCaptureSourceManagerV1
ExtOutputImageCaptureSourceManagerV1._gen_c()
ExtOutputImageCaptureSourceManagerV1.proxy_class = ExtOutputImageCaptureSourceManagerV1Proxy
ExtOutputImageCaptureSourceManagerV1.resource_class = ExtOutputImageCaptureSourceManagerV1Resource
ExtOutputImageCaptureSourceManagerV1.global_class = ExtOutputImageCaptureSourceManagerV1Global
@@ -1,28 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2021-2023 Andri Yngvason
# Copyright © 2024 Simon Ser
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from .ext_image_copy_capture_cursor_session_v1 import ExtImageCopyCaptureCursorSessionV1 # noqa: F401
from .ext_image_copy_capture_frame_v1 import ExtImageCopyCaptureFrameV1 # noqa: F401
from .ext_image_copy_capture_manager_v1 import ExtImageCopyCaptureManagerV1 # noqa: F401
from .ext_image_copy_capture_session_v1 import ExtImageCopyCaptureSessionV1 # noqa: F401
@@ -1,185 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2021-2023 Andri Yngvason
# Copyright © 2024 Simon Ser
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .ext_image_copy_capture_session_v1 import ExtImageCopyCaptureSessionV1
class ExtImageCopyCaptureCursorSessionV1(Interface):
"""Cursor capture session
This object represents a cursor capture session. It extends the base
capture session with cursor-specific metadata.
"""
name = "ext_image_copy_capture_cursor_session_v1"
version = 1
class error(enum.IntEnum):
duplicate_session = 1
class ExtImageCopyCaptureCursorSessionV1Proxy(Proxy[ExtImageCopyCaptureCursorSessionV1]):
interface = ExtImageCopyCaptureCursorSessionV1
@ExtImageCopyCaptureCursorSessionV1.request()
def destroy(self) -> None:
"""Delete this object
Destroys the session. This request can be sent at any time by the
client.
This request doesn't affect
:class:`~pywayland.protocol.ext_image_copy_capture_v1.ExtImageCopyCaptureFrameV1`
objects created by this object.
"""
self._marshal(0)
self._destroy()
@ExtImageCopyCaptureCursorSessionV1.request(
Argument(ArgumentType.NewId, interface=ExtImageCopyCaptureSessionV1),
)
def get_capture_session(self) -> Proxy[ExtImageCopyCaptureSessionV1]:
"""Get image copy capturer session
Gets the image copy capture session for this cursor session.
The session will produce frames of the cursor image. The compositor may
pause the session when the cursor leaves the captured area.
This request must not be sent more than once, or else the
duplicate_session protocol error is raised.
:returns:
:class:`~pywayland.protocol.ext_image_copy_capture_v1.ExtImageCopyCaptureSessionV1`
"""
session = self._marshal_constructor(1, ExtImageCopyCaptureSessionV1)
return session
class ExtImageCopyCaptureCursorSessionV1Resource(Resource):
interface = ExtImageCopyCaptureCursorSessionV1
@ExtImageCopyCaptureCursorSessionV1.event()
def enter(self) -> None:
"""Cursor entered captured area
Sent when a cursor enters the captured area. It shall be generated
before the "position" and "hotspot" events when and only when a cursor
enters the area.
The cursor enters the captured area when the cursor image intersects
with the captured area. Note, this is different from e.g.
:func:`WlPointer.enter() <pywayland.protocol.wayland.WlPointer.enter>`.
"""
self._post_event(0)
@ExtImageCopyCaptureCursorSessionV1.event()
def leave(self) -> None:
"""Cursor left captured area
Sent when a cursor leaves the captured area. No "position" or "hotspot"
event is generated for the cursor until the cursor enters the captured
area again.
"""
self._post_event(1)
@ExtImageCopyCaptureCursorSessionV1.event(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def position(self, x: int, y: int) -> None:
"""Position changed
Cursors outside the image capture source do not get captured and no
event will be generated for them.
The given position is the position of the cursor's hotspot and it is
relative to the main buffer's top left corner in transformed buffer
pixel coordinates. The coordinates may be negative or greater than the
main buffer size.
:param x:
position x coordinates
:type x:
`ArgumentType.Int`
:param y:
position y coordinates
:type y:
`ArgumentType.Int`
"""
self._post_event(2, x, y)
@ExtImageCopyCaptureCursorSessionV1.event(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def hotspot(self, x: int, y: int) -> None:
"""Hotspot changed
The hotspot describes the offset between the cursor image and the
position of the input device.
The given coordinates are the hotspot's offset from the origin in
buffer coordinates.
Clients should not apply the hotspot immediately: the hotspot becomes
effective when the next :func:`ExtImageCopyCaptureFrameV1.ready()
<pywayland.protocol.ext_image_copy_capture_v1.ExtImageCopyCaptureFrameV1.ready>`
event is received.
Compositors may delay this event until the client captures a new frame.
:param x:
hotspot x coordinates
:type x:
`ArgumentType.Int`
:param y:
hotspot y coordinates
:type y:
`ArgumentType.Int`
"""
self._post_event(3, x, y)
class ExtImageCopyCaptureCursorSessionV1Global(Global):
interface = ExtImageCopyCaptureCursorSessionV1
ExtImageCopyCaptureCursorSessionV1._gen_c()
ExtImageCopyCaptureCursorSessionV1.proxy_class = ExtImageCopyCaptureCursorSessionV1Proxy
ExtImageCopyCaptureCursorSessionV1.resource_class = ExtImageCopyCaptureCursorSessionV1Resource
ExtImageCopyCaptureCursorSessionV1.global_class = ExtImageCopyCaptureCursorSessionV1Global
@@ -1,298 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2021-2023 Andri Yngvason
# Copyright © 2024 Simon Ser
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from ..wayland import WlBuffer
class ExtImageCopyCaptureFrameV1(Interface):
"""Image capture frame
This object represents an image capture frame.
The client should attach a buffer, damage the buffer, and then send a
capture request.
If the capture is successful, the compositor must send the frame metadata
(transform, damage, presentation_time in any order) followed by the ready
event.
If the capture fails, the compositor must send the failed event.
"""
name = "ext_image_copy_capture_frame_v1"
version = 1
class error(enum.IntEnum):
no_buffer = 1
invalid_buffer_damage = 2
already_captured = 3
class failure_reason(enum.IntEnum):
unknown = 0
buffer_constraints = 1
stopped = 2
class ExtImageCopyCaptureFrameV1Proxy(Proxy[ExtImageCopyCaptureFrameV1]):
interface = ExtImageCopyCaptureFrameV1
@ExtImageCopyCaptureFrameV1.request()
def destroy(self) -> None:
"""Destroy this object
Destroys the frame. This request can be sent at any time by the client.
"""
self._marshal(0)
self._destroy()
@ExtImageCopyCaptureFrameV1.request(
Argument(ArgumentType.Object, interface=WlBuffer),
)
def attach_buffer(self, buffer: WlBuffer) -> None:
"""Attach buffer to session
Attach a buffer to the session.
The :func:`WlBuffer.release()
<pywayland.protocol.wayland.WlBuffer.release>` request is unused.
The new buffer replaces any previously attached buffer.
This request must not be sent after capture, or else the
already_captured protocol error is raised.
:param buffer:
:type buffer:
:class:`~pywayland.protocol.wayland.WlBuffer`
"""
self._marshal(1, buffer)
@ExtImageCopyCaptureFrameV1.request(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def damage_buffer(self, x: int, y: int, width: int, height: int) -> None:
"""Damage buffer
Apply damage to the buffer which is to be captured next. This request
may be sent multiple times to describe a region.
The client indicates the accumulated damage since this
:class:`~pywayland.protocol.wayland.WlBuffer` was last captured. During
capture, the compositor will update the buffer with at least the union
of the region passed by the client and the region advertised by
:func:`ExtImageCopyCaptureFrameV1.damage()`.
When a :class:`~pywayland.protocol.wayland.WlBuffer` is captured for
the first time, or when the client doesn't track damage, the client
must damage the whole buffer.
This is for optimisation purposes. The compositor may use this
information to reduce copying.
These coordinates originate from the upper left corner of the buffer.
If x or y are strictly negative, or if width or height are negative or
zero, the invalid_buffer_damage protocol error is raised.
This request must not be sent after capture, or else the
already_captured protocol error is raised.
:param x:
region x coordinate
:type x:
`ArgumentType.Int`
:param y:
region y coordinate
:type y:
`ArgumentType.Int`
:param width:
region width
:type width:
`ArgumentType.Int`
:param height:
region height
:type height:
`ArgumentType.Int`
"""
self._marshal(2, x, y, width, height)
@ExtImageCopyCaptureFrameV1.request()
def capture(self) -> None:
"""Capture a frame
Capture a frame.
Unless this is the first successful captured frame performed in this
session, the compositor may wait an indefinite amount of time for the
source content to change before performing the copy.
This request may only be sent once, or else the already_captured
protocol error is raised. A buffer must be attached before this request
is sent, or else the no_buffer protocol error is raised.
"""
self._marshal(3)
class ExtImageCopyCaptureFrameV1Resource(Resource):
interface = ExtImageCopyCaptureFrameV1
@ExtImageCopyCaptureFrameV1.event(
Argument(ArgumentType.Uint),
)
def transform(self, transform: int) -> None:
"""Buffer transform
This event is sent before the ready event and holds the transform that
the compositor has applied to the buffer contents.
:param transform:
:type transform:
`ArgumentType.Uint`
"""
self._post_event(0, transform)
@ExtImageCopyCaptureFrameV1.event(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def damage(self, x: int, y: int, width: int, height: int) -> None:
"""Buffer damaged region
This event is sent before the ready event. It may be generated multiple
times to describe a region.
The first captured frame in a session will always carry full damage.
Subsequent frames' damaged regions describe which parts of the buffer
have changed since the last ready event.
These coordinates originate in the upper left corner of the buffer.
:param x:
damage x coordinate
:type x:
`ArgumentType.Int`
:param y:
damage y coordinate
:type y:
`ArgumentType.Int`
:param width:
damage width
:type width:
`ArgumentType.Int`
:param height:
damage height
:type height:
`ArgumentType.Int`
"""
self._post_event(1, x, y, width, height)
@ExtImageCopyCaptureFrameV1.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
)
def presentation_time(self, tv_sec_hi: int, tv_sec_lo: int, tv_nsec: int) -> None:
"""Presentation time of the frame
This event indicates the time at which the frame is presented to the
output in system monotonic time. This event is sent before the ready
event.
The timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples,
each component being an unsigned 32-bit value. Whole seconds are in
tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo,
and the additional fractional part in tv_nsec as nanoseconds. Hence,
for valid timestamps tv_nsec must be in [0, 999999999].
:param tv_sec_hi:
high 32 bits of the seconds part of the timestamp
:type tv_sec_hi:
`ArgumentType.Uint`
:param tv_sec_lo:
low 32 bits of the seconds part of the timestamp
:type tv_sec_lo:
`ArgumentType.Uint`
:param tv_nsec:
nanoseconds part of the timestamp
:type tv_nsec:
`ArgumentType.Uint`
"""
self._post_event(2, tv_sec_hi, tv_sec_lo, tv_nsec)
@ExtImageCopyCaptureFrameV1.event()
def ready(self) -> None:
"""Frame is available for reading
Called as soon as the frame is copied, indicating it is available for
reading.
The buffer may be re-used by the client after this event.
After receiving this event, the client must destroy the object.
"""
self._post_event(3)
@ExtImageCopyCaptureFrameV1.event(
Argument(ArgumentType.Uint),
)
def failed(self, reason: int) -> None:
"""Capture failed
This event indicates that the attempted frame copy has failed.
After receiving this event, the client must destroy the object.
:param reason:
:type reason:
`ArgumentType.Uint`
"""
self._post_event(4, reason)
class ExtImageCopyCaptureFrameV1Global(Global):
interface = ExtImageCopyCaptureFrameV1
ExtImageCopyCaptureFrameV1._gen_c()
ExtImageCopyCaptureFrameV1.proxy_class = ExtImageCopyCaptureFrameV1Proxy
ExtImageCopyCaptureFrameV1.resource_class = ExtImageCopyCaptureFrameV1Resource
ExtImageCopyCaptureFrameV1.global_class = ExtImageCopyCaptureFrameV1Global
@@ -1,139 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2021-2023 Andri Yngvason
# Copyright © 2024 Simon Ser
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from ..ext_image_capture_source_v1 import ExtImageCaptureSourceV1
from ..wayland import WlPointer
from .ext_image_copy_capture_cursor_session_v1 import ExtImageCopyCaptureCursorSessionV1
from .ext_image_copy_capture_session_v1 import ExtImageCopyCaptureSessionV1
class ExtImageCopyCaptureManagerV1(Interface):
"""Manager to inform clients and begin capturing
This object is a manager which offers requests to start capturing from a
source.
"""
name = "ext_image_copy_capture_manager_v1"
version = 1
class error(enum.IntEnum):
invalid_option = 1
class options(enum.IntFlag):
paint_cursors = 1
class ExtImageCopyCaptureManagerV1Proxy(Proxy[ExtImageCopyCaptureManagerV1]):
interface = ExtImageCopyCaptureManagerV1
@ExtImageCopyCaptureManagerV1.request(
Argument(ArgumentType.NewId, interface=ExtImageCopyCaptureSessionV1),
Argument(ArgumentType.Object, interface=ExtImageCaptureSourceV1),
Argument(ArgumentType.Uint),
)
def create_session(self, source: ExtImageCaptureSourceV1, options: int) -> Proxy[ExtImageCopyCaptureSessionV1]:
"""Capture an image capture source
Create a capturing session for an image capture source.
If the paint_cursors option is set, cursors shall be composited onto
the captured frame. The cursor must not be composited onto the frame if
this flag is not set.
If the options bitfield is invalid, the invalid_option protocol error
is sent.
:param source:
:type source:
:class:`~pywayland.protocol.ext_image_capture_source_v1.ExtImageCaptureSourceV1`
:param options:
:type options:
`ArgumentType.Uint`
:returns:
:class:`~pywayland.protocol.ext_image_copy_capture_v1.ExtImageCopyCaptureSessionV1`
"""
session = self._marshal_constructor(0, ExtImageCopyCaptureSessionV1, source, options)
return session
@ExtImageCopyCaptureManagerV1.request(
Argument(ArgumentType.NewId, interface=ExtImageCopyCaptureCursorSessionV1),
Argument(ArgumentType.Object, interface=ExtImageCaptureSourceV1),
Argument(ArgumentType.Object, interface=WlPointer),
)
def create_pointer_cursor_session(self, source: ExtImageCaptureSourceV1, pointer: WlPointer) -> Proxy[ExtImageCopyCaptureCursorSessionV1]:
"""Capture the pointer cursor of an image capture source
Create a cursor capturing session for the pointer of an image capture
source.
:param source:
:type source:
:class:`~pywayland.protocol.ext_image_capture_source_v1.ExtImageCaptureSourceV1`
:param pointer:
:type pointer:
:class:`~pywayland.protocol.wayland.WlPointer`
:returns:
:class:`~pywayland.protocol.ext_image_copy_capture_v1.ExtImageCopyCaptureCursorSessionV1`
"""
session = self._marshal_constructor(1, ExtImageCopyCaptureCursorSessionV1, source, pointer)
return session
@ExtImageCopyCaptureManagerV1.request()
def destroy(self) -> None:
"""Destroy the manager
Destroy the manager object.
Other objects created via this interface are unaffected.
"""
self._marshal(2)
self._destroy()
class ExtImageCopyCaptureManagerV1Resource(Resource):
interface = ExtImageCopyCaptureManagerV1
class ExtImageCopyCaptureManagerV1Global(Global):
interface = ExtImageCopyCaptureManagerV1
ExtImageCopyCaptureManagerV1._gen_c()
ExtImageCopyCaptureManagerV1.proxy_class = ExtImageCopyCaptureManagerV1Proxy
ExtImageCopyCaptureManagerV1.resource_class = ExtImageCopyCaptureManagerV1Resource
ExtImageCopyCaptureManagerV1.global_class = ExtImageCopyCaptureManagerV1Global
@@ -1,230 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2021-2023 Andri Yngvason
# Copyright © 2024 Simon Ser
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .ext_image_copy_capture_frame_v1 import ExtImageCopyCaptureFrameV1
class ExtImageCopyCaptureSessionV1(Interface):
"""Image copy capture session
This object represents an active image copy capture session.
After a capture session is created, buffer constraint events will be
emitted from the compositor to tell the client which buffer types and
formats are supported for reading from the session. The compositor may re-
send buffer constraint events whenever they change.
To advertise buffer constraints, the compositor must send in no particular
order: zero or more shm_format and dmabuf_format events, zero or one
dmabuf_device event, and exactly one buffer_size event. Then the compositor
must send a done event.
When the client has received all the buffer constraints, it can create a
buffer accordingly, attach it to the capture session using the
attach_buffer request, set the buffer damage using the damage_buffer
request and then send the capture request.
"""
name = "ext_image_copy_capture_session_v1"
version = 1
class error(enum.IntEnum):
duplicate_frame = 1
class ExtImageCopyCaptureSessionV1Proxy(Proxy[ExtImageCopyCaptureSessionV1]):
interface = ExtImageCopyCaptureSessionV1
@ExtImageCopyCaptureSessionV1.request(
Argument(ArgumentType.NewId, interface=ExtImageCopyCaptureFrameV1),
)
def create_frame(self) -> Proxy[ExtImageCopyCaptureFrameV1]:
"""Create a frame
Create a capture frame for this session.
At most one frame object can exist for a given session at any time. If
a client sends a create_frame request before a previous frame object
has been destroyed, the duplicate_frame protocol error is raised.
:returns:
:class:`~pywayland.protocol.ext_image_copy_capture_v1.ExtImageCopyCaptureFrameV1`
"""
frame = self._marshal_constructor(0, ExtImageCopyCaptureFrameV1)
return frame
@ExtImageCopyCaptureSessionV1.request()
def destroy(self) -> None:
"""Delete this object
Destroys the session. This request can be sent at any time by the
client.
This request doesn't affect
:class:`~pywayland.protocol.ext_image_copy_capture_v1.ExtImageCopyCaptureFrameV1`
objects created by this object.
"""
self._marshal(1)
self._destroy()
class ExtImageCopyCaptureSessionV1Resource(Resource):
interface = ExtImageCopyCaptureSessionV1
@ExtImageCopyCaptureSessionV1.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
)
def buffer_size(self, width: int, height: int) -> None:
"""Image capture source dimensions
Provides the dimensions of the source image in buffer pixel
coordinates.
The client must attach buffers that match this size.
:param width:
buffer width
:type width:
`ArgumentType.Uint`
:param height:
buffer height
:type height:
`ArgumentType.Uint`
"""
self._post_event(0, width, height)
@ExtImageCopyCaptureSessionV1.event(
Argument(ArgumentType.Uint),
)
def shm_format(self, format: int) -> None:
"""Shm buffer format
Provides the format that must be used for shared-memory buffers.
This event may be emitted multiple times, in which case the client may
choose any given format.
:param format:
shm format
:type format:
`ArgumentType.Uint`
"""
self._post_event(1, format)
@ExtImageCopyCaptureSessionV1.event(
Argument(ArgumentType.Array),
)
def dmabuf_device(self, device: list) -> None:
"""Dma-buf device
This event advertises the device buffers must be allocated on for dma-
buf buffers.
In general the device is a DRM node. The DRM node type (primary vs.
render) is unspecified. Clients must not rely on the compositor sending
a particular node type. Clients cannot check two devices for equality
by comparing the dev_t value.
:param device:
device dev_t value
:type device:
`ArgumentType.Array`
"""
self._post_event(2, device)
@ExtImageCopyCaptureSessionV1.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Array),
)
def dmabuf_format(self, format: int, modifiers: list) -> None:
"""Dma-buf format
Provides the format that must be used for dma-buf buffers.
The client may choose any of the modifiers advertised in the array of
64-bit unsigned integers.
This event may be emitted multiple times, in which case the client may
choose any given format.
:param format:
drm format code
:type format:
`ArgumentType.Uint`
:param modifiers:
drm format modifiers
:type modifiers:
`ArgumentType.Array`
"""
self._post_event(3, format, modifiers)
@ExtImageCopyCaptureSessionV1.event()
def done(self) -> None:
"""All constraints have been sent
This event is sent once when all buffer constraint events have been
sent.
The compositor must always end a batch of buffer constraint events with
this event, regardless of whether it sends the initial constraints or
an update.
"""
self._post_event(4)
@ExtImageCopyCaptureSessionV1.event()
def stopped(self) -> None:
"""Session is no longer available
This event indicates that the capture session has stopped and is no
longer available. This can happen in a number of cases, e.g. when the
underlying source is destroyed, if the user decides to end the image
capture, or if an unrecoverable runtime error has occurred.
The client should destroy the session after receiving this event.
"""
self._post_event(5)
class ExtImageCopyCaptureSessionV1Global(Global):
interface = ExtImageCopyCaptureSessionV1
ExtImageCopyCaptureSessionV1._gen_c()
ExtImageCopyCaptureSessionV1.proxy_class = ExtImageCopyCaptureSessionV1Proxy
ExtImageCopyCaptureSessionV1.resource_class = ExtImageCopyCaptureSessionV1Resource
ExtImageCopyCaptureSessionV1.global_class = ExtImageCopyCaptureSessionV1Global
@@ -1,50 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from .wl_buffer import WlBuffer # noqa: F401
from .wl_callback import WlCallback # noqa: F401
from .wl_compositor import WlCompositor # noqa: F401
from .wl_data_device import WlDataDevice # noqa: F401
from .wl_data_device_manager import WlDataDeviceManager # noqa: F401
from .wl_data_offer import WlDataOffer # noqa: F401
from .wl_data_source import WlDataSource # noqa: F401
from .wl_display import WlDisplay # noqa: F401
from .wl_fixes import WlFixes # noqa: F401
from .wl_keyboard import WlKeyboard # noqa: F401
from .wl_output import WlOutput # noqa: F401
from .wl_pointer import WlPointer # noqa: F401
from .wl_region import WlRegion # noqa: F401
from .wl_registry import WlRegistry # noqa: F401
from .wl_seat import WlSeat # noqa: F401
from .wl_shell import WlShell # noqa: F401
from .wl_shell_surface import WlShellSurface # noqa: F401
from .wl_shm import WlShm # noqa: F401
from .wl_shm_pool import WlShmPool # noqa: F401
from .wl_subcompositor import WlSubcompositor # noqa: F401
from .wl_subsurface import WlSubsurface # noqa: F401
from .wl_surface import WlSurface # noqa: F401
from .wl_touch import WlTouch # noqa: F401
@@ -1,112 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import Global, Interface, Proxy, Resource
class WlBuffer(Interface):
"""Content for a :class:`~pywayland.protocol.wayland.WlSurface`
A buffer provides the content for a
:class:`~pywayland.protocol.wayland.WlSurface`. Buffers are created through
factory interfaces such as :class:`~pywayland.protocol.wayland.WlShm`,
wp_linux_buffer_params (from the linux-dmabuf protocol extension) or
similar. It has a width and a height and can be attached to a
:class:`~pywayland.protocol.wayland.WlSurface`, but the mechanism by which
a client provides and updates the contents is defined by the buffer factory
interface.
Color channels are assumed to be electrical rather than optical (in other
words, encoded with a transfer function) unless otherwise specified. If the
buffer uses a format that has an alpha channel, the alpha channel is
assumed to be premultiplied into the electrical color channel values (after
transfer function encoding) unless otherwise specified.
Note, because :class:`WlBuffer` objects are created from multiple
independent factory interfaces, the :class:`WlBuffer` interface is frozen
at version 1.
"""
name = "wl_buffer"
version = 1
class WlBufferProxy(Proxy[WlBuffer]):
interface = WlBuffer
@WlBuffer.request()
def destroy(self) -> None:
"""Destroy a buffer
Destroy a buffer. If and how you need to release the backing storage is
defined by the buffer factory interface.
For possible side-effects to a surface, see :func:`WlSurface.attach()
<pywayland.protocol.wayland.WlSurface.attach>`.
"""
self._marshal(0)
self._destroy()
class WlBufferResource(Resource):
interface = WlBuffer
@WlBuffer.event()
def release(self) -> None:
"""Compositor releases buffer
Sent when this :class:`WlBuffer` is no longer used by the compositor.
For more information on when release events may or may not be sent, and
what consequences it has, please see the description of
:func:`WlSurface.attach()
<pywayland.protocol.wayland.WlSurface.attach>`.
If a client receives a release event before the frame callback
requested in the same :func:`WlSurface.commit()
<pywayland.protocol.wayland.WlSurface.commit>` that attaches this
:class:`WlBuffer` to a surface, then the client is immediately free to
reuse the buffer and its backing storage, and does not need a second
buffer for the next surface content update. Typically this is possible,
when the compositor maintains a copy of the
:class:`~pywayland.protocol.wayland.WlSurface` contents, e.g. as a GL
texture. This is an important optimization for GL(ES) compositors with
:class:`~pywayland.protocol.wayland.WlShm` clients.
"""
self._post_event(0)
class WlBufferGlobal(Global):
interface = WlBuffer
WlBuffer._gen_c()
WlBuffer.proxy_class = WlBufferProxy
WlBuffer.resource_class = WlBufferResource
WlBuffer.global_class = WlBufferGlobal
@@ -1,85 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
class WlCallback(Interface):
"""Callback object
Clients can handle the 'done' event to get notified when the related
request is done.
Note, because :class:`WlCallback` objects are created from multiple
independent factory interfaces, the :class:`WlCallback` interface is frozen
at version 1.
"""
name = "wl_callback"
version = 1
class WlCallbackProxy(Proxy[WlCallback]):
interface = WlCallback
class WlCallbackResource(Resource):
interface = WlCallback
@WlCallback.event(
Argument(ArgumentType.Uint),
)
def done(self, callback_data: int) -> None:
"""Done event
Notify the client when the related request is done.
:param callback_data:
request-specific data for the callback
:type callback_data:
`ArgumentType.Uint`
"""
self._post_event(0, callback_data)
class WlCallbackGlobal(Global):
interface = WlCallback
WlCallback._gen_c()
WlCallback.proxy_class = WlCallbackProxy
WlCallback.resource_class = WlCallbackResource
WlCallback.global_class = WlCallbackGlobal
@@ -1,108 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_region import WlRegion
from .wl_surface import WlSurface
class WlCompositor(Interface):
"""The compositor singleton
A compositor. This object is a singleton global. The compositor is in
charge of combining the contents of multiple surfaces into one displayable
output.
"""
name = "wl_compositor"
version = 7
class WlCompositorProxy(Proxy[WlCompositor]):
interface = WlCompositor
@WlCompositor.request(
Argument(ArgumentType.NewId, interface=WlSurface),
)
def create_surface(self) -> Proxy[WlSurface]:
"""Create new surface
Ask the compositor to create a new surface.
:returns:
:class:`~pywayland.protocol.wayland.WlSurface` -- the new surface
"""
id = self._marshal_constructor(0, WlSurface)
return id
@WlCompositor.request(
Argument(ArgumentType.NewId, interface=WlRegion),
)
def create_region(self) -> Proxy[WlRegion]:
"""Create new region
Ask the compositor to create a new region.
:returns:
:class:`~pywayland.protocol.wayland.WlRegion` -- the new region
"""
id = self._marshal_constructor(1, WlRegion)
return id
@WlCompositor.request(version=7)
def release(self) -> None:
"""Destroy :class:`WlCompositor`
This request destroys the :class:`WlCompositor`. This has no effect on
any other objects.
"""
self._marshal(2)
self._destroy()
class WlCompositorResource(Resource):
interface = WlCompositor
class WlCompositorGlobal(Global):
interface = WlCompositor
WlCompositor._gen_c()
WlCompositor.proxy_class = WlCompositorProxy
WlCompositor.resource_class = WlCompositorResource
WlCompositor.global_class = WlCompositorGlobal
@@ -1,320 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_data_offer import WlDataOffer
from .wl_data_source import WlDataSource
from .wl_surface import WlSurface
class WlDataDevice(Interface):
"""Data transfer device
There is one :class:`WlDataDevice` per seat which can be obtained from the
global :class:`~pywayland.protocol.wayland.WlDataDeviceManager` singleton.
A :class:`WlDataDevice` provides access to inter-client data transfer
mechanisms such as copy-and-paste and drag-and-drop.
"""
name = "wl_data_device"
version = 4
class error(enum.IntEnum):
role = 0
used_source = 1
class WlDataDeviceProxy(Proxy[WlDataDevice]):
interface = WlDataDevice
@WlDataDevice.request(
Argument(ArgumentType.Object, interface=WlDataSource, nullable=True),
Argument(ArgumentType.Object, interface=WlSurface),
Argument(ArgumentType.Object, interface=WlSurface, nullable=True),
Argument(ArgumentType.Uint),
)
def start_drag(self, source: WlDataSource | None, origin: WlSurface, icon: WlSurface | None, serial: int) -> None:
"""Start drag-and-drop operation
This request asks the compositor to start a drag-and-drop operation on
behalf of the client.
The source argument is the data source that provides the data for the
eventual data transfer. If source is NULL, enter, leave and motion
events are sent only to the client that initiated the drag and the
client is expected to handle the data passing internally. If source is
destroyed, the drag-and-drop session will be cancelled.
The origin surface is the surface where the drag originates and the
client must have an active implicit grab that matches the serial.
The icon surface is an optional (can be NULL) surface that provides an
icon to be moved around with the cursor. Initially, the top-left
corner of the icon surface is placed at the cursor hotspot, but
subsequent :func:`WlSurface.offset()
<pywayland.protocol.wayland.WlSurface.offset>` requests can move the
relative position. Attach requests must be confirmed with
:func:`WlSurface.commit()
<pywayland.protocol.wayland.WlSurface.commit>` as usual. The icon
surface is given the role of a drag-and-drop icon. If the icon surface
already has another role, it raises a protocol error.
The input region is ignored for wl_surfaces with the role of a drag-
and-drop icon.
The given source may not be used in any further set_selection or
start_drag requests. Attempting to reuse a previously-used source may
send a used_source error.
:param source:
data source for the eventual transfer
:type source:
:class:`~pywayland.protocol.wayland.WlDataSource` or `None`
:param origin:
surface where the drag originates
:type origin:
:class:`~pywayland.protocol.wayland.WlSurface`
:param icon:
drag-and-drop icon surface
:type icon:
:class:`~pywayland.protocol.wayland.WlSurface` or `None`
:param serial:
serial number of the implicit grab on the origin
:type serial:
`ArgumentType.Uint`
"""
self._marshal(0, source, origin, icon, serial)
@WlDataDevice.request(
Argument(ArgumentType.Object, interface=WlDataSource, nullable=True),
Argument(ArgumentType.Uint),
)
def set_selection(self, source: WlDataSource | None, serial: int) -> None:
"""Copy data to the selection
This request asks the compositor to set the selection to the data from
the source on behalf of the client.
To unset the selection, set the source to NULL.
The given source may not be used in any further set_selection or
start_drag requests. Attempting to reuse a previously-used source may
send a used_source error.
:param source:
data source for the selection
:type source:
:class:`~pywayland.protocol.wayland.WlDataSource` or `None`
:param serial:
serial number of the event that triggered this request
:type serial:
`ArgumentType.Uint`
"""
self._marshal(1, source, serial)
@WlDataDevice.request(version=2)
def release(self) -> None:
"""Destroy data device
This request destroys the data device.
"""
self._marshal(2)
self._destroy()
class WlDataDeviceResource(Resource):
interface = WlDataDevice
@WlDataDevice.event(
Argument(ArgumentType.NewId, interface=WlDataOffer),
)
def data_offer(self, id: WlDataOffer) -> None:
"""Introduce a new :class:`~pywayland.protocol.wayland.WlDataOffer`
The data_offer event introduces a new
:class:`~pywayland.protocol.wayland.WlDataOffer` object, which will
subsequently be used in either the data_device.enter event (for drag-
and-drop) or the data_device.selection event (for selections).
Immediately following the data_device.data_offer event, the new
data_offer object will send out data_offer.offer events to describe the
mime types it offers.
:param id:
the new data_offer object
:type id:
:class:`~pywayland.protocol.wayland.WlDataOffer`
"""
self._post_event(0, id)
@WlDataDevice.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Object, interface=WlSurface),
Argument(ArgumentType.Fixed),
Argument(ArgumentType.Fixed),
Argument(ArgumentType.Object, interface=WlDataOffer, nullable=True),
)
def enter(self, serial: int, surface: WlSurface, x: float, y: float, id: WlDataOffer | None) -> None:
"""Initiate drag-and-drop session
This event is sent when an active drag-and-drop pointer enters a
surface owned by the client. The position of the pointer at enter time
is provided by the x and y arguments, in surface-local coordinates.
:param serial:
serial number of the enter event
:type serial:
`ArgumentType.Uint`
:param surface:
client surface entered
:type surface:
:class:`~pywayland.protocol.wayland.WlSurface`
:param x:
surface-local x coordinate
:type x:
`ArgumentType.Fixed`
:param y:
surface-local y coordinate
:type y:
`ArgumentType.Fixed`
:param id:
source data_offer object
:type id:
:class:`~pywayland.protocol.wayland.WlDataOffer` or `None`
"""
self._post_event(1, serial, surface, x, y, id)
@WlDataDevice.event()
def leave(self) -> None:
"""End drag-and-drop session
This event is sent when the drag-and-drop pointer leaves the surface
and the session ends. The client must destroy the
:class:`~pywayland.protocol.wayland.WlDataOffer` introduced at enter
time at this point.
"""
self._post_event(2)
@WlDataDevice.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Fixed),
Argument(ArgumentType.Fixed),
)
def motion(self, time: int, x: float, y: float) -> None:
"""Drag-and-drop session motion
This event is sent when the drag-and-drop pointer moves within the
currently focused surface. The new position of the pointer is provided
by the x and y arguments, in surface-local coordinates.
:param time:
timestamp with millisecond granularity
:type time:
`ArgumentType.Uint`
:param x:
surface-local x coordinate
:type x:
`ArgumentType.Fixed`
:param y:
surface-local y coordinate
:type y:
`ArgumentType.Fixed`
"""
self._post_event(3, time, x, y)
@WlDataDevice.event()
def drop(self) -> None:
"""End drag-and-drop session successfully
The event is sent when a drag-and-drop operation is ended because the
implicit grab is removed.
The drag-and-drop destination is expected to honor the last action
received through :func:`WlDataOffer.action()
<pywayland.protocol.wayland.WlDataOffer.action>`, if the resulting
action is "copy" or "move", the destination can still perform
:func:`WlDataOffer.receive()
<pywayland.protocol.wayland.WlDataOffer.receive>` requests, and is
expected to end all transfers with a :func:`WlDataOffer.finish()
<pywayland.protocol.wayland.WlDataOffer.finish>` request.
If the resulting action is "ask", the action will not be considered
final. The drag-and-drop destination is expected to perform one last
:func:`WlDataOffer.set_actions()
<pywayland.protocol.wayland.WlDataOffer.set_actions>` request, or
:func:`WlDataOffer.destroy()
<pywayland.protocol.wayland.WlDataOffer.destroy>` in order to cancel
the operation.
"""
self._post_event(4)
@WlDataDevice.event(
Argument(ArgumentType.Object, interface=WlDataOffer, nullable=True),
)
def selection(self, id: WlDataOffer | None) -> None:
"""Advertise new selection
The selection event is sent out to notify the client of a new
:class:`~pywayland.protocol.wayland.WlDataOffer` for the selection for
this device. The data_device.data_offer and the data_offer.offer
events are sent out immediately before this event to introduce the data
offer object. The selection event is sent to a client immediately
before receiving keyboard focus and when a new selection is set while
the client has keyboard focus. The data_offer is valid until a new
data_offer or NULL is received or until the client loses keyboard
focus. Switching surface with keyboard focus within the same client
doesn't mean a new selection will be sent. The client must destroy the
previous selection data_offer, if any, upon receiving this event.
:param id:
selection data_offer object
:type id:
:class:`~pywayland.protocol.wayland.WlDataOffer` or `None`
"""
self._post_event(5, id)
class WlDataDeviceGlobal(Global):
interface = WlDataDevice
WlDataDevice._gen_c()
WlDataDevice.proxy_class = WlDataDeviceProxy
WlDataDevice.resource_class = WlDataDeviceResource
WlDataDevice.global_class = WlDataDeviceGlobal
@@ -1,136 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_data_device import WlDataDevice
from .wl_data_source import WlDataSource
from .wl_seat import WlSeat
class WlDataDeviceManager(Interface):
"""Data transfer interface
The :class:`WlDataDeviceManager` is a singleton global object that provides
access to inter-client data transfer mechanisms such as copy-and-paste and
drag-and-drop. These mechanisms are tied to a
:class:`~pywayland.protocol.wayland.WlSeat` and this interface lets a
client get a :class:`~pywayland.protocol.wayland.WlDataDevice`
corresponding to a :class:`~pywayland.protocol.wayland.WlSeat`.
Depending on the version bound, the objects created from the bound
:class:`WlDataDeviceManager` object will have different requirements for
functioning properly. See :func:`WlDataSource.set_actions()
<pywayland.protocol.wayland.WlDataSource.set_actions>`,
:func:`WlDataOffer.accept()
<pywayland.protocol.wayland.WlDataOffer.accept>` and
:func:`WlDataOffer.finish()
<pywayland.protocol.wayland.WlDataOffer.finish>` for details.
"""
name = "wl_data_device_manager"
version = 4
class dnd_action(enum.IntFlag):
none = 0
copy = 1
move = 2
ask = 4
class WlDataDeviceManagerProxy(Proxy[WlDataDeviceManager]):
interface = WlDataDeviceManager
@WlDataDeviceManager.request(
Argument(ArgumentType.NewId, interface=WlDataSource),
)
def create_data_source(self) -> Proxy[WlDataSource]:
"""Create a new data source
Create a new data source.
:returns:
:class:`~pywayland.protocol.wayland.WlDataSource` -- data source to
create
"""
id = self._marshal_constructor(0, WlDataSource)
return id
@WlDataDeviceManager.request(
Argument(ArgumentType.NewId, interface=WlDataDevice),
Argument(ArgumentType.Object, interface=WlSeat),
)
def get_data_device(self, seat: WlSeat) -> Proxy[WlDataDevice]:
"""Create a new data device
Create a new data device for a given seat.
:param seat:
seat associated with the data device
:type seat:
:class:`~pywayland.protocol.wayland.WlSeat`
:returns:
:class:`~pywayland.protocol.wayland.WlDataDevice` -- data device to
create
"""
id = self._marshal_constructor(1, WlDataDevice, seat)
return id
@WlDataDeviceManager.request(version=4)
def release(self) -> None:
"""Destroy :class:`WlDataDeviceManager`
This request destroys the :class:`WlDataDeviceManager`. This has no
effect on any other objects.
"""
self._marshal(2)
self._destroy()
class WlDataDeviceManagerResource(Resource):
interface = WlDataDeviceManager
class WlDataDeviceManagerGlobal(Global):
interface = WlDataDeviceManager
WlDataDeviceManager._gen_c()
WlDataDeviceManager.proxy_class = WlDataDeviceManagerProxy
WlDataDeviceManager.resource_class = WlDataDeviceManagerResource
WlDataDeviceManager.global_class = WlDataDeviceManagerGlobal
@@ -1,325 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
class WlDataOffer(Interface):
"""Offer to transfer data
A :class:`WlDataOffer` represents a piece of data offered for transfer by
another client (the source client). It is used by the copy-and-paste and
drag-and-drop mechanisms. The offer describes the different mime types
that the data can be converted to and provides the mechanism for
transferring the data directly from the source client.
"""
name = "wl_data_offer"
version = 4
class error(enum.IntEnum):
invalid_finish = 0
invalid_action_mask = 1
invalid_action = 2
invalid_offer = 3
class WlDataOfferProxy(Proxy[WlDataOffer]):
interface = WlDataOffer
@WlDataOffer.request(
Argument(ArgumentType.Uint),
Argument(ArgumentType.String, nullable=True),
)
def accept(self, serial: int, mime_type: str | None) -> None:
"""Accept one of the offered mime types
Indicate that the client can accept the given mime type, or NULL for
not accepted.
For objects of version 2 or older, this request is used by the client
to give feedback whether the client can receive the given mime type, or
NULL if none is accepted; the feedback does not determine whether the
drag-and-drop operation succeeds or not.
For objects of version 3 or newer, this request determines the final
result of the drag-and-drop operation. If the end result is that no
mime types were accepted, the drag-and-drop operation will be cancelled
and the corresponding drag source will receive
:func:`WlDataSource.cancelled()
<pywayland.protocol.wayland.WlDataSource.cancelled>`. Clients may still
use this event in conjunction with :func:`WlDataSource.action()
<pywayland.protocol.wayland.WlDataSource.action>` for feedback.
:param serial:
serial number of the accept request
:type serial:
`ArgumentType.Uint`
:param mime_type:
mime type accepted by the client
:type mime_type:
`ArgumentType.String` or `None`
"""
self._marshal(0, serial, mime_type)
@WlDataOffer.request(
Argument(ArgumentType.String),
Argument(ArgumentType.FileDescriptor),
)
def receive(self, mime_type: str, fd: int) -> None:
"""Request that the data is transferred
To transfer the offered data, the client issues this request and
indicates the mime type it wants to receive. The transfer happens
through the passed file descriptor (typically created with the pipe
system call). The source client writes the data in the mime type
representation requested and then closes the file descriptor.
The receiving client reads from the read end of the pipe until EOF and
then closes its end, at which point the transfer is complete.
This request may happen multiple times for different mime types, both
before and after :func:`WlDataDevice.drop()
<pywayland.protocol.wayland.WlDataDevice.drop>`. Drag-and-drop
destination clients may preemptively fetch data or examine it more
closely to determine acceptance.
:param mime_type:
mime type desired by receiver
:type mime_type:
`ArgumentType.String`
:param fd:
file descriptor for data transfer
:type fd:
`ArgumentType.FileDescriptor`
"""
self._marshal(1, mime_type, fd)
@WlDataOffer.request()
def destroy(self) -> None:
"""Destroy data offer
Destroy the data offer.
"""
self._marshal(2)
self._destroy()
@WlDataOffer.request(version=3)
def finish(self) -> None:
"""The offer will no longer be used
Notifies the compositor that the drag destination successfully finished
the drag-and-drop operation.
Upon receiving this request, the compositor will emit
:func:`WlDataSource.dnd_finished()
<pywayland.protocol.wayland.WlDataSource.dnd_finished>` on the drag
source client.
It is a client error to perform other requests than
:func:`WlDataOffer.destroy()` after this one. It is also an error to
perform this request after a NULL mime type has been set in
:func:`WlDataOffer.accept()` or no action was received through
:func:`WlDataOffer.action()`.
If :func:`WlDataOffer.finish()` request is received for a non drag and
drop operation, the invalid_finish protocol error is raised.
"""
self._marshal(3)
@WlDataOffer.request(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
version=3,
)
def set_actions(self, dnd_actions: int, preferred_action: int) -> None:
"""Set the available/preferred drag-and-drop actions
Sets the actions that the destination side client supports for this
operation. This request may trigger the emission of
:func:`WlDataSource.action()
<pywayland.protocol.wayland.WlDataSource.action>` and
:func:`WlDataOffer.action()` events if the compositor needs to change
the selected action.
This request can be called multiple times throughout the drag-and-drop
operation, typically in response to :func:`WlDataDevice.enter()
<pywayland.protocol.wayland.WlDataDevice.enter>` or
:func:`WlDataDevice.motion()
<pywayland.protocol.wayland.WlDataDevice.motion>` events.
This request determines the final result of the drag-and-drop
operation. If the end result is that no action is accepted, the drag
source will receive :func:`WlDataSource.cancelled()
<pywayland.protocol.wayland.WlDataSource.cancelled>`.
The dnd_actions argument must contain only values expressed in the
:func:`WlDataDeviceManager.dnd_actions()
<pywayland.protocol.wayland.WlDataDeviceManager.dnd_actions>` enum, and
the preferred_action argument must only contain one of those values
set, otherwise it will result in a protocol error.
While managing an "ask" action, the destination drag-and-drop client
may perform further :func:`WlDataOffer.receive()` requests, and is
expected to perform one last :func:`WlDataOffer.set_actions()` request
with a preferred action other than "ask" (and optionally
:func:`WlDataOffer.accept()`) before requesting
:func:`WlDataOffer.finish()`, in order to convey the action selected by
the user. If the preferred action is not in the
:func:`WlDataOffer.source_actions()` mask, an error will be raised.
If the "ask" action is dismissed (e.g. user cancellation), the client
is expected to perform :func:`WlDataOffer.destroy()` right away.
This request can only be made on drag-and-drop offers, a protocol error
will be raised otherwise.
:param dnd_actions:
actions supported by the destination client
:type dnd_actions:
`ArgumentType.Uint`
:param preferred_action:
action preferred by the destination client
:type preferred_action:
`ArgumentType.Uint`
"""
self._marshal(4, dnd_actions, preferred_action)
class WlDataOfferResource(Resource):
interface = WlDataOffer
@WlDataOffer.event(
Argument(ArgumentType.String),
)
def offer(self, mime_type: str) -> None:
"""Advertise offered mime type
Sent immediately after creating the :class:`WlDataOffer` object. One
event per offered mime type.
:param mime_type:
offered mime type
:type mime_type:
`ArgumentType.String`
"""
self._post_event(0, mime_type)
@WlDataOffer.event(
Argument(ArgumentType.Uint),
version=3,
)
def source_actions(self, source_actions: int) -> None:
"""Notify the source-side available actions
This event indicates the actions offered by the data source. It will be
sent immediately after creating the :class:`WlDataOffer` object, or
anytime the source side changes its offered actions through
:func:`WlDataSource.set_actions()
<pywayland.protocol.wayland.WlDataSource.set_actions>`.
:param source_actions:
actions offered by the data source
:type source_actions:
`ArgumentType.Uint`
"""
self._post_event(1, source_actions)
@WlDataOffer.event(
Argument(ArgumentType.Uint),
version=3,
)
def action(self, dnd_action: int) -> None:
"""Notify the selected action
This event indicates the action selected by the compositor after
matching the source/destination side actions. Only one action (or none)
will be offered here.
This event can be emitted multiple times during the drag-and-drop
operation in response to destination side action changes through
:func:`WlDataOffer.set_actions()`.
This event will no longer be emitted after :func:`WlDataDevice.drop()
<pywayland.protocol.wayland.WlDataDevice.drop>` happened on the drag-
and-drop destination, the client must honor the last action received,
or the last preferred one set through :func:`WlDataOffer.set_actions()`
when handling an "ask" action.
Compositors may also change the selected action on the fly, mainly in
response to keyboard modifier changes during the drag-and-drop
operation.
The most recent action received is always the valid one. Prior to
receiving :func:`WlDataDevice.drop()
<pywayland.protocol.wayland.WlDataDevice.drop>`, the chosen action may
change (e.g. due to keyboard modifiers being pressed). At the time of
receiving :func:`WlDataDevice.drop()
<pywayland.protocol.wayland.WlDataDevice.drop>` the drag-and-drop
destination must honor the last action received.
Action changes may still happen after :func:`WlDataDevice.drop()
<pywayland.protocol.wayland.WlDataDevice.drop>`, especially on "ask"
actions, where the drag-and-drop destination may choose another action
afterwards. Action changes happening at this stage are always the
result of inter-client negotiation, the compositor shall no longer be
able to induce a different action.
Upon "ask" actions, it is expected that the drag-and-drop destination
may potentially choose a different action and/or mime type, based on
:func:`WlDataOffer.source_actions()` and finally chosen by the user
(e.g. popping up a menu with the available options). The final
:func:`WlDataOffer.set_actions()` and :func:`WlDataOffer.accept()`
requests must happen before the call to :func:`WlDataOffer.finish()`.
:param dnd_action:
action selected by the compositor
:type dnd_action:
`ArgumentType.Uint`
"""
self._post_event(2, dnd_action)
class WlDataOfferGlobal(Global):
interface = WlDataOffer
WlDataOffer._gen_c()
WlDataOffer.proxy_class = WlDataOfferProxy
WlDataOffer.resource_class = WlDataOfferResource
WlDataOffer.global_class = WlDataOfferGlobal
@@ -1,272 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
class WlDataSource(Interface):
"""Offer to transfer data
The :class:`WlDataSource` object is the source side of a
:class:`~pywayland.protocol.wayland.WlDataOffer`. It is created by the
source client in a data transfer and provides a way to describe the offered
data and a way to respond to requests to transfer the data.
"""
name = "wl_data_source"
version = 4
class error(enum.IntEnum):
invalid_action_mask = 0
invalid_source = 1
class WlDataSourceProxy(Proxy[WlDataSource]):
interface = WlDataSource
@WlDataSource.request(
Argument(ArgumentType.String),
)
def offer(self, mime_type: str) -> None:
"""Add an offered mime type
This request adds a mime type to the set of mime types advertised to
targets. Can be called several times to offer multiple types.
:param mime_type:
mime type offered by the data source
:type mime_type:
`ArgumentType.String`
"""
self._marshal(0, mime_type)
@WlDataSource.request()
def destroy(self) -> None:
"""Destroy the data source
Destroy the data source.
"""
self._marshal(1)
self._destroy()
@WlDataSource.request(
Argument(ArgumentType.Uint),
version=3,
)
def set_actions(self, dnd_actions: int) -> None:
"""Set the available drag-and-drop actions
Sets the actions that the source side client supports for this
operation. This request may trigger :func:`WlDataSource.action()` and
:func:`WlDataOffer.action()
<pywayland.protocol.wayland.WlDataOffer.action>` events if the
compositor needs to change the selected action.
The dnd_actions argument must contain only values expressed in the
:func:`WlDataDeviceManager.dnd_actions()
<pywayland.protocol.wayland.WlDataDeviceManager.dnd_actions>` enum,
otherwise it will result in a protocol error.
This request must be made once only, and can only be made on sources
used in drag-and-drop, so it must be performed before
:func:`WlDataDevice.start_drag()
<pywayland.protocol.wayland.WlDataDevice.start_drag>`. Attempting to
use the source other than for drag-and-drop will raise a protocol
error.
:param dnd_actions:
actions supported by the data source
:type dnd_actions:
`ArgumentType.Uint`
"""
self._marshal(2, dnd_actions)
class WlDataSourceResource(Resource):
interface = WlDataSource
@WlDataSource.event(
Argument(ArgumentType.String, nullable=True),
)
def target(self, mime_type: str | None) -> None:
"""A target accepts an offered mime type
Sent when a target accepts pointer_focus or motion events. If a target
does not accept any of the offered types, type is NULL.
Used for feedback during drag-and-drop.
:param mime_type:
mime type accepted by the target
:type mime_type:
`ArgumentType.String` or `None`
"""
self._post_event(0, mime_type)
@WlDataSource.event(
Argument(ArgumentType.String),
Argument(ArgumentType.FileDescriptor),
)
def send(self, mime_type: str, fd: int) -> None:
"""Send the data
Request for data from the client. Send the data as the specified mime
type over the passed file descriptor, then close it.
:param mime_type:
mime type for the data
:type mime_type:
`ArgumentType.String`
:param fd:
file descriptor for the data
:type fd:
`ArgumentType.FileDescriptor`
"""
self._post_event(1, mime_type, fd)
@WlDataSource.event()
def cancelled(self) -> None:
"""Selection was cancelled
This data source is no longer valid. There are several reasons why this
could happen:
- The data source has been replaced by another data source.
- The drag-and-drop operation was performed, but the drop destination
did not accept any of the mime types offered through
:func:`WlDataSource.target()`.
- The drag-and-drop operation was performed, but the drop destination
did not select any of the actions present in the mask offered through
:func:`WlDataSource.action()`.
- The drag-and-drop operation was performed but didn't happen over a
surface.
- The compositor cancelled the drag-and-drop operation (e.g. compositor
dependent timeouts to avoid stale drag-and-drop transfers).
The client should clean up and destroy this data source.
For objects of version 2 or older, :func:`WlDataSource.cancelled()`
will only be emitted if the data source was replaced by another data
source.
"""
self._post_event(2)
@WlDataSource.event(version=3)
def dnd_drop_performed(self) -> None:
"""The drag-and-drop operation physically finished
The user performed the drop action. This event does not indicate
acceptance, :func:`WlDataSource.cancelled()` may still be emitted
afterwards if the drop destination does not accept any mime type.
However, this event might not be received if the compositor cancelled
the drag-and-drop operation before this event could happen.
Note that the data_source may still be used in the future and should
not be destroyed here.
"""
self._post_event(3)
@WlDataSource.event(version=3)
def dnd_finished(self) -> None:
"""The drag-and-drop operation concluded
The drop destination finished interoperating with this data source, so
the client is now free to destroy this data source and free all
associated data.
If the action used to perform the operation was "move", the source can
now delete the transferred data.
"""
self._post_event(4)
@WlDataSource.event(
Argument(ArgumentType.Uint),
version=3,
)
def action(self, dnd_action: int) -> None:
"""Notify the selected action
This event indicates the action selected by the compositor after
matching the source/destination side actions. Only one action (or none)
will be offered here.
This event can be emitted multiple times during the drag-and-drop
operation, mainly in response to destination side changes through
:func:`WlDataOffer.set_actions()
<pywayland.protocol.wayland.WlDataOffer.set_actions>`, and as the data
device enters/leaves surfaces.
It is only possible to receive this event after
:func:`WlDataSource.dnd_drop_performed()` if the drag-and-drop
operation ended in an "ask" action, in which case the final
:func:`WlDataSource.action()` event will happen immediately before
:func:`WlDataSource.dnd_finished()`.
Compositors may also change the selected action on the fly, mainly in
response to keyboard modifier changes during the drag-and-drop
operation.
The most recent action received is always the valid one. The chosen
action may change alongside negotiation (e.g. an "ask" action can turn
into a "move" operation), so the effects of the final action must
always be applied in :func:`WlDataSource.dnd_finished()`.
Clients can trigger cursor surface changes from this point, so they
reflect the current action.
:param dnd_action:
action selected by the compositor
:type dnd_action:
`ArgumentType.Uint`
"""
self._post_event(5, dnd_action)
class WlDataSourceGlobal(Global):
interface = WlDataSource
WlDataSource._gen_c()
WlDataSource.proxy_class = WlDataSourceProxy
WlDataSource.resource_class = WlDataSourceResource
WlDataSource.global_class = WlDataSourceGlobal
@@ -1,180 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from typing import Any
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_callback import WlCallback
from .wl_registry import WlRegistry
class WlDisplay(Interface):
"""Core global object
The core global object. This is a special singleton object. It is used
for internal Wayland protocol features.
"""
name = "wl_display"
version = 1
class error(enum.IntEnum):
invalid_object = 0
invalid_method = 1
no_memory = 2
implementation = 3
class WlDisplayProxy(Proxy[WlDisplay]):
interface = WlDisplay
@WlDisplay.request(
Argument(ArgumentType.NewId, interface=WlCallback),
)
def sync(self) -> Proxy[WlCallback]:
"""Asynchronous roundtrip
The sync request asks the server to emit the 'done' event on the
returned :class:`~pywayland.protocol.wayland.WlCallback` object. Since
requests are handled in-order and events are delivered in-order, this
can be used as a barrier to ensure all previous requests and the
resulting events have been handled.
The object returned by this request will be destroyed by the compositor
after the callback is fired and as such the client must not attempt to
use it after that point.
The callback_data passed in the callback is undefined and should be
ignored.
:returns:
:class:`~pywayland.protocol.wayland.WlCallback` -- callback object
for the sync request
"""
callback = self._marshal_constructor(0, WlCallback)
return callback
@WlDisplay.request(
Argument(ArgumentType.NewId, interface=WlRegistry),
)
def get_registry(self) -> Proxy[WlRegistry]:
"""Get global registry object
This request creates a registry object that allows the client to list
and bind the global objects available from the compositor.
It should be noted that the server side resources consumed in response
to a get_registry request can only be released when the client
disconnects, not when the client side proxy is destroyed. Therefore,
clients should invoke get_registry as infrequently as possible to avoid
wasting memory.
:returns:
:class:`~pywayland.protocol.wayland.WlRegistry` -- global registry
object
"""
registry = self._marshal_constructor(1, WlRegistry)
return registry
class WlDisplayResource(Resource):
interface = WlDisplay
@WlDisplay.event(
Argument(ArgumentType.Object),
Argument(ArgumentType.Uint),
Argument(ArgumentType.String),
)
def error(self, object_id: Any, code: int, message: str) -> None:
"""Fatal error event
The error event is sent out when a fatal (non-recoverable) error has
occurred. The object_id argument is the object where the error
occurred, most often in response to a request to that object. The code
identifies the error and is defined by the object interface. As such,
each interface defines its own set of error codes. The message is a
brief description of the error, for (debugging) convenience.
:param object_id:
object where the error occurred
:type object_id:
`ArgumentType.Object`
:param code:
error code
:type code:
`ArgumentType.Uint`
:param message:
error description
:type message:
`ArgumentType.String`
"""
self._post_event(0, object_id, code, message)
@WlDisplay.event(
Argument(ArgumentType.Uint),
)
def delete_id(self, id: int) -> None:
"""Acknowledge object id deletion
This event is used internally by the object ID management logic.
When the server stops using an object created by the client, the server
sends this event. In particular, after sending this event, the server
will no longer send any events that contain the object as the receiver
or as an argument.
When the client receives this event, it knows that it can reuse the
object ID.
:param id:
deleted object ID
:type id:
`ArgumentType.Uint`
"""
self._post_event(1, id)
class WlDisplayGlobal(Global):
interface = WlDisplay
WlDisplay._gen_c()
WlDisplay.proxy_class = WlDisplayProxy
WlDisplay.resource_class = WlDisplayResource
WlDisplay.global_class = WlDisplayGlobal
@@ -1,151 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_registry import WlRegistry
class WlFixes(Interface):
"""Wayland protocol fixes
This global fixes problems with other core-protocol interfaces that cannot
be fixed in these interfaces themselves.
"""
name = "wl_fixes"
version = 2
class error(enum.IntEnum):
invalid_ack_remove = 0
class WlFixesProxy(Proxy[WlFixes]):
interface = WlFixes
@WlFixes.request()
def destroy(self) -> None:
"""Destroys this object
"""
self._marshal(0)
self._destroy()
@WlFixes.request(
Argument(ArgumentType.Object, interface=WlRegistry),
)
def destroy_registry(self, registry: WlRegistry) -> None:
"""Destroy a :class:`~pywayland.protocol.wayland.WlRegistry`
This request destroys a :class:`~pywayland.protocol.wayland.WlRegistry`
object.
The client should no longer use the
:class:`~pywayland.protocol.wayland.WlRegistry` after making this
request.
The compositor will emit a :func:`WlDisplay.delete_id()
<pywayland.protocol.wayland.WlDisplay.delete_id>` event with the object
ID of the registry and will no longer emit any events on the registry.
The client should re-use the object ID once it receives the
:func:`WlDisplay.delete_id()
<pywayland.protocol.wayland.WlDisplay.delete_id>` event.
:param registry:
the registry to destroy
:type registry:
:class:`~pywayland.protocol.wayland.WlRegistry`
"""
self._marshal(1, registry)
@WlFixes.request(
Argument(ArgumentType.Object, interface=WlRegistry),
Argument(ArgumentType.Uint),
version=2,
)
def ack_global_remove(self, registry: WlRegistry, name: int) -> None:
"""Acknowledge global removal
Acknowledge the removal of the specified global.
If no global with the specified name exists or the global is not
removed, the :func:`WlFixes.invalid_ack_remove()` protocol error will
be posted.
Due to the Wayland protocol being asynchronous, the wl_global objects
cannot be destroyed immediately. For example, if a wl_global is removed
and a client attempts to bind that global around same time, it can
result in a protocol error due to an unknown global name in the bind
request.
In order to avoid crashing clients, the compositor should remove the
wl_global once it is guaranteed that no more bind requests will come.
The :func:`WlFixes.ack_global_remove()()` request is used to signal to
the compositor that the client will not bind the given global anymore.
After all clients acknowledge the removal of the global, the compositor
can safely destroy it.
The client must call the :func:`WlFixes.ack_global_remove()()` request
in response to a :func:`WlRegistry.global_remove()()
<pywayland.protocol.wayland.WlRegistry.global_remove()>` event even if
it did not bind the corresponding global.
:param registry:
the registry object
:type registry:
:class:`~pywayland.protocol.wayland.WlRegistry`
:param name:
unique name of the global
:type name:
`ArgumentType.Uint`
"""
self._marshal(2, registry, name)
class WlFixesResource(Resource):
interface = WlFixes
class WlFixesGlobal(Global):
interface = WlFixes
WlFixes._gen_c()
WlFixes.proxy_class = WlFixesProxy
WlFixes.resource_class = WlFixesResource
WlFixes.global_class = WlFixesGlobal
@@ -1,326 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_surface import WlSurface
class WlKeyboard(Interface):
"""Keyboard input device
The :class:`WlKeyboard` interface represents one or more keyboards
associated with a seat.
Each :class:`WlKeyboard` has the following logical state:
- an active surface (possibly null),
- the keys currently logically down,
- the active modifiers,
- the active group.
By default, the active surface is null, the keys currently logically down
are empty, the active modifiers and the active group are 0.
"""
name = "wl_keyboard"
version = 11
class keymap_format(enum.IntEnum):
no_keymap = 0
xkb_v1 = 1
class key_state(enum.IntEnum):
released = 0
pressed = 1
repeated = 2
class WlKeyboardProxy(Proxy[WlKeyboard]):
interface = WlKeyboard
@WlKeyboard.request(version=3)
def release(self) -> None:
"""Release the keyboard object
"""
self._marshal(0)
self._destroy()
class WlKeyboardResource(Resource):
interface = WlKeyboard
@WlKeyboard.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.FileDescriptor),
Argument(ArgumentType.Uint),
)
def keymap(self, format: int, fd: int, size: int) -> None:
"""Keyboard mapping
This event provides a file descriptor to the client which can be
memory-mapped in read-only mode to provide a keyboard mapping
description.
From version 7 onwards, the fd must be mapped with MAP_PRIVATE by the
recipient, as MAP_SHARED may fail.
:param format:
keymap format
:type format:
`ArgumentType.Uint`
:param fd:
keymap file descriptor
:type fd:
`ArgumentType.FileDescriptor`
:param size:
keymap size, in bytes
:type size:
`ArgumentType.Uint`
"""
self._post_event(0, format, fd, size)
@WlKeyboard.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Object, interface=WlSurface),
Argument(ArgumentType.Array),
)
def enter(self, serial: int, surface: WlSurface, keys: list) -> None:
"""Enter event
Notification that this seat's keyboard focus is on a certain surface.
The compositor must send the :func:`WlKeyboard.modifiers()` event after
this event.
In the :class:`WlKeyboard` logical state, this event sets the active
surface to the surface argument and the keys currently logically down
to the keys in the keys argument. The compositor must not send this
event if the :class:`WlKeyboard` already had an active surface
immediately before this event.
Clients should not use the list of pressed keys to emulate key-press
events. The order of keys in the list is unspecified.
:param serial:
serial number of the enter event
:type serial:
`ArgumentType.Uint`
:param surface:
surface gaining keyboard focus
:type surface:
:class:`~pywayland.protocol.wayland.WlSurface`
:param keys:
the keys currently logically down
:type keys:
`ArgumentType.Array`
"""
self._post_event(1, serial, surface, keys)
@WlKeyboard.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Object, interface=WlSurface),
)
def leave(self, serial: int, surface: WlSurface) -> None:
"""Leave event
Notification that this seat's keyboard focus is no longer on a certain
surface.
The leave notification is sent before the enter notification for the
new focus.
In the :class:`WlKeyboard` logical state, this event resets all values
to their defaults. The compositor must not send this event if the
active surface of the :class:`WlKeyboard` was not equal to the surface
argument immediately before this event.
:param serial:
serial number of the leave event
:type serial:
`ArgumentType.Uint`
:param surface:
surface that lost keyboard focus
:type surface:
:class:`~pywayland.protocol.wayland.WlSurface`
"""
self._post_event(2, serial, surface)
@WlKeyboard.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
)
def key(self, serial: int, time: int, key: int, state: int) -> None:
"""Key event
A key was pressed or released. The time argument is a timestamp with
millisecond granularity, with an undefined base.
The key is a platform-specific key code that can be interpreted by
feeding it to the keyboard mapping (see the keymap event).
If this event produces a change in modifiers, then the resulting
:func:`WlKeyboard.modifiers()` event must be sent after this event.
In the :class:`WlKeyboard` logical state, this event adds the key to
the keys currently logically down (if the state argument is pressed) or
removes the key from the keys currently logically down (if the state
argument is released). The compositor must not send this event if the
:class:`WlKeyboard` did not have an active surface immediately before
this event. The compositor must not send this event if state is pressed
(resp. released) and the key was already logically down (resp. was not
logically down) immediately before this event.
Since version 10, compositors may send key events with the "repeated"
key state when a :func:`WlKeyboard.repeat_info()` event with a rate
argument of 0 has been received. This allows the compositor to take
over the responsibility of key repetition.
:param serial:
serial number of the key event
:type serial:
`ArgumentType.Uint`
:param time:
timestamp with millisecond granularity
:type time:
`ArgumentType.Uint`
:param key:
key that produced the event
:type key:
`ArgumentType.Uint`
:param state:
physical state of the key
:type state:
`ArgumentType.Uint`
"""
self._post_event(3, serial, time, key, state)
@WlKeyboard.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
)
def modifiers(self, serial: int, mods_depressed: int, mods_latched: int, mods_locked: int, group: int) -> None:
"""Modifier and group state
Notifies clients that the modifier and/or group state has changed, and
it should update its local state.
The compositor may send this event without a surface of the client
having keyboard focus, for example to tie modifier information to
pointer focus instead. If a modifier event with pressed modifiers is
sent without a prior enter event, the client can assume the modifier
state is valid until it receives the next
:func:`WlKeyboard.modifiers()` event. In order to reset the modifier
state again, the compositor can send a :func:`WlKeyboard.modifiers()`
event with no pressed modifiers.
In the :class:`WlKeyboard` logical state, this event updates the
modifiers and group.
:param serial:
serial number of the modifiers event
:type serial:
`ArgumentType.Uint`
:param mods_depressed:
depressed modifiers
:type mods_depressed:
`ArgumentType.Uint`
:param mods_latched:
latched modifiers
:type mods_latched:
`ArgumentType.Uint`
:param mods_locked:
locked modifiers
:type mods_locked:
`ArgumentType.Uint`
:param group:
keyboard layout
:type group:
`ArgumentType.Uint`
"""
self._post_event(4, serial, mods_depressed, mods_latched, mods_locked, group)
@WlKeyboard.event(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
version=4,
)
def repeat_info(self, rate: int, delay: int) -> None:
"""Repeat rate and delay
Informs the client about the keyboard's repeat rate and delay.
This event is sent as soon as the :class:`WlKeyboard` object has been
created, and is guaranteed to be received by the client before any key
press event.
Negative values for either rate or delay are illegal. A rate of zero
will disable any repeating (regardless of the value of delay).
This event can be sent later on as well with a new value if necessary,
so clients should continue listening for the event past the creation of
:class:`WlKeyboard`.
:param rate:
the rate of repeating keys in characters per second
:type rate:
`ArgumentType.Int`
:param delay:
delay in milliseconds since key down until repeating starts
:type delay:
`ArgumentType.Int`
"""
self._post_event(5, rate, delay)
class WlKeyboardGlobal(Global):
interface = WlKeyboard
WlKeyboard._gen_c()
WlKeyboard.proxy_class = WlKeyboardProxy
WlKeyboard.resource_class = WlKeyboardResource
WlKeyboard.global_class = WlKeyboardGlobal
@@ -1,353 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
class WlOutput(Interface):
"""Compositor output region
An output describes part of the compositor geometry. The compositor works
in the 'compositor coordinate system' and an output corresponds to a
rectangular area in that space that is actually visible. This typically
corresponds to a monitor that displays part of the compositor space. This
object is published as global during start up, or when a monitor is
hotplugged.
"""
name = "wl_output"
version = 4
class subpixel(enum.IntEnum):
unknown = 0
none = 1
horizontal_rgb = 2
horizontal_bgr = 3
vertical_rgb = 4
vertical_bgr = 5
class transform(enum.IntEnum):
normal = 0
transform_90 = 1
transform_180 = 2
transform_270 = 3
flipped = 4
flipped_90 = 5
flipped_180 = 6
flipped_270 = 7
class mode(enum.IntFlag):
current = 0x1
preferred = 0x2
class WlOutputProxy(Proxy[WlOutput]):
interface = WlOutput
@WlOutput.request(version=3)
def release(self) -> None:
"""Release the output object
Using this request a client can tell the server that it is not going to
use the output object anymore.
"""
self._marshal(0)
self._destroy()
class WlOutputResource(Resource):
interface = WlOutput
@WlOutput.event(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.String),
Argument(ArgumentType.String),
Argument(ArgumentType.Int),
)
def geometry(self, x: int, y: int, physical_width: int, physical_height: int, subpixel: int, make: str, model: str, transform: int) -> None:
"""Properties of the output
The geometry event describes geometric properties of the output. The
event is sent when binding to the output object and whenever any of the
properties change.
The physical size can be set to zero if it doesn't make sense for this
output (e.g. for projectors or virtual outputs).
The geometry event will be followed by a done event (starting from
version 2).
Clients should use :func:`WlSurface.preferred_buffer_transform()
<pywayland.protocol.wayland.WlSurface.preferred_buffer_transform>`
instead of the transform advertised by this event to find the preferred
buffer transform to use for a surface.
Note: :class:`WlOutput` only advertises partial information about the
output position and identification. Some compositors, for instance
those not implementing a desktop-style output layout or those exposing
virtual outputs, might fake this information. Instead of using x and y,
clients should use xdg_output.logical_position. Instead of using make
and model, clients should use name and description.
:param x:
x position within the global compositor space
:type x:
`ArgumentType.Int`
:param y:
y position within the global compositor space
:type y:
`ArgumentType.Int`
:param physical_width:
width in millimeters of the output
:type physical_width:
`ArgumentType.Int`
:param physical_height:
height in millimeters of the output
:type physical_height:
`ArgumentType.Int`
:param subpixel:
subpixel orientation of the output
:type subpixel:
`ArgumentType.Int`
:param make:
textual description of the manufacturer
:type make:
`ArgumentType.String`
:param model:
textual description of the model
:type model:
`ArgumentType.String`
:param transform:
additional transformation applied to buffer contents during
presentation
:type transform:
`ArgumentType.Int`
"""
self._post_event(0, x, y, physical_width, physical_height, subpixel, make, model, transform)
@WlOutput.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def mode(self, flags: int, width: int, height: int, refresh: int) -> None:
"""Advertise available modes for the output
The mode event describes an available mode for the output.
The event is sent when binding to the output object and there will
always be one mode, the current mode. The event is sent again if an
output changes mode, for the mode that is now current. In other words,
the current mode is always the last mode that was received with the
current flag set.
Non-current modes are deprecated. A compositor can decide to only
advertise the current mode and never send other modes. Clients should
not rely on non-current modes.
The size of a mode is given in physical hardware units of the output
device. This is not necessarily the same as the output size in the
global compositor space. For instance, the output may be scaled, as
described in :func:`WlOutput.scale()`, or transformed, as described in
:func:`WlOutput.transform()`. Clients willing to retrieve the output
size in the global compositor space should use xdg_output.logical_size
instead.
The vertical refresh rate can be set to zero if it doesn't make sense
for this output (e.g. for virtual outputs).
The mode event will be followed by a done event (starting from version
2).
Clients should not use the refresh rate to schedule frames. Instead,
they should use the :func:`WlSurface.frame()
<pywayland.protocol.wayland.WlSurface.frame>` event or the
presentation-time protocol.
Note: this information is not always meaningful for all outputs. Some
compositors, such as those exposing virtual outputs, might fake the
refresh rate or the size.
:param flags:
bitfield of mode flags
:type flags:
`ArgumentType.Uint`
:param width:
width of the mode in hardware units
:type width:
`ArgumentType.Int`
:param height:
height of the mode in hardware units
:type height:
`ArgumentType.Int`
:param refresh:
vertical refresh rate in mHz
:type refresh:
`ArgumentType.Int`
"""
self._post_event(1, flags, width, height, refresh)
@WlOutput.event(version=2)
def done(self) -> None:
"""Sent all information about output
This event is sent after all other properties have been sent after
binding to the output object and after any other property changes done
after that. This allows changes to the output properties to be seen as
atomic, even if they happen via multiple events.
"""
self._post_event(2)
@WlOutput.event(
Argument(ArgumentType.Int),
version=2,
)
def scale(self, factor: int) -> None:
"""Output scaling properties
This event contains scaling geometry information that is not in the
geometry event. It may be sent after binding the output object or if
the output scale changes later. The compositor will emit a non-zero,
positive value for scale. If it is not sent, the client should assume a
scale of 1.
A scale larger than 1 means that the compositor will automatically
scale surface buffers by this amount when rendering. This is used for
very high resolution displays where applications rendering at the
native resolution would be too small to be legible.
Clients should use :func:`WlSurface.preferred_buffer_scale()
<pywayland.protocol.wayland.WlSurface.preferred_buffer_scale>` instead
of this event to find the preferred buffer scale to use for a surface.
The scale event will be followed by a done event.
:param factor:
scaling factor of output
:type factor:
`ArgumentType.Int`
"""
self._post_event(3, factor)
@WlOutput.event(
Argument(ArgumentType.String),
version=4,
)
def name(self, name: str) -> None:
"""Name of this output
Many compositors will assign user-friendly names to their outputs, show
them to the user, allow the user to refer to an output, etc. The client
may wish to know this name as well to offer the user similar behaviors.
The name is a UTF-8 string with no convention defined for its contents.
Each name is unique among all :class:`WlOutput` globals. The name is
only guaranteed to be unique for the compositor instance.
The same output name is used for all clients for a given
:class:`WlOutput` global. Thus, the name can be shared across processes
to refer to a specific :class:`WlOutput` global.
The name is not guaranteed to be persistent across sessions, thus
cannot be used to reliably identify an output in e.g. configuration
files.
Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do
not assume that the name is a reflection of an underlying DRM
connector, X11 connection, etc.
The name event is sent after binding the output object. This event is
only sent once per output object, and the name does not change over the
lifetime of the :class:`WlOutput` global.
Compositors may re-use the same output name if the :class:`WlOutput`
global is destroyed and re-created later. Compositors should avoid re-
using the same name if possible.
The name event will be followed by a done event.
:param name:
output name
:type name:
`ArgumentType.String`
"""
self._post_event(4, name)
@WlOutput.event(
Argument(ArgumentType.String),
version=4,
)
def description(self, description: str) -> None:
"""Human-readable description of this output
Many compositors can produce human-readable descriptions of their
outputs. The client may wish to know this description as well, e.g. for
output selection purposes.
The description is a UTF-8 string with no convention defined for its
contents. The description is not guaranteed to be unique among all
:class:`WlOutput` globals. Examples might include 'Foocorp 11" Display'
or 'Virtual X11 output via :1'.
The description event is sent after binding the output object and
whenever the description changes. The description is optional, and may
not be sent at all.
The description event will be followed by a done event.
:param description:
output description
:type description:
`ArgumentType.String`
"""
self._post_event(5, description)
class WlOutputGlobal(Global):
interface = WlOutput
WlOutput._gen_c()
WlOutput.proxy_class = WlOutputProxy
WlOutput.resource_class = WlOutputResource
WlOutput.global_class = WlOutputGlobal
@@ -1,627 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_surface import WlSurface
class WlPointer(Interface):
"""Pointer input device
The :class:`WlPointer` interface represents one or more input devices, such
as mice, which control the pointer location and pointer_focus of a seat.
The :class:`WlPointer` interface generates motion, enter and leave events
for the surfaces that the pointer is located over, and button and axis
events for button presses, button releases and scrolling.
"""
name = "wl_pointer"
version = 11
class error(enum.IntEnum):
role = 0
class button_state(enum.IntEnum):
released = 0
pressed = 1
class axis(enum.IntEnum):
vertical_scroll = 0
horizontal_scroll = 1
class axis_source(enum.IntEnum):
wheel = 0
finger = 1
continuous = 2
wheel_tilt = 3
class axis_relative_direction(enum.IntEnum):
identical = 0
inverted = 1
class WlPointerProxy(Proxy[WlPointer]):
interface = WlPointer
@WlPointer.request(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Object, interface=WlSurface, nullable=True),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def set_cursor(self, serial: int, surface: WlSurface | None, hotspot_x: int, hotspot_y: int) -> None:
"""Set the pointer surface
Set the pointer surface, i.e., the surface that contains the pointer
image (cursor). This request gives the surface the role of a cursor. If
the surface already has another role, it raises a protocol error.
The cursor actually changes only if the pointer focus for this device
is one of the requesting client's surfaces or the surface parameter is
the current pointer surface. If there was a previous surface set with
this request it is replaced. If surface is NULL, the pointer image is
hidden.
The parameters hotspot_x and hotspot_y define the position of the
pointer surface relative to the pointer location. Its top-left corner
is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the
coordinates of the pointer location, in surface-local coordinates.
On :func:`WlSurface.offset()
<pywayland.protocol.wayland.WlSurface.offset>` requests to the pointer
surface, hotspot_x and hotspot_y are decremented by the x and y
parameters passed to the request. The offset must be applied by
:func:`WlSurface.commit()
<pywayland.protocol.wayland.WlSurface.commit>` as usual.
The hotspot can also be updated by passing the currently set pointer
surface to this request with new values for hotspot_x and hotspot_y.
The input region is ignored for wl_surfaces with the role of a cursor.
When the use as a cursor ends, the
:class:`~pywayland.protocol.wayland.WlSurface` is unmapped.
The serial parameter must match the latest :func:`WlPointer.enter()`
serial number sent to the client. Otherwise the request will be
ignored.
:param serial:
serial number of the enter event
:type serial:
`ArgumentType.Uint`
:param surface:
pointer surface
:type surface:
:class:`~pywayland.protocol.wayland.WlSurface` or `None`
:param hotspot_x:
surface-local x coordinate
:type hotspot_x:
`ArgumentType.Int`
:param hotspot_y:
surface-local y coordinate
:type hotspot_y:
`ArgumentType.Int`
"""
self._marshal(0, serial, surface, hotspot_x, hotspot_y)
@WlPointer.request(version=3)
def release(self) -> None:
"""Release the pointer object
Using this request a client can tell the server that it is not going to
use the pointer object anymore.
This request destroys the pointer proxy object, so clients must not
call wl_pointer_destroy() after using this request.
"""
self._marshal(1)
self._destroy()
class WlPointerResource(Resource):
interface = WlPointer
@WlPointer.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Object, interface=WlSurface),
Argument(ArgumentType.Fixed),
Argument(ArgumentType.Fixed),
)
def enter(self, serial: int, surface: WlSurface, surface_x: float, surface_y: float) -> None:
"""Enter event
Notification that this seat's pointer is focused on a certain surface.
When a seat's focus enters a surface, the pointer image is undefined
and a client should respond to this event by setting an appropriate
pointer image with the set_cursor request.
:param serial:
serial number of the enter event
:type serial:
`ArgumentType.Uint`
:param surface:
surface entered by the pointer
:type surface:
:class:`~pywayland.protocol.wayland.WlSurface`
:param surface_x:
surface-local x coordinate
:type surface_x:
`ArgumentType.Fixed`
:param surface_y:
surface-local y coordinate
:type surface_y:
`ArgumentType.Fixed`
"""
self._post_event(0, serial, surface, surface_x, surface_y)
@WlPointer.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Object, interface=WlSurface),
)
def leave(self, serial: int, surface: WlSurface) -> None:
"""Leave event
Notification that this seat's pointer is no longer focused on a certain
surface.
The leave notification is sent before the enter notification for the
new focus.
:param serial:
serial number of the leave event
:type serial:
`ArgumentType.Uint`
:param surface:
surface left by the pointer
:type surface:
:class:`~pywayland.protocol.wayland.WlSurface`
"""
self._post_event(1, serial, surface)
@WlPointer.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Fixed),
Argument(ArgumentType.Fixed),
)
def motion(self, time: int, surface_x: float, surface_y: float) -> None:
"""Pointer motion event
Notification of pointer location change. The arguments surface_x and
surface_y are the location relative to the focused surface.
:param time:
timestamp with millisecond granularity
:type time:
`ArgumentType.Uint`
:param surface_x:
surface-local x coordinate
:type surface_x:
`ArgumentType.Fixed`
:param surface_y:
surface-local y coordinate
:type surface_y:
`ArgumentType.Fixed`
"""
self._post_event(2, time, surface_x, surface_y)
@WlPointer.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
)
def button(self, serial: int, time: int, button: int, state: int) -> None:
"""Pointer button event
Mouse button click and release notifications.
The location of the click is given by the last motion, warp or enter
event. The time argument is a timestamp with millisecond granularity,
with an undefined base.
The button is a button code as defined in the Linux kernel's
linux/input-event-codes.h header file, e.g. BTN_LEFT.
Any 16-bit button code value is reserved for future additions to the
kernel's event code list. All other button codes above 0xFFFF are
currently undefined but may be used in future versions of this
protocol.
:param serial:
serial number of the button event
:type serial:
`ArgumentType.Uint`
:param time:
timestamp with millisecond granularity
:type time:
`ArgumentType.Uint`
:param button:
button that produced the event
:type button:
`ArgumentType.Uint`
:param state:
physical state of the button
:type state:
`ArgumentType.Uint`
"""
self._post_event(3, serial, time, button, state)
@WlPointer.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Fixed),
)
def axis(self, time: int, axis: int, value: float) -> None:
"""Axis event
Scroll and other axis notifications.
For scroll events (vertical and horizontal scroll axes), the value
parameter is the length of a vector along the specified axis in a
coordinate space identical to those of motion events, representing a
relative movement along the specified axis.
For devices that support movements non-parallel to axes multiple axis
events will be emitted.
When applicable, for example for touch pads, the server can choose to
emit scroll events where the motion vector is equivalent to a motion
event vector.
When applicable, a client can transform its content relative to the
scroll distance.
:param time:
timestamp with millisecond granularity
:type time:
`ArgumentType.Uint`
:param axis:
axis type
:type axis:
`ArgumentType.Uint`
:param value:
length of vector in surface-local coordinate space
:type value:
`ArgumentType.Fixed`
"""
self._post_event(4, time, axis, value)
@WlPointer.event(version=5)
def frame(self) -> None:
"""End of a pointer event sequence
Indicates the end of a set of events that logically belong together. A
client is expected to accumulate the data in all events within the
frame before proceeding.
All :class:`WlPointer` events before a :func:`WlPointer.frame()` event
belong logically together. For example, in a diagonal scroll motion the
compositor will send an optional :func:`WlPointer.axis_source()` event,
two :func:`WlPointer.axis()` events (horizontal and vertical) and
finally a :func:`WlPointer.frame()` event. The client may use this
information to calculate a diagonal vector for scrolling.
When multiple :func:`WlPointer.axis()` events occur within the same
frame, the motion vector is the combined motion of all events. When a
:func:`WlPointer.axis()` and a :func:`WlPointer.axis_stop()` event
occur within the same frame, this indicates that axis movement in one
axis has stopped but continues in the other axis. When multiple
:func:`WlPointer.axis_stop()` events occur within the same frame, this
indicates that these axes stopped in the same instance.
A :func:`WlPointer.frame()` event is sent for every logical event
group, even if the group only contains a single :class:`WlPointer`
event. Specifically, a client may get a sequence: motion, frame,
button, frame, axis, frame, axis_stop, frame.
The :func:`WlPointer.enter()` and :func:`WlPointer.leave()` events are
logical events generated by the compositor and not the hardware. These
events are also grouped by a :func:`WlPointer.frame()`. When a pointer
moves from one surface to another, a compositor should group the
:func:`WlPointer.leave()` event within the same
:func:`WlPointer.frame()`. However, a client must not rely on
:func:`WlPointer.leave()` and :func:`WlPointer.enter()` being in the
same :func:`WlPointer.frame()`. Compositor-specific policies may
require the :func:`WlPointer.leave()` and :func:`WlPointer.enter()`
event being split across multiple :func:`WlPointer.frame()` groups.
"""
self._post_event(5)
@WlPointer.event(
Argument(ArgumentType.Uint),
version=5,
)
def axis_source(self, axis_source: int) -> None:
"""Axis source event
Source information for scroll and other axes.
This event does not occur on its own. It is sent before a
:func:`WlPointer.frame()` event and carries the source information for
all events within that frame.
The source specifies how this event was generated. If the source is
:func:`WlPointer.axis_source()`.finger, a :func:`WlPointer.axis_stop()`
event will be sent when the user lifts the finger off the device.
If the source is :func:`WlPointer.axis_source()`.wheel,
:func:`WlPointer.axis_source()`.wheel_tilt or
:func:`WlPointer.axis_source()`.continuous, a
:func:`WlPointer.axis_stop()` event may or may not be sent. Whether a
compositor sends an axis_stop event for these sources is hardware-
specific and implementation-dependent; clients must not rely on
receiving an axis_stop event for these scroll sources and should treat
scroll sequences from these scroll sources as unterminated by default.
This event is optional. If the source is unknown for a particular axis
event sequence, no event is sent. Only one
:func:`WlPointer.axis_source()` event is permitted per frame.
The order of :func:`WlPointer.axis_discrete()` and
:func:`WlPointer.axis_source()` is not guaranteed.
:param axis_source:
source of the axis event
:type axis_source:
`ArgumentType.Uint`
"""
self._post_event(6, axis_source)
@WlPointer.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
version=5,
)
def axis_stop(self, time: int, axis: int) -> None:
"""Axis stop event
Stop notification for scroll and other axes.
For some :func:`WlPointer.axis_source()` types, a
:func:`WlPointer.axis_stop()` event is sent to notify a client that the
axis sequence has terminated. This enables the client to implement
kinetic scrolling. See the :func:`WlPointer.axis_source()`
documentation for information on when this event may be generated.
Any :func:`WlPointer.axis()` events with the same axis_source after
this event should be considered as the start of a new axis motion.
The timestamp is to be interpreted identical to the timestamp in the
:func:`WlPointer.axis()` event. The timestamp value may be the same as
a preceding :func:`WlPointer.axis()` event.
:param time:
timestamp with millisecond granularity
:type time:
`ArgumentType.Uint`
:param axis:
the axis stopped with this event
:type axis:
`ArgumentType.Uint`
"""
self._post_event(7, time, axis)
@WlPointer.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Int),
version=5,
)
def axis_discrete(self, axis: int, discrete: int) -> None:
"""Axis click event
Discrete step information for scroll and other axes.
This event carries the axis value of the :func:`WlPointer.axis()` event
in discrete steps (e.g. mouse wheel clicks).
This event is deprecated with :class:`WlPointer` version 8 - this event
is not sent to clients supporting version 8 or later.
This event does not occur on its own, it is coupled with a
:func:`WlPointer.axis()` event that represents this axis value on a
continuous scale. The protocol guarantees that each axis_discrete event
is always followed by exactly one axis event with the same axis number
within the same :func:`WlPointer.frame()`. Note that the protocol
allows for other events to occur between the axis_discrete and its
coupled axis event, including other axis_discrete or axis events. A
:func:`WlPointer.frame()` must not contain more than one axis_discrete
event per axis type.
This event is optional; continuous scrolling devices like two-finger
scrolling on touchpads do not have discrete steps and do not generate
this event.
The discrete value carries the directional information. e.g. a value of
-2 is two steps towards the negative direction of this axis.
The axis number is identical to the axis number in the associated axis
event.
The order of :func:`WlPointer.axis_discrete()` and
:func:`WlPointer.axis_source()` is not guaranteed.
:param axis:
axis type
:type axis:
`ArgumentType.Uint`
:param discrete:
number of steps
:type discrete:
`ArgumentType.Int`
"""
self._post_event(8, axis, discrete)
@WlPointer.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Int),
version=8,
)
def axis_value120(self, axis: int, value120: int) -> None:
"""Axis high-resolution scroll event
Discrete high-resolution scroll information.
This event carries high-resolution wheel scroll information, with each
multiple of 120 representing one logical scroll step (a wheel detent).
For example, an axis_value120 of 30 is one quarter of a logical scroll
step in the positive direction, a value120 of -240 are two logical
scroll steps in the negative direction within the same hardware event.
Clients that rely on discrete scrolling should accumulate the value120
to multiples of 120 before processing the event.
The value120 must not be zero.
This event replaces the :func:`WlPointer.axis_discrete()` event in
clients supporting :class:`WlPointer` version 8 or later.
Where a :func:`WlPointer.axis_source()` event occurs in the same
:func:`WlPointer.frame()`, the axis source applies to this event.
The order of :class:`WlPointer`.axis_value120 and
:func:`WlPointer.axis_source()` is not guaranteed.
:param axis:
axis type
:type axis:
`ArgumentType.Uint`
:param value120:
scroll distance as fraction of 120
:type value120:
`ArgumentType.Int`
"""
self._post_event(9, axis, value120)
@WlPointer.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
version=9,
)
def axis_relative_direction(self, axis: int, direction: int) -> None:
"""Axis relative physical direction event
Relative directional information of the entity causing the axis motion.
For a :func:`WlPointer.axis()` event, the
:func:`WlPointer.axis_relative_direction()` event specifies the
movement direction of the entity causing the :func:`WlPointer.axis()`
event. For example: - if a user's fingers on a touchpad move down and
this causes a :func:`WlPointer.axis()` vertical_scroll down event,
the physical direction is 'identical' - if a user's fingers on a
touchpad move down and this causes a :func:`WlPointer.axis()`
vertical_scroll up scroll up event ('natural scrolling'), the
physical direction is 'inverted'.
A client may use this information to adjust scroll motion of
components. Specifically, enabling natural scrolling causes the content
to change direction compared to traditional scrolling. Some widgets
like volume control sliders should usually match the physical direction
regardless of whether natural scrolling is active. This event enables
clients to match the scroll direction of a widget to the physical
direction.
This event does not occur on its own, it is coupled with a
:func:`WlPointer.axis()` event that represents this axis value. The
protocol guarantees that each axis_relative_direction event is always
followed by exactly one axis event with the same axis number within the
same :func:`WlPointer.frame()`. Note that the protocol allows for other
events to occur between the axis_relative_direction and its coupled
axis event.
The axis number is identical to the axis number in the associated axis
event.
The order of :func:`WlPointer.axis_relative_direction()`,
:func:`WlPointer.axis_discrete()` and :func:`WlPointer.axis_source()`
is not guaranteed.
:param axis:
axis type
:type axis:
`ArgumentType.Uint`
:param direction:
physical direction relative to axis motion
:type direction:
`ArgumentType.Uint`
"""
self._post_event(10, axis, direction)
@WlPointer.event(
Argument(ArgumentType.Fixed),
Argument(ArgumentType.Fixed),
version=11,
)
def warp(self, surface_x: float, surface_y: float) -> None:
"""Pointer warp event
Notification of pointer location change within a surface.
This location change is not due to events on the input device, but
because either the surface under the pointer was moved and thus the
relative position of the pointer changed, or because the compositor
changed the pointer position in response to an event like pointer
confinement being exited.
The arguments surface_x and surface_y are the location relative to the
focused surface.
This event must not occur in the same :func:`WlPointer.frame()` as a
:func:`WlPointer.enter()` or :func:`WlPointer.motion()` event.
:param surface_x:
surface-local x coordinate
:type surface_x:
`ArgumentType.Fixed`
:param surface_y:
surface-local y coordinate
:type surface_y:
`ArgumentType.Fixed`
"""
self._post_event(11, surface_x, surface_y)
class WlPointerGlobal(Global):
interface = WlPointer
WlPointer._gen_c()
WlPointer.proxy_class = WlPointerProxy
WlPointer.resource_class = WlPointerResource
WlPointer.global_class = WlPointerGlobal
@@ -1,137 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
class WlRegion(Interface):
"""Region interface
A region object describes an area.
Region objects are used to describe the opaque and input regions of a
surface.
"""
name = "wl_region"
version = 7
class WlRegionProxy(Proxy[WlRegion]):
interface = WlRegion
@WlRegion.request()
def destroy(self) -> None:
"""Destroy region
Destroy the region. This will invalidate the object ID.
"""
self._marshal(0)
self._destroy()
@WlRegion.request(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def add(self, x: int, y: int, width: int, height: int) -> None:
"""Add rectangle to region
Add the specified rectangle to the region.
:param x:
region-local x coordinate
:type x:
`ArgumentType.Int`
:param y:
region-local y coordinate
:type y:
`ArgumentType.Int`
:param width:
rectangle width
:type width:
`ArgumentType.Int`
:param height:
rectangle height
:type height:
`ArgumentType.Int`
"""
self._marshal(1, x, y, width, height)
@WlRegion.request(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def subtract(self, x: int, y: int, width: int, height: int) -> None:
"""Subtract rectangle from region
Subtract the specified rectangle from the region.
:param x:
region-local x coordinate
:type x:
`ArgumentType.Int`
:param y:
region-local y coordinate
:type y:
`ArgumentType.Int`
:param width:
rectangle width
:type width:
`ArgumentType.Int`
:param height:
rectangle height
:type height:
`ArgumentType.Int`
"""
self._marshal(2, x, y, width, height)
class WlRegionResource(Resource):
interface = WlRegion
class WlRegionGlobal(Global):
interface = WlRegion
WlRegion._gen_c()
WlRegion.proxy_class = WlRegionProxy
WlRegion.resource_class = WlRegionResource
WlRegion.global_class = WlRegionGlobal
@@ -1,167 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
from typing import TypeVar
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
T = TypeVar("T", bound=Interface)
class WlRegistry(Interface):
"""Global registry object
The singleton global registry object. The server has a number of global
objects that are available to all clients. These objects typically
represent an actual object in the server (for example, an input device) or
they are singleton objects that provide extension functionality.
When a client creates a registry object, the registry object will emit a
global event for each global currently in the registry. Globals come and
go as a result of device or monitor hotplugs, reconfiguration or other
events, and the registry will send out global and global_remove events to
keep the client up to date with the changes. To mark the end of the
initial burst of events, the client can use the :func:`WlDisplay.sync()
<pywayland.protocol.wayland.WlDisplay.sync>` request immediately after
calling :func:`WlDisplay.get_registry()
<pywayland.protocol.wayland.WlDisplay.get_registry>`.
A client can bind to a global object by using the bind request. This
creates a client-side handle that lets the object emit events to the client
and lets the client invoke requests on the object.
"""
name = "wl_registry"
version = 1
class WlRegistryProxy(Proxy[WlRegistry]):
interface = WlRegistry
@WlRegistry.request(
Argument(ArgumentType.Uint),
Argument(ArgumentType.NewId),
)
def bind(self, name: int, interface: type[T], version: int) -> Proxy[T]:
"""Bind an object to the display
Binds a new, client-created object to the server using the specified
name as the identifier.
:param name:
unique numeric name of the object
:type name:
`ArgumentType.Uint`
:param interface:
Interface name
:type interface:
`string`
:param version:
Interface version
:type version:
`int`
:returns:
:class:`pywayland.client.proxy.Proxy` of specified Interface --
bound object
"""
id = self._marshal_constructor(0, interface, name, interface.name, version)
return id
class WlRegistryResource(Resource):
interface = WlRegistry
@WlRegistry.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.String),
Argument(ArgumentType.Uint),
)
def global_(self, name: int, interface: str, version: int) -> None:
"""Announce global object
Notify the client of global objects.
The event notifies the client that a global object with the given name
is now available, and it implements the given version of the given
interface.
:param name:
numeric name of the global object
:type name:
`ArgumentType.Uint`
:param interface:
interface implemented by the object
:type interface:
`ArgumentType.String`
:param version:
interface version
:type version:
`ArgumentType.Uint`
"""
self._post_event(0, name, interface, version)
@WlRegistry.event(
Argument(ArgumentType.Uint),
)
def global_remove(self, name: int) -> None:
"""Announce removal of global object
Notify the client of removed global objects.
This event notifies the client that the global identified by name is no
longer available. If the client bound to the global using the bind
request, the client should now destroy that object.
The object remains valid and requests to the object will be ignored
until the client destroys it, to avoid races between the global going
away and a client sending a request to it.
:param name:
numeric name of the global object
:type name:
`ArgumentType.Uint`
"""
self._post_event(1, name)
class WlRegistryGlobal(Global):
interface = WlRegistry
WlRegistry._gen_c()
WlRegistry.proxy_class = WlRegistryProxy
WlRegistry.resource_class = WlRegistryResource
WlRegistry.global_class = WlRegistryGlobal
@@ -1,234 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_keyboard import WlKeyboard
from .wl_pointer import WlPointer
from .wl_touch import WlTouch
class WlSeat(Interface):
"""Group of input devices
A seat is a group of keyboards, pointer and touch devices. This object is
published as a global during start up, or when such a device is hot
plugged. A seat typically has a pointer and maintains a keyboard focus and
a pointer focus.
"""
name = "wl_seat"
version = 11
class capability(enum.IntFlag):
pointer = 1
keyboard = 2
touch = 4
class error(enum.IntEnum):
missing_capability = 0
class WlSeatProxy(Proxy[WlSeat]):
interface = WlSeat
@WlSeat.request(
Argument(ArgumentType.NewId, interface=WlPointer),
)
def get_pointer(self) -> Proxy[WlPointer]:
"""Return pointer object
The ID provided will be initialized to the
:class:`~pywayland.protocol.wayland.WlPointer` interface for this seat.
This request only takes effect if the seat has the pointer capability,
or has had the pointer capability in the past. It is a protocol
violation to issue this request on a seat that has never had the
pointer capability. The missing_capability error will be sent in this
case.
:returns:
:class:`~pywayland.protocol.wayland.WlPointer` -- seat pointer
"""
id = self._marshal_constructor(0, WlPointer)
return id
@WlSeat.request(
Argument(ArgumentType.NewId, interface=WlKeyboard),
)
def get_keyboard(self) -> Proxy[WlKeyboard]:
"""Return keyboard object
The ID provided will be initialized to the
:class:`~pywayland.protocol.wayland.WlKeyboard` interface for this
seat.
This request only takes effect if the seat has the keyboard capability,
or has had the keyboard capability in the past. It is a protocol
violation to issue this request on a seat that has never had the
keyboard capability. The missing_capability error will be sent in this
case.
:returns:
:class:`~pywayland.protocol.wayland.WlKeyboard` -- seat keyboard
"""
id = self._marshal_constructor(1, WlKeyboard)
return id
@WlSeat.request(
Argument(ArgumentType.NewId, interface=WlTouch),
)
def get_touch(self) -> Proxy[WlTouch]:
"""Return touch object
The ID provided will be initialized to the
:class:`~pywayland.protocol.wayland.WlTouch` interface for this seat.
This request only takes effect if the seat has the touch capability, or
has had the touch capability in the past. It is a protocol violation to
issue this request on a seat that has never had the touch capability.
The missing_capability error will be sent in this case.
:returns:
:class:`~pywayland.protocol.wayland.WlTouch` -- seat touch
interface
"""
id = self._marshal_constructor(2, WlTouch)
return id
@WlSeat.request(version=5)
def release(self) -> None:
"""Release the seat object
Using this request a client can tell the server that it is not going to
use the seat object anymore.
"""
self._marshal(3)
self._destroy()
class WlSeatResource(Resource):
interface = WlSeat
@WlSeat.event(
Argument(ArgumentType.Uint),
)
def capabilities(self, capabilities: int) -> None:
"""Seat capabilities changed
This is sent on binding to the seat global or whenever a seat gains or
loses the pointer, keyboard or touch capabilities. The argument is a
capability enum containing the complete set of capabilities this seat
has.
When the pointer capability is added, a client may create a
:class:`~pywayland.protocol.wayland.WlPointer` object using the
:func:`WlSeat.get_pointer()` request. This object will receive pointer
events until the capability is removed in the future.
When the pointer capability is removed, a client should destroy the
:class:`~pywayland.protocol.wayland.WlPointer` objects associated with
the seat where the capability was removed, using the
:func:`WlPointer.release()
<pywayland.protocol.wayland.WlPointer.release>` request. No further
pointer events will be received on these objects.
In some compositors, if a seat regains the pointer capability and a
client has a previously obtained
:class:`~pywayland.protocol.wayland.WlPointer` object of version 4 or
less, that object may start sending pointer events again. This behavior
is considered a misinterpretation of the intended behavior and must not
be relied upon by the client.
:class:`~pywayland.protocol.wayland.WlPointer` objects of version 5 or
later must not send events if created before the most recent event
notifying the client of an added pointer capability.
The above behavior also applies to
:class:`~pywayland.protocol.wayland.WlKeyboard` and
:class:`~pywayland.protocol.wayland.WlTouch` with the keyboard and
touch capabilities, respectively.
:param capabilities:
capabilities of the seat
:type capabilities:
`ArgumentType.Uint`
"""
self._post_event(0, capabilities)
@WlSeat.event(
Argument(ArgumentType.String),
version=2,
)
def name(self, name: str) -> None:
"""Unique identifier for this seat
In a multi-seat configuration the seat name can be used by clients to
help identify which physical devices the seat represents.
The seat name is a UTF-8 string with no convention defined for its
contents. Each name is unique among all :class:`WlSeat` globals. The
name is only guaranteed to be unique for the current compositor
instance.
The same seat names are used for all clients. Thus, the name can be
shared across processes to refer to a specific :class:`WlSeat` global.
The name event is sent after binding to the seat global, and should be
sent before announcing capabilities. This event is only sent once per
seat object, and the name does not change over the lifetime of the
:class:`WlSeat` global.
Compositors may re-use the same seat name if the :class:`WlSeat` global
is destroyed and re-created later.
:param name:
seat identifier
:type name:
`ArgumentType.String`
"""
self._post_event(1, name)
class WlSeatGlobal(Global):
interface = WlSeat
WlSeat._gen_c()
WlSeat.proxy_class = WlSeatProxy
WlSeat.resource_class = WlSeatResource
WlSeat.global_class = WlSeatGlobal
@@ -1,106 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_shell_surface import WlShellSurface
from .wl_surface import WlSurface
class WlShell(Interface):
"""Create desktop-style surfaces
This interface is implemented by servers that provide desktop-style user
interfaces.
It allows clients to associate a
:class:`~pywayland.protocol.wayland.WlShellSurface` with a basic surface.
Note! This protocol is deprecated and not intended for production use. For
desktop-style user interfaces, use xdg_shell. Compositors and clients
should not implement this interface.
"""
name = "wl_shell"
version = 1
class error(enum.IntEnum):
role = 0
class WlShellProxy(Proxy[WlShell]):
interface = WlShell
@WlShell.request(
Argument(ArgumentType.NewId, interface=WlShellSurface),
Argument(ArgumentType.Object, interface=WlSurface),
)
def get_shell_surface(self, surface: WlSurface) -> Proxy[WlShellSurface]:
"""Create a shell surface from a surface
Create a shell surface for an existing surface. This gives the
:class:`~pywayland.protocol.wayland.WlSurface` the role of a shell
surface. If the :class:`~pywayland.protocol.wayland.WlSurface` already
has another role, it raises a protocol error.
Only one shell surface can be associated with a given surface.
:param surface:
surface to be given the shell surface role
:type surface:
:class:`~pywayland.protocol.wayland.WlSurface`
:returns:
:class:`~pywayland.protocol.wayland.WlShellSurface` -- shell
surface to create
"""
id = self._marshal_constructor(0, WlShellSurface, surface)
return id
class WlShellResource(Resource):
interface = WlShell
class WlShellGlobal(Global):
interface = WlShell
WlShell._gen_c()
WlShell.proxy_class = WlShellProxy
WlShell.resource_class = WlShellResource
WlShell.global_class = WlShellGlobal
@@ -1,463 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_output import WlOutput
from .wl_seat import WlSeat
from .wl_surface import WlSurface
class WlShellSurface(Interface):
"""Desktop-style metadata interface
An interface that may be implemented by a
:class:`~pywayland.protocol.wayland.WlSurface`, for implementations that
provide a desktop-style user interface.
It provides requests to treat surfaces like toplevel, fullscreen or popup
windows, move, resize or maximize them, associate metadata like title and
class, etc.
On the server side the object is automatically destroyed when the related
:class:`~pywayland.protocol.wayland.WlSurface` is destroyed. On the client
side, wl_shell_surface_destroy() must be called before destroying the
:class:`~pywayland.protocol.wayland.WlSurface` object.
"""
name = "wl_shell_surface"
version = 1
class resize(enum.IntFlag):
none = 0
top = 1
bottom = 2
left = 4
top_left = 5
bottom_left = 6
right = 8
top_right = 9
bottom_right = 10
class transient(enum.IntFlag):
inactive = 0x1
class fullscreen_method(enum.IntEnum):
default = 0
scale = 1
driver = 2
fill = 3
class WlShellSurfaceProxy(Proxy[WlShellSurface]):
interface = WlShellSurface
@WlShellSurface.request(
Argument(ArgumentType.Uint),
)
def pong(self, serial: int) -> None:
"""Respond to a ping event
A client must respond to a ping event with a pong request or the client
may be deemed unresponsive.
:param serial:
serial number of the ping event
:type serial:
`ArgumentType.Uint`
"""
self._marshal(0, serial)
@WlShellSurface.request(
Argument(ArgumentType.Object, interface=WlSeat),
Argument(ArgumentType.Uint),
)
def move(self, seat: WlSeat, serial: int) -> None:
"""Start an interactive move
Start a pointer-driven move of the surface.
This request must be used in response to a button press event. The
server may ignore move requests depending on the state of the surface
(e.g. fullscreen or maximized).
:param seat:
seat whose pointer is used
:type seat:
:class:`~pywayland.protocol.wayland.WlSeat`
:param serial:
serial number of the implicit grab on the pointer
:type serial:
`ArgumentType.Uint`
"""
self._marshal(1, seat, serial)
@WlShellSurface.request(
Argument(ArgumentType.Object, interface=WlSeat),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
)
def resize(self, seat: WlSeat, serial: int, edges: int) -> None:
"""Start an interactive resize
Start a pointer-driven resizing of the surface.
This request must be used in response to a button press event. The
server may ignore resize requests depending on the state of the surface
(e.g. fullscreen or maximized).
:param seat:
seat whose pointer is used
:type seat:
:class:`~pywayland.protocol.wayland.WlSeat`
:param serial:
serial number of the implicit grab on the pointer
:type serial:
`ArgumentType.Uint`
:param edges:
which edge or corner is being dragged
:type edges:
`ArgumentType.Uint`
"""
self._marshal(2, seat, serial, edges)
@WlShellSurface.request()
def set_toplevel(self) -> None:
"""Make the surface a toplevel surface
Map the surface as a toplevel surface.
A toplevel surface is not fullscreen, maximized or transient.
"""
self._marshal(3)
@WlShellSurface.request(
Argument(ArgumentType.Object, interface=WlSurface),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Uint),
)
def set_transient(self, parent: WlSurface, x: int, y: int, flags: int) -> None:
"""Make the surface a transient surface
Map the surface relative to an existing surface.
The x and y arguments specify the location of the upper left corner of
the surface relative to the upper left corner of the parent surface, in
surface-local coordinates.
The flags argument controls details of the transient behaviour.
:param parent:
parent surface
:type parent:
:class:`~pywayland.protocol.wayland.WlSurface`
:param x:
surface-local x coordinate
:type x:
`ArgumentType.Int`
:param y:
surface-local y coordinate
:type y:
`ArgumentType.Int`
:param flags:
transient surface behavior
:type flags:
`ArgumentType.Uint`
"""
self._marshal(4, parent, x, y, flags)
@WlShellSurface.request(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Object, interface=WlOutput, nullable=True),
)
def set_fullscreen(self, method: int, framerate: int, output: WlOutput | None) -> None:
"""Make the surface a fullscreen surface
Map the surface as a fullscreen surface.
If an output parameter is given then the surface will be made
fullscreen on that output. If the client does not specify the output
then the compositor will apply its policy - usually choosing the output
on which the surface has the biggest surface area.
The client may specify a method to resolve a size conflict between the
output size and the surface size - this is provided through the method
parameter.
The framerate parameter is used only when the method is set to
"driver", to indicate the preferred framerate. A value of 0 indicates
that the client does not care about framerate. The framerate is
specified in mHz, that is framerate of 60000 is 60Hz.
A method of "scale" or "driver" implies a scaling operation of the
surface, either via a direct scaling operation or a change of the
output mode. This will override any kind of output scaling, so that
mapping a surface with a buffer size equal to the mode can fill the
screen independent of buffer_scale.
A method of "fill" means we don't scale up the buffer, however any
output scale is applied. This means that you may run into an edge case
where the application maps a buffer with the same size of the output
mode but buffer_scale 1 (thus making a surface larger than the output).
In this case it is allowed to downscale the results to fit the screen.
The compositor must reply to this request with a configure event with
the dimensions for the output on which the surface will be made
fullscreen.
:param method:
method for resolving size conflict
:type method:
`ArgumentType.Uint`
:param framerate:
framerate in mHz
:type framerate:
`ArgumentType.Uint`
:param output:
output on which the surface is to be fullscreen
:type output:
:class:`~pywayland.protocol.wayland.WlOutput` or `None`
"""
self._marshal(5, method, framerate, output)
@WlShellSurface.request(
Argument(ArgumentType.Object, interface=WlSeat),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Object, interface=WlSurface),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Uint),
)
def set_popup(self, seat: WlSeat, serial: int, parent: WlSurface, x: int, y: int, flags: int) -> None:
"""Make the surface a popup surface
Map the surface as a popup.
A popup surface is a transient surface with an added pointer grab.
An existing implicit grab will be changed to owner-events mode, and the
popup grab will continue after the implicit grab ends (i.e. releasing
the mouse button does not cause the popup to be unmapped).
The popup grab continues until the window is destroyed or a mouse
button is pressed in any other client's window. A click in any of the
client's surfaces is reported as normal, however, clicks in other
clients' surfaces will be discarded and trigger the callback.
The x and y arguments specify the location of the upper left corner of
the surface relative to the upper left corner of the parent surface, in
surface-local coordinates.
:param seat:
seat whose pointer is used
:type seat:
:class:`~pywayland.protocol.wayland.WlSeat`
:param serial:
serial number of the implicit grab on the pointer
:type serial:
`ArgumentType.Uint`
:param parent:
parent surface
:type parent:
:class:`~pywayland.protocol.wayland.WlSurface`
:param x:
surface-local x coordinate
:type x:
`ArgumentType.Int`
:param y:
surface-local y coordinate
:type y:
`ArgumentType.Int`
:param flags:
transient surface behavior
:type flags:
`ArgumentType.Uint`
"""
self._marshal(6, seat, serial, parent, x, y, flags)
@WlShellSurface.request(
Argument(ArgumentType.Object, interface=WlOutput, nullable=True),
)
def set_maximized(self, output: WlOutput | None) -> None:
"""Make the surface a maximized surface
Map the surface as a maximized surface.
If an output parameter is given then the surface will be maximized on
that output. If the client does not specify the output then the
compositor will apply its policy - usually choosing the output on which
the surface has the biggest surface area.
The compositor will reply with a configure event telling the expected
new surface size. The operation is completed on the next buffer attach
to this surface.
A maximized surface typically fills the entire output it is bound to,
except for desktop elements such as panels. This is the main difference
between a maximized shell surface and a fullscreen shell surface.
The details depend on the compositor implementation.
:param output:
output on which the surface is to be maximized
:type output:
:class:`~pywayland.protocol.wayland.WlOutput` or `None`
"""
self._marshal(7, output)
@WlShellSurface.request(
Argument(ArgumentType.String),
)
def set_title(self, title: str) -> None:
"""Set surface title
Set a short title for the surface.
This string may be used to identify the surface in a task bar, window
list, or other user interface elements provided by the compositor.
The string must be encoded in UTF-8.
:param title:
surface title
:type title:
`ArgumentType.String`
"""
self._marshal(8, title)
@WlShellSurface.request(
Argument(ArgumentType.String),
)
def set_class(self, class_: str) -> None:
"""Set surface class
Set a class for the surface.
The surface class identifies the general class of applications to which
the surface belongs. A common convention is to use the file name (or
the full path if it is a non-standard location) of the application's
.desktop file as the class.
:param class_:
surface class
:type class_:
`ArgumentType.String`
"""
self._marshal(9, class_)
class WlShellSurfaceResource(Resource):
interface = WlShellSurface
@WlShellSurface.event(
Argument(ArgumentType.Uint),
)
def ping(self, serial: int) -> None:
"""Ping client
Ping a client to check if it is receiving events and sending requests.
A client is expected to reply with a pong request.
:param serial:
serial number of the ping
:type serial:
`ArgumentType.Uint`
"""
self._post_event(0, serial)
@WlShellSurface.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def configure(self, edges: int, width: int, height: int) -> None:
"""Suggest resize
The configure event asks the client to resize its surface.
The size is a hint, in the sense that the client is free to ignore it
if it doesn't resize, pick a smaller size (to satisfy aspect ratio or
resize in steps of NxM pixels).
The edges parameter provides a hint about how the surface was resized.
The client may use this information to decide how to adjust its content
to the new size (e.g. a scrolling area might adjust its content
position to leave the viewable content unmoved).
The client is free to dismiss all but the last configure event it
received.
The width and height arguments specify the size of the window in
surface-local coordinates.
:param edges:
how the surface was resized
:type edges:
`ArgumentType.Uint`
:param width:
new width of the surface
:type width:
`ArgumentType.Int`
:param height:
new height of the surface
:type height:
`ArgumentType.Int`
"""
self._post_event(1, edges, width, height)
@WlShellSurface.event()
def popup_done(self) -> None:
"""Popup interaction is done
The popup_done event is sent out when a popup grab is broken, that is,
when the user clicks a surface that doesn't belong to the client owning
the popup surface.
"""
self._post_event(2)
class WlShellSurfaceGlobal(Global):
interface = WlShellSurface
WlShellSurface._gen_c()
WlShellSurface.proxy_class = WlShellSurfaceProxy
WlShellSurface.resource_class = WlShellSurfaceResource
WlShellSurface.global_class = WlShellSurfaceGlobal
@@ -1,292 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_shm_pool import WlShmPool
class WlShm(Interface):
"""Shared memory support
A singleton global object that provides support for shared memory.
Clients can create :class:`~pywayland.protocol.wayland.WlShmPool` objects
using the create_pool request.
On binding the :class:`WlShm` object one or more format events are emitted
to inform clients about the valid pixel formats that can be used for
buffers.
"""
name = "wl_shm"
version = 3
class error(enum.IntEnum):
invalid_format = 0
invalid_stride = 1
invalid_fd = 2
class format(enum.IntEnum):
argb8888 = 0
xrgb8888 = 1
c8 = 0x20203843
rgb332 = 0x38424752
bgr233 = 0x38524742
xrgb4444 = 0x32315258
xbgr4444 = 0x32314258
rgbx4444 = 0x32315852
bgrx4444 = 0x32315842
argb4444 = 0x32315241
abgr4444 = 0x32314241
rgba4444 = 0x32314152
bgra4444 = 0x32314142
xrgb1555 = 0x35315258
xbgr1555 = 0x35314258
rgbx5551 = 0x35315852
bgrx5551 = 0x35315842
argb1555 = 0x35315241
abgr1555 = 0x35314241
rgba5551 = 0x35314152
bgra5551 = 0x35314142
rgb565 = 0x36314752
bgr565 = 0x36314742
rgb888 = 0x34324752
bgr888 = 0x34324742
xbgr8888 = 0x34324258
rgbx8888 = 0x34325852
bgrx8888 = 0x34325842
abgr8888 = 0x34324241
rgba8888 = 0x34324152
bgra8888 = 0x34324142
xrgb2101010 = 0x30335258
xbgr2101010 = 0x30334258
rgbx1010102 = 0x30335852
bgrx1010102 = 0x30335842
argb2101010 = 0x30335241
abgr2101010 = 0x30334241
rgba1010102 = 0x30334152
bgra1010102 = 0x30334142
yuyv = 0x56595559
yvyu = 0x55595659
uyvy = 0x59565955
vyuy = 0x59555956
ayuv = 0x56555941
nv12 = 0x3231564E
nv21 = 0x3132564E
nv16 = 0x3631564E
nv61 = 0x3136564E
yuv410 = 0x39565559
yvu410 = 0x39555659
yuv411 = 0x31315559
yvu411 = 0x31315659
yuv420 = 0x32315559
yvu420 = 0x32315659
yuv422 = 0x36315559
yvu422 = 0x36315659
yuv444 = 0x34325559
yvu444 = 0x34325659
r8 = 0x20203852
r16 = 0x20363152
rg88 = 0x38384752
gr88 = 0x38385247
rg1616 = 0x32334752
gr1616 = 0x32335247
xrgb16161616f = 0x48345258
xbgr16161616f = 0x48344258
argb16161616f = 0x48345241
abgr16161616f = 0x48344241
xyuv8888 = 0x56555958
vuy888 = 0x34325556
vuy101010 = 0x30335556
y210 = 0x30313259
y212 = 0x32313259
y216 = 0x36313259
y410 = 0x30313459
y412 = 0x32313459
y416 = 0x36313459
xvyu2101010 = 0x30335658
xvyu12_16161616 = 0x36335658
xvyu16161616 = 0x38345658
y0l0 = 0x304C3059
x0l0 = 0x304C3058
y0l2 = 0x324C3059
x0l2 = 0x324C3058
yuv420_8bit = 0x38305559
yuv420_10bit = 0x30315559
xrgb8888_a8 = 0x38415258
xbgr8888_a8 = 0x38414258
rgbx8888_a8 = 0x38415852
bgrx8888_a8 = 0x38415842
rgb888_a8 = 0x38413852
bgr888_a8 = 0x38413842
rgb565_a8 = 0x38413552
bgr565_a8 = 0x38413542
nv24 = 0x3432564E
nv42 = 0x3234564E
p210 = 0x30313250
p010 = 0x30313050
p012 = 0x32313050
p016 = 0x36313050
axbxgxrx106106106106 = 0x30314241
nv15 = 0x3531564E
q410 = 0x30313451
q401 = 0x31303451
xrgb16161616 = 0x38345258
xbgr16161616 = 0x38344258
argb16161616 = 0x38345241
abgr16161616 = 0x38344241
c1 = 0x20203143
c2 = 0x20203243
c4 = 0x20203443
d1 = 0x20203144
d2 = 0x20203244
d4 = 0x20203444
d8 = 0x20203844
r1 = 0x20203152
r2 = 0x20203252
r4 = 0x20203452
r10 = 0x20303152
r12 = 0x20323152
avuy8888 = 0x59555641
xvuy8888 = 0x59555658
p030 = 0x30333050
rgb161616 = 0x38344752
bgr161616 = 0x38344742
r16f = 0x48202052
gr1616f = 0x48205247
bgr161616f = 0x48524742
r32f = 0x46202052
gr3232f = 0x46205247
bgr323232f = 0x46524742
abgr32323232f = 0x46384241
nv20 = 0x3032564E
nv30 = 0x3033564E
s010 = 0x30313053
s210 = 0x30313253
s410 = 0x30313453
s012 = 0x32313053
s212 = 0x32313253
s412 = 0x32313453
s016 = 0x36313053
s216 = 0x36313253
s416 = 0x36313453
xvuy2101010 = 0x30335958
p230 = 0x30333250
t430 = 0x30333454
y8 = 0x59455247
xyyy2101010 = 0x34415059
class WlShmProxy(Proxy[WlShm]):
interface = WlShm
@WlShm.request(
Argument(ArgumentType.NewId, interface=WlShmPool),
Argument(ArgumentType.FileDescriptor),
Argument(ArgumentType.Int),
)
def create_pool(self, fd: int, size: int) -> Proxy[WlShmPool]:
"""Create a shm pool
Create a new :class:`~pywayland.protocol.wayland.WlShmPool` object.
The pool can be used to create shared memory based buffer objects. The
server will mmap size bytes of the passed file descriptor, to use as
backing memory for the pool.
:param fd:
file descriptor for the pool
:type fd:
`ArgumentType.FileDescriptor`
:param size:
pool size, in bytes
:type size:
`ArgumentType.Int`
:returns:
:class:`~pywayland.protocol.wayland.WlShmPool` -- pool to create
"""
id = self._marshal_constructor(0, WlShmPool, fd, size)
return id
@WlShm.request(version=2)
def release(self) -> None:
"""Release the shm object
Using this request a client can tell the server that it is not going to
use the shm object anymore.
Objects created via this interface remain unaffected.
"""
self._marshal(1)
self._destroy()
class WlShmResource(Resource):
interface = WlShm
@WlShm.event(
Argument(ArgumentType.Uint),
)
def format(self, format: int) -> None:
"""Pixel format description
Informs the client about a valid pixel format that can be used for
buffers. Known formats include argb8888 and xrgb8888.
Extensions to drm_fourcc.h (or the format enum) do not require
increasing the :class:`WlShm` version; as a result, clients may receive
format codes which were not in the list at the time the client was
made.
:param format:
buffer pixel format
:type format:
`ArgumentType.Uint`
"""
self._post_event(0, format)
class WlShmGlobal(Global):
interface = WlShm
WlShm._gen_c()
WlShm.proxy_class = WlShmProxy
WlShm.resource_class = WlShmResource
WlShm.global_class = WlShmGlobal
@@ -1,165 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_buffer import WlBuffer
class WlShmPool(Interface):
"""A shared memory pool
The :class:`WlShmPool` object encapsulates a piece of memory shared between
the compositor and client. Through the :class:`WlShmPool` object, the
client can allocate shared memory
:class:`~pywayland.protocol.wayland.WlBuffer` objects. All objects created
through the same pool share the same underlying mapped memory. Reusing the
mapped memory avoids the setup/teardown overhead and is useful when
interactively resizing a surface or for many small buffers.
"""
name = "wl_shm_pool"
version = 3
class error(enum.IntEnum):
invalid_format = 0
invalid_stride = 1
class WlShmPoolProxy(Proxy[WlShmPool]):
interface = WlShmPool
@WlShmPool.request(
Argument(ArgumentType.NewId, interface=WlBuffer),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Uint),
)
def create_buffer(self, offset: int, width: int, height: int, stride: int, format: int) -> Proxy[WlBuffer]:
"""Create a buffer from the pool
Create a :class:`~pywayland.protocol.wayland.WlBuffer` object from the
pool.
The buffer is created offset bytes into the pool and has width and
height as specified. The stride argument specifies the number of bytes
from the beginning of one row to the beginning of the next. The format
is the pixel format of the buffer and must be one of those advertised
through the :func:`WlShm.format()
<pywayland.protocol.wayland.WlShm.format>` event.
A buffer will keep a reference to the pool it was created from so it is
valid to destroy the pool immediately after creating a buffer from it.
:param offset:
buffer byte offset within the pool
:type offset:
`ArgumentType.Int`
:param width:
buffer width, in pixels
:type width:
`ArgumentType.Int`
:param height:
buffer height, in pixels
:type height:
`ArgumentType.Int`
:param stride:
number of bytes from the beginning of one row to the beginning of
the next row
:type stride:
`ArgumentType.Int`
:param format:
buffer pixel format
:type format:
`ArgumentType.Uint`
:returns:
:class:`~pywayland.protocol.wayland.WlBuffer` -- buffer to create
"""
id = self._marshal_constructor(0, WlBuffer, offset, width, height, stride, format)
return id
@WlShmPool.request()
def destroy(self) -> None:
"""Destroy the pool
Destroy the shared memory pool.
The mmapped memory will be released when all buffers that have been
created from this pool are gone.
"""
self._marshal(1)
self._destroy()
@WlShmPool.request(
Argument(ArgumentType.Int),
)
def resize(self, size: int) -> None:
"""Change the size of the pool mapping
This request will cause the server to remap the backing memory for the
pool from the file descriptor passed when the pool was created, but
using the new size. This request can only be used to make the pool
bigger.
This request only changes the amount of bytes that are mmapped by the
server and does not touch the file corresponding to the file descriptor
passed at creation time. It is the client's responsibility to ensure
that the file is at least as big as the new pool size.
:param size:
new size of the pool, in bytes
:type size:
`ArgumentType.Int`
"""
self._marshal(2, size)
class WlShmPoolResource(Resource):
interface = WlShmPool
class WlShmPoolGlobal(Global):
interface = WlShmPool
WlShmPool._gen_c()
WlShmPool.proxy_class = WlShmPoolProxy
WlShmPool.resource_class = WlShmPoolResource
WlShmPool.global_class = WlShmPoolGlobal
@@ -1,150 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_subsurface import WlSubsurface
from .wl_surface import WlSurface
class WlSubcompositor(Interface):
"""Sub-surface compositing
The global interface exposing sub-surface compositing capabilities. A
:class:`~pywayland.protocol.wayland.WlSurface`, that has sub-surfaces
associated, is called the parent surface. Sub-surfaces can be arbitrarily
nested and create a tree of sub-surfaces.
The root surface in a tree of sub-surfaces is the main surface. The main
surface cannot be a sub-surface, because sub-surfaces must always have a
parent.
A main surface with its sub-surfaces forms a (compound) window. For window
management purposes, this set of
:class:`~pywayland.protocol.wayland.WlSurface` objects is to be considered
as a single window, and it should also behave as such.
The aim of sub-surfaces is to offload some of the compositing work within a
window from clients to the compositor. A prime example is a video player
with decorations and video in separate
:class:`~pywayland.protocol.wayland.WlSurface` objects. This should allow
the compositor to pass YUV video buffer processing to dedicated overlay
hardware when possible.
"""
name = "wl_subcompositor"
version = 1
class error(enum.IntEnum):
bad_surface = 0
bad_parent = 1
class WlSubcompositorProxy(Proxy[WlSubcompositor]):
interface = WlSubcompositor
@WlSubcompositor.request()
def destroy(self) -> None:
"""Unbind from the subcompositor interface
Informs the server that the client will not be using this protocol
object anymore. This does not affect any other objects,
:class:`~pywayland.protocol.wayland.WlSubsurface` objects included.
"""
self._marshal(0)
self._destroy()
@WlSubcompositor.request(
Argument(ArgumentType.NewId, interface=WlSubsurface),
Argument(ArgumentType.Object, interface=WlSurface),
Argument(ArgumentType.Object, interface=WlSurface),
)
def get_subsurface(self, surface: WlSurface, parent: WlSurface) -> Proxy[WlSubsurface]:
"""Give a surface the role sub-surface
Create a sub-surface interface for the given surface, and associate it
with the given parent surface. This turns a plain
:class:`~pywayland.protocol.wayland.WlSurface` into a sub-surface.
The to-be sub-surface must not already have another role, and it must
not have an existing :class:`~pywayland.protocol.wayland.WlSubsurface`
object. Otherwise the bad_surface protocol error is raised.
Adding sub-surfaces to a parent is a double-buffered operation on the
parent (see :func:`WlSurface.commit()
<pywayland.protocol.wayland.WlSurface.commit>`). The effect of adding a
sub-surface becomes visible on the next time the state of the parent
surface is applied.
The parent surface must not be one of the child surface's descendants,
and the parent must be different from the child surface, otherwise the
bad_parent protocol error is raised.
This request modifies the behaviour of :func:`WlSurface.commit()
<pywayland.protocol.wayland.WlSurface.commit>` request on the sub-
surface, see the documentation on
:class:`~pywayland.protocol.wayland.WlSubsurface` interface.
:param surface:
the surface to be turned into a sub-surface
:type surface:
:class:`~pywayland.protocol.wayland.WlSurface`
:param parent:
the parent surface
:type parent:
:class:`~pywayland.protocol.wayland.WlSurface`
:returns:
:class:`~pywayland.protocol.wayland.WlSubsurface` -- the new sub-
surface object ID
"""
id = self._marshal_constructor(1, WlSubsurface, surface, parent)
return id
class WlSubcompositorResource(Resource):
interface = WlSubcompositor
class WlSubcompositorGlobal(Global):
interface = WlSubcompositor
WlSubcompositor._gen_c()
WlSubcompositor.proxy_class = WlSubcompositorProxy
WlSubcompositor.resource_class = WlSubcompositorResource
WlSubcompositor.global_class = WlSubcompositorGlobal
@@ -1,232 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_surface import WlSurface
class WlSubsurface(Interface):
"""Sub-surface interface to a :class:`~pywayland.protocol.wayland.WlSurface`
An additional interface to a :class:`~pywayland.protocol.wayland.WlSurface`
object, which has been made a sub-surface. A sub-surface has one parent
surface. A sub-surface's size and position are not limited to that of the
parent. Particularly, a sub-surface is not automatically clipped to its
parent's area.
A sub-surface becomes mapped, when a non-NULL
:class:`~pywayland.protocol.wayland.WlBuffer` is applied and the parent
surface is mapped. The order of which one happens first is irrelevant. A
sub-surface is hidden if the parent becomes hidden, or if a NULL
:class:`~pywayland.protocol.wayland.WlBuffer` is applied. These rules apply
recursively through the tree of surfaces.
A sub-surface can be in one of two modes. The possible modes are
synchronized and desynchronized, see methods
:func:`WlSubsurface.set_sync()` and :func:`WlSubsurface.set_desync()`.
The main surface can be thought to be always in desynchronized mode, since
it does not have a parent in the sub-surfaces sense.
Even if a sub-surface is in desynchronized mode, it will behave as in
synchronized mode, if its parent surface behaves as in synchronized mode.
This rule is applied recursively throughout the tree of surfaces. This
means, that one can set a sub-surface into synchronized mode, and then
assume that all its child and grand-child sub-surfaces are synchronized,
too, without explicitly setting them.
If a surface behaves as in synchronized mode, it is effectively
synchronized, otherwise it is effectively desynchronized.
A sub-surface is initially in the synchronized mode.
The :class:`WlSubsurface` interface has requests which modify double-
buffered state of the parent surface (:func:`WlSubsurface.set_position()`,
.place_above and .place_below).
Destroying a sub-surface takes effect immediately. If you need to
synchronize the removal of a sub-surface to the parent surface update,
unmap the sub-surface first by attaching a NULL
:class:`~pywayland.protocol.wayland.WlBuffer`, update parent, and then
destroy the sub-surface.
If the parent :class:`~pywayland.protocol.wayland.WlSurface` object is
destroyed, the sub-surface is unmapped.
A sub-surface never has the keyboard focus of any seat.
The :func:`WlSurface.offset()
<pywayland.protocol.wayland.WlSurface.offset>` request is ignored: clients
must use set_position instead to move the sub-surface.
"""
name = "wl_subsurface"
version = 1
class error(enum.IntEnum):
bad_surface = 0
class WlSubsurfaceProxy(Proxy[WlSubsurface]):
interface = WlSubsurface
@WlSubsurface.request()
def destroy(self) -> None:
"""Remove sub-surface interface
The sub-surface interface is removed from the
:class:`~pywayland.protocol.wayland.WlSurface` object that was turned
into a sub-surface with a :func:`WlSubcompositor.get_subsurface()
<pywayland.protocol.wayland.WlSubcompositor.get_subsurface>` request.
The wl_surface's association to the parent is deleted. The
:class:`~pywayland.protocol.wayland.WlSurface` is unmapped immediately.
"""
self._marshal(0)
self._destroy()
@WlSubsurface.request(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def set_position(self, x: int, y: int) -> None:
"""Reposition the sub-surface
This sets the position of the sub-surface, relative to the parent
surface.
The sub-surface will be moved so that its origin (top left corner
pixel) will be at the location x, y of the parent surface coordinate
system. The coordinates are not restricted to the parent surface area.
Negative values are allowed.
The initial position is 0, 0.
Position is double-buffered state on the parent surface, see
:class:`WlSubsurface` and :func:`WlSurface.commit()
<pywayland.protocol.wayland.WlSurface.commit>` for more information.
:param x:
x coordinate in the parent surface
:type x:
`ArgumentType.Int`
:param y:
y coordinate in the parent surface
:type y:
`ArgumentType.Int`
"""
self._marshal(1, x, y)
@WlSubsurface.request(
Argument(ArgumentType.Object, interface=WlSurface),
)
def place_above(self, sibling: WlSurface) -> None:
"""Restack the sub-surface
This sub-surface is taken from the stack, and put back just above the
reference surface, changing the z-order of the sub-surfaces. The
reference surface must be one of the sibling surfaces, or the parent
surface. Using any other surface, including this sub-surface, will
cause a protocol error.
A new sub-surface is initially added as the top-most in the stack of
its siblings and parent.
Z-order is double-buffered state on the parent surface, see
:class:`WlSubsurface` and :func:`WlSurface.commit()
<pywayland.protocol.wayland.WlSurface.commit>` for more information.
:param sibling:
the reference surface
:type sibling:
:class:`~pywayland.protocol.wayland.WlSurface`
"""
self._marshal(2, sibling)
@WlSubsurface.request(
Argument(ArgumentType.Object, interface=WlSurface),
)
def place_below(self, sibling: WlSurface) -> None:
"""Restack the sub-surface
The sub-surface is placed just below the reference surface.
See :func:`WlSubsurface.place_above()`.
:param sibling:
the reference surface
:type sibling:
:class:`~pywayland.protocol.wayland.WlSurface`
"""
self._marshal(3, sibling)
@WlSubsurface.request()
def set_sync(self) -> None:
"""Set sub-surface to synchronized mode
Change the commit behaviour of the sub-surface to synchronized mode.
See :class:`WlSubsurface` and :func:`WlSurface.commit()
<pywayland.protocol.wayland.WlSurface.commit>` for more information.
"""
self._marshal(4)
@WlSubsurface.request()
def set_desync(self) -> None:
"""Set sub-surface to desynchronized mode
Change the commit behaviour of the sub-surface to desynchronized mode.
See :class:`WlSubsurface` and :func:`WlSurface.commit()
<pywayland.protocol.wayland.WlSurface.commit>` for more information.
"""
self._marshal(5)
class WlSubsurfaceResource(Resource):
interface = WlSubsurface
class WlSubsurfaceGlobal(Global):
interface = WlSubsurface
WlSubsurface._gen_c()
WlSubsurface.proxy_class = WlSubsurfaceProxy
WlSubsurface.resource_class = WlSubsurfaceResource
WlSubsurface.global_class = WlSubsurfaceGlobal
@@ -1,792 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_buffer import WlBuffer
from .wl_callback import WlCallback
from .wl_output import WlOutput
from .wl_region import WlRegion
class WlSurface(Interface):
"""An onscreen surface
A surface is a rectangular area that may be displayed on zero or more
outputs, and shown any number of times at the compositor's discretion. They
can present wl_buffers, receive user input, and define a local coordinate
system.
The size of a surface (and relative positions on it) is described in
surface-local coordinates, which may differ from the buffer coordinates of
the pixel content, in case a buffer_transform or a buffer_scale is used.
A surface without a "role" is fairly useless: a compositor does not know
where, when or how to present it. The role is the purpose of a
:class:`WlSurface`. Examples of roles are a cursor for a pointer (as set by
:func:`WlPointer.set_cursor()
<pywayland.protocol.wayland.WlPointer.set_cursor>`), a drag icon
(:func:`WlDataDevice.start_drag()
<pywayland.protocol.wayland.WlDataDevice.start_drag>`), a sub-surface
(:func:`WlSubcompositor.get_subsurface()
<pywayland.protocol.wayland.WlSubcompositor.get_subsurface>`), and a window
as defined by a shell protocol (e.g. :func:`WlShell.get_shell_surface()
<pywayland.protocol.wayland.WlShell.get_shell_surface>`).
A surface can have only one role at a time. Initially a :class:`WlSurface`
does not have a role. Once a :class:`WlSurface` is given a role, it is set
permanently for the whole lifetime of the :class:`WlSurface` object. Giving
the current role again is allowed, unless explicitly forbidden by the
relevant interface specification.
Surface roles are given by requests in other interfaces such as
:func:`WlPointer.set_cursor()
<pywayland.protocol.wayland.WlPointer.set_cursor>`. The request should
explicitly mention that this request gives a role to a :class:`WlSurface`.
Often, this request also creates a new protocol object that represents the
role and adds additional functionality to :class:`WlSurface`. When a client
wants to destroy a :class:`WlSurface`, they must destroy this role object
before the :class:`WlSurface`, otherwise a defunct_role_object error is
sent.
Destroying the role object does not remove the role from the
:class:`WlSurface`, but it may stop the :class:`WlSurface` from "playing
the role". For instance, if a
:class:`~pywayland.protocol.wayland.WlSubsurface` object is destroyed, the
:class:`WlSurface` it was created for will be unmapped and forget its
position and z-order. It is allowed to create a
:class:`~pywayland.protocol.wayland.WlSubsurface` for the same
:class:`WlSurface` again, but it is not allowed to use the
:class:`WlSurface` as a cursor (cursor is a different role than sub-
surface, and role switching is not allowed).
"""
name = "wl_surface"
version = 7
class error(enum.IntEnum):
invalid_scale = 0
invalid_transform = 1
invalid_size = 2
invalid_offset = 3
defunct_role_object = 4
no_buffer = 5
class WlSurfaceProxy(Proxy[WlSurface]):
interface = WlSurface
@WlSurface.request()
def destroy(self) -> None:
"""Delete surface
Deletes the surface and invalidates its object ID.
"""
self._marshal(0)
self._destroy()
@WlSurface.request(
Argument(ArgumentType.Object, interface=WlBuffer, nullable=True),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def attach(self, buffer: WlBuffer | None, x: int, y: int) -> None:
"""Set the surface contents
Set a buffer as the content of this surface.
The new size of the surface is calculated based on the buffer size
transformed by the inverse buffer_transform and the inverse
buffer_scale. This means that at commit time the supplied buffer size
must be an integer multiple of the buffer_scale. If that's not the
case, an invalid_size error is sent.
The x and y arguments specify the location of the new pending buffer's
upper left corner, relative to the current buffer's upper left corner,
in surface-local coordinates. In other words, the x and y, combined
with the new surface size define in which directions the surface's size
changes. Setting anything other than 0 as x and y arguments is
discouraged, and should instead be replaced with using the separate
:func:`WlSurface.offset()` request.
When the bound :class:`WlSurface` version is 5 or higher, passing any
non-zero x or y is a protocol violation, and will result in an
'invalid_offset' error being raised. The x and y arguments are ignored
and do not change the pending state. To achieve equivalent semantics,
use :func:`WlSurface.offset()`.
Surface contents are double-buffered state, see
:func:`WlSurface.commit()`.
The initial surface contents are void; there is no content.
:func:`WlSurface.attach()` assigns the given
:class:`~pywayland.protocol.wayland.WlBuffer` as the pending
:class:`~pywayland.protocol.wayland.WlBuffer`.
:func:`WlSurface.commit()` makes the pending
:class:`~pywayland.protocol.wayland.WlBuffer` the new surface contents,
and the size of the surface becomes the size calculated from the
:class:`~pywayland.protocol.wayland.WlBuffer`, as described above.
After commit, there is no pending buffer until the next attach.
Committing a pending :class:`~pywayland.protocol.wayland.WlBuffer`
allows the compositor to read the pixels in the
:class:`~pywayland.protocol.wayland.WlBuffer`. The compositor may
access the pixels at any time after the :func:`WlSurface.commit()`
request. When the compositor will not access the pixels anymore, it
will send the :func:`WlBuffer.release()
<pywayland.protocol.wayland.WlBuffer.release>` event. Only after
receiving :func:`WlBuffer.release()
<pywayland.protocol.wayland.WlBuffer.release>`, the client may reuse
the :class:`~pywayland.protocol.wayland.WlBuffer`. A
:class:`~pywayland.protocol.wayland.WlBuffer` that has been attached
and then replaced by another attach instead of committed will not
receive a release event, and is not used by the compositor.
If a pending :class:`~pywayland.protocol.wayland.WlBuffer` has been
committed to more than one :class:`WlSurface`, the delivery of
:func:`WlBuffer.release()
<pywayland.protocol.wayland.WlBuffer.release>` events becomes
undefined. A well behaved client should not rely on
:func:`WlBuffer.release()
<pywayland.protocol.wayland.WlBuffer.release>` events in this case.
Instead, clients hitting this case should use
:func:`WlSurface.get_release()` or use a protocol extension providing
per-commit release notifications (if none of these options are
available, a fallback can be implemented by creating multiple
:class:`~pywayland.protocol.wayland.WlBuffer` objects from the same
backing storage).
Destroying the :class:`~pywayland.protocol.wayland.WlBuffer` after
:func:`WlBuffer.release()
<pywayland.protocol.wayland.WlBuffer.release>` does not change the
surface contents. Destroying the
:class:`~pywayland.protocol.wayland.WlBuffer` before
:func:`WlBuffer.release()
<pywayland.protocol.wayland.WlBuffer.release>` is allowed as long as
the underlying buffer storage isn't re-used (this can happen e.g. on
client process termination). However, if the client destroys the
:class:`~pywayland.protocol.wayland.WlBuffer` before receiving the
:func:`WlBuffer.release()
<pywayland.protocol.wayland.WlBuffer.release>` event and mutates the
underlying buffer storage, the surface contents become undefined
immediately.
If :func:`WlSurface.attach()` is sent with a NULL
:class:`~pywayland.protocol.wayland.WlBuffer`, the following
:func:`WlSurface.commit()` will remove the surface content.
If a pending :class:`~pywayland.protocol.wayland.WlBuffer` has been
destroyed, the result is not specified. Many compositors are known to
remove the surface content on the following :func:`WlSurface.commit()`,
but this behaviour is not universal. Clients seeking to maximise
compatibility should not destroy pending buffers and should ensure that
they explicitly remove content from surfaces, even after destroying
buffers.
:param buffer:
buffer of surface contents
:type buffer:
:class:`~pywayland.protocol.wayland.WlBuffer` or `None`
:param x:
surface-local x coordinate
:type x:
`ArgumentType.Int`
:param y:
surface-local y coordinate
:type y:
`ArgumentType.Int`
"""
self._marshal(1, buffer, x, y)
@WlSurface.request(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def damage(self, x: int, y: int, width: int, height: int) -> None:
"""Mark part of the surface damaged
This request is used to describe the regions where the pending buffer
is different from the current surface contents, and where the surface
therefore needs to be repainted. The compositor ignores the parts of
the damage that fall outside of the surface.
Damage is double-buffered state, see :func:`WlSurface.commit()`.
The damage rectangle is specified in surface-local coordinates, where x
and y specify the upper left corner of the damage rectangle.
The initial value for pending damage is empty: no damage.
:func:`WlSurface.damage()` adds pending damage: the new pending damage
is the union of old pending damage and the given rectangle.
:func:`WlSurface.commit()` assigns pending damage as the current
damage, and clears pending damage. The server will clear the current
damage as it repaints the surface.
Note! New clients should not use this request. Instead damage can be
posted with :func:`WlSurface.damage_buffer()` which uses buffer
coordinates instead of surface coordinates.
:param x:
surface-local x coordinate
:type x:
`ArgumentType.Int`
:param y:
surface-local y coordinate
:type y:
`ArgumentType.Int`
:param width:
width of damage rectangle
:type width:
`ArgumentType.Int`
:param height:
height of damage rectangle
:type height:
`ArgumentType.Int`
"""
self._marshal(2, x, y, width, height)
@WlSurface.request(
Argument(ArgumentType.NewId, interface=WlCallback),
)
def frame(self) -> Proxy[WlCallback]:
"""Request a frame throttling hint
Request a notification when it is a good time to start drawing a new
frame, by creating a frame callback. This is useful for throttling
redrawing operations, and driving animations.
When a client is animating on a :class:`WlSurface`, it can use the
'frame' request to get notified when it is a good time to draw and
commit the next frame of animation. If the client commits an update
earlier than that, it is likely that some updates will not make it to
the display, and the client is wasting resources by drawing too often.
The frame request will take effect on the next
:func:`WlSurface.commit()`. The notification will only be posted for
one frame unless requested again. For a :class:`WlSurface`, the
notifications are posted in the order the frame requests were
committed.
The server must send the notifications so that a client will not send
excessive updates, while still allowing the highest possible update
rate for clients that wait for the reply before drawing again. The
server should give some time for the client to draw and commit after
sending the frame callback events to let it hit the next output
refresh.
A server should avoid signaling the frame callbacks if the surface is
not visible in any way, e.g. the surface is off-screen, or completely
obscured by other opaque surfaces.
The object returned by this request will be destroyed by the compositor
after the callback is fired and as such the client must not attempt to
use it after that point.
The callback_data passed in the callback is the current time, in
milliseconds, with an undefined base.
:returns:
:class:`~pywayland.protocol.wayland.WlCallback` -- callback object
for the frame request
"""
callback = self._marshal_constructor(3, WlCallback)
return callback
@WlSurface.request(
Argument(ArgumentType.Object, interface=WlRegion, nullable=True),
)
def set_opaque_region(self, region: WlRegion | None) -> None:
"""Set opaque region
This request sets the region of the surface that contains opaque
content.
The opaque region is an optimization hint for the compositor that lets
it optimize the redrawing of content behind opaque regions. Setting an
opaque region is not required for correct behaviour, but marking
transparent content as opaque will result in repaint artifacts.
The opaque region is specified in surface-local coordinates.
The compositor ignores the parts of the opaque region that fall outside
of the surface.
Opaque region is double-buffered state, see :func:`WlSurface.commit()`.
:func:`WlSurface.set_opaque_region()` changes the pending opaque
region. :func:`WlSurface.commit()` copies the pending region to the
current region. Otherwise, the pending and current regions are never
changed.
The initial value for an opaque region is empty. Setting the pending
opaque region has copy semantics, and the
:class:`~pywayland.protocol.wayland.WlRegion` object can be destroyed
immediately. A NULL :class:`~pywayland.protocol.wayland.WlRegion`
causes the pending opaque region to be set to empty.
:param region:
opaque region of the surface
:type region:
:class:`~pywayland.protocol.wayland.WlRegion` or `None`
"""
self._marshal(4, region)
@WlSurface.request(
Argument(ArgumentType.Object, interface=WlRegion, nullable=True),
)
def set_input_region(self, region: WlRegion | None) -> None:
"""Set input region
This request sets the region of the surface that can receive pointer
and touch events.
Input events happening outside of this region will try the next surface
in the server surface stack. The compositor ignores the parts of the
input region that fall outside of the surface.
The input region is specified in surface-local coordinates.
Input region is double-buffered state, see :func:`WlSurface.commit()`.
:func:`WlSurface.set_input_region()` changes the pending input region.
:func:`WlSurface.commit()` copies the pending region to the current
region. Otherwise the pending and current regions are never changed,
except cursor and icon surfaces are special cases, see
:func:`WlPointer.set_cursor()
<pywayland.protocol.wayland.WlPointer.set_cursor>` and
:func:`WlDataDevice.start_drag()
<pywayland.protocol.wayland.WlDataDevice.start_drag>`.
The initial value for an input region is infinite. That means the whole
surface will accept input. Setting the pending input region has copy
semantics, and the :class:`~pywayland.protocol.wayland.WlRegion` object
can be destroyed immediately. A NULL
:class:`~pywayland.protocol.wayland.WlRegion` causes the input region
to be set to infinite.
:param region:
input region of the surface
:type region:
:class:`~pywayland.protocol.wayland.WlRegion` or `None`
"""
self._marshal(5, region)
@WlSurface.request()
def commit(self) -> None:
"""Commit pending surface state
Surface state (input, opaque, and damage regions, attached buffers,
etc.) is double-buffered. Protocol requests modify the pending state,
as opposed to the active state in use by the compositor.
All requests that need a commit to become effective are documented to
affect double-buffered state.
Other interfaces may add further double-buffered surface state.
A commit request atomically creates a Content Update (CU) from the
pending state, even if the pending state has not been touched. The
content update is placed at the end of a per-surface queue until it
becomes active. After commit, the new pending state is as documented
for each related request.
A CU is either a Desync Content Update (DCU) or a Sync Content Update
(SCU). If the surface is effectively synchronized at the commit
request, it is a SCU, otherwise a DCU.
When a surface transitions from effectively synchronized to effectively
desynchronized, all SCUs in its queue which are not reachable by any
DCU become DCUs and dependency edges from outside the queue to these
CUs are removed.
See :class:`~pywayland.protocol.wayland.WlSubsurface` for the
definition of 'effectively synchronized' and 'effectively
desynchronized'.
When a CU is placed in the queue, the CU has a dependency on the CU in
front of it and to the SCU at end of the queue of every direct child
surface if that SCU exists and does not have another dependent. This
can form a directed acyclic graph of CUs with dependencies as edges.
In addition to surface state, the CU can have constraints that must be
satisfied before it can be applied. Other interfaces may add CU
constraints.
All DCUs which do not have a SCU in front of themselves in their queue,
are candidates. If the graph that's reachable by a candidate does not
have any unsatisfied constraints, the entire graph must be applied
atomically.
When a CU is applied, the :class:`~pywayland.protocol.wayland.WlBuffer`
is applied before all other state. This means that all coordinates in
double-buffered state are relative to the newly attached wl_buffers,
except for :func:`WlSurface.attach()` itself. If there is no newly
attached :class:`~pywayland.protocol.wayland.WlBuffer`, the coordinates
are relative to the previous content update.
"""
self._marshal(6)
@WlSurface.request(
Argument(ArgumentType.Int),
version=2,
)
def set_buffer_transform(self, transform: int) -> None:
"""Sets the buffer transformation
This request sets the transformation that the client has already
applied to the content of the buffer. The accepted values for the
transform parameter are the values for :func:`WlOutput.transform()
<pywayland.protocol.wayland.WlOutput.transform>`.
The compositor applies the inverse of this transformation whenever it
uses the buffer contents.
Buffer transform is double-buffered state, see
:func:`WlSurface.commit()`.
A newly created surface has its buffer transformation set to normal.
:func:`WlSurface.set_buffer_transform()` changes the pending buffer
transformation. :func:`WlSurface.commit()` copies the pending buffer
transformation to the current one. Otherwise, the pending and current
values are never changed.
The purpose of this request is to allow clients to render content
according to the output transform, thus permitting the compositor to
use certain optimizations even if the display is rotated. Using
hardware overlays and scanning out a client buffer for fullscreen
surfaces are examples of such optimizations. Those optimizations are
highly dependent on the compositor implementation, so the use of this
request should be considered on a case-by-case basis.
Note that if the transform value includes 90 or 270 degree rotation,
the width of the buffer will become the surface height and the height
of the buffer will become the surface width.
If transform is not one of the values from the
:func:`WlOutput.transform()
<pywayland.protocol.wayland.WlOutput.transform>` enum the
invalid_transform protocol error is raised.
:param transform:
transform for interpreting buffer contents
:type transform:
`ArgumentType.Int`
"""
self._marshal(7, transform)
@WlSurface.request(
Argument(ArgumentType.Int),
version=3,
)
def set_buffer_scale(self, scale: int) -> None:
"""Sets the buffer scaling factor
This request sets an optional scaling factor on how the compositor
interprets the contents of the buffer attached to the window.
Buffer scale is double-buffered state, see :func:`WlSurface.commit()`.
A newly created surface has its buffer scale set to 1.
:func:`WlSurface.set_buffer_scale()` changes the pending buffer scale.
:func:`WlSurface.commit()` copies the pending buffer scale to the
current one. Otherwise, the pending and current values are never
changed.
The purpose of this request is to allow clients to supply higher
resolution buffer data for use on high resolution outputs. It is
intended that you pick the same buffer scale as the scale of the output
that the surface is displayed on. This means the compositor can avoid
scaling when rendering the surface on that output.
Note that if the scale is larger than 1, then you have to attach a
buffer that is larger (by a factor of scale in each dimension) than the
desired surface size.
If scale is not greater than 0 the invalid_scale protocol error is
raised.
:param scale:
scale for interpreting buffer contents
:type scale:
`ArgumentType.Int`
"""
self._marshal(8, scale)
@WlSurface.request(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
version=4,
)
def damage_buffer(self, x: int, y: int, width: int, height: int) -> None:
"""Mark part of the surface damaged using buffer coordinates
This request is used to describe the regions where the pending buffer
is different from the current surface contents, and where the surface
therefore needs to be repainted. The compositor ignores the parts of
the damage that fall outside of the surface.
Damage is double-buffered state, see :func:`WlSurface.commit()`.
The damage rectangle is specified in buffer coordinates, where x and y
specify the upper left corner of the damage rectangle.
The initial value for pending damage is empty: no damage.
:func:`WlSurface.damage_buffer()` adds pending damage: the new pending
damage is the union of old pending damage and the given rectangle.
:func:`WlSurface.commit()` assigns pending damage as the current
damage, and clears pending damage. The server will clear the current
damage as it repaints the surface.
This request differs from :func:`WlSurface.damage()` in only one way -
it takes damage in buffer coordinates instead of surface-local
coordinates. While this generally is more intuitive than surface
coordinates, it is especially desirable when using wp_viewport or when
a drawing library (like EGL) is unaware of buffer scale and buffer
transform.
Note: Because buffer transformation changes and damage requests may be
interleaved in the protocol stream, it is impossible to determine the
actual mapping between surface and buffer damage until
:func:`WlSurface.commit()` time. Therefore, compositors wishing to take
both kinds of damage into account will have to accumulate damage from
the two requests separately and only transform from one to the other
after receiving the :func:`WlSurface.commit()`.
:param x:
buffer-local x coordinate
:type x:
`ArgumentType.Int`
:param y:
buffer-local y coordinate
:type y:
`ArgumentType.Int`
:param width:
width of damage rectangle
:type width:
`ArgumentType.Int`
:param height:
height of damage rectangle
:type height:
`ArgumentType.Int`
"""
self._marshal(9, x, y, width, height)
@WlSurface.request(
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
version=5,
)
def offset(self, x: int, y: int) -> None:
"""Set the surface contents offset
The x and y arguments specify the location of the new pending buffer's
upper left corner, relative to the current buffer's upper left corner,
in surface-local coordinates. In other words, the x and y, combined
with the new surface size define in which directions the surface's size
changes.
The exact semantics of :func:`WlSurface.offset()` are role-specific.
Refer to the documentation of specific roles for more information.
Surface location offset is double-buffered state, see
:func:`WlSurface.commit()`.
This request is semantically equivalent to and the replaces the x and y
arguments in the :func:`WlSurface.attach()` request in
:class:`WlSurface` versions prior to 5. See :func:`WlSurface.attach()`
for details.
:param x:
surface-local x coordinate
:type x:
`ArgumentType.Int`
:param y:
surface-local y coordinate
:type y:
`ArgumentType.Int`
"""
self._marshal(10, x, y)
@WlSurface.request(
Argument(ArgumentType.NewId, interface=WlCallback),
version=7,
)
def get_release(self) -> Proxy[WlCallback]:
"""Get a release callback
Create a callback for the release of the buffer attached by the client
with :func:`WlSurface.attach()`.
The compositor will release the buffer when it has finished its usage
of the underlying storage for the relevant commit. Once the client
receives this event, and assuming the associated buffer is not pending
release from other :func:`WlSurface.commit()` requests, the client can
safely re-use the buffer.
Release callbacks are double-buffered state, and will be associated
with the pending buffer at :func:`WlSurface.commit()` time.
The callback_data passed in the :func:`WlCallback.done()
<pywayland.protocol.wayland.WlCallback.done>` event is unused and is
always zero.
Sending this request without attaching a non-null buffer in the same
content update is a protocol error. The compositor will send the
no_buffer error in this case.
:returns:
:class:`~pywayland.protocol.wayland.WlCallback` -- callback object
for the release
"""
callback = self._marshal_constructor(11, WlCallback)
return callback
class WlSurfaceResource(Resource):
interface = WlSurface
@WlSurface.event(
Argument(ArgumentType.Object, interface=WlOutput),
)
def enter(self, output: WlOutput) -> None:
"""Surface enters an output
This is emitted whenever a surface's creation, movement, or resizing
results in some part of it being within the scanout region of an
output.
Note that a surface may be overlapping with zero or more outputs.
:param output:
output entered by the surface
:type output:
:class:`~pywayland.protocol.wayland.WlOutput`
"""
self._post_event(0, output)
@WlSurface.event(
Argument(ArgumentType.Object, interface=WlOutput),
)
def leave(self, output: WlOutput) -> None:
"""Surface leaves an output
This is emitted whenever a surface's creation, movement, or resizing
results in it no longer having any part of it within the scanout region
of an output.
Clients should not use the number of outputs the surface is on for
frame throttling purposes. The surface might be hidden even if no leave
event has been sent, and the compositor might expect new surface
content updates even if no enter event has been sent. The frame event
should be used instead.
:param output:
output left by the surface
:type output:
:class:`~pywayland.protocol.wayland.WlOutput`
"""
self._post_event(1, output)
@WlSurface.event(
Argument(ArgumentType.Int),
version=6,
)
def preferred_buffer_scale(self, factor: int) -> None:
"""Preferred buffer scale for the surface
This event indicates the preferred buffer scale for this surface. It is
sent whenever the compositor's preference changes.
Before receiving this event the preferred buffer scale for this surface
is 1.
It is intended that scaling aware clients use this event to scale their
content and use :func:`WlSurface.set_buffer_scale()` to indicate the
scale they have rendered with. This allows clients to supply a higher
detail buffer.
The compositor shall emit a scale value greater than 0.
:param factor:
preferred scaling factor
:type factor:
`ArgumentType.Int`
"""
self._post_event(2, factor)
@WlSurface.event(
Argument(ArgumentType.Uint),
version=6,
)
def preferred_buffer_transform(self, transform: int) -> None:
"""Preferred buffer transform for the surface
This event indicates the preferred buffer transform for this surface.
It is sent whenever the compositor's preference changes.
Before receiving this event the preferred buffer transform for this
surface is normal.
Applying this transformation to the surface buffer contents and using
:func:`WlSurface.set_buffer_transform()` might allow the compositor to
use the surface buffer more efficiently.
:param transform:
preferred transform
:type transform:
`ArgumentType.Uint`
"""
self._post_event(3, transform)
class WlSurfaceGlobal(Global):
interface = WlSurface
WlSurface._gen_c()
WlSurface.proxy_class = WlSurfaceProxy
WlSurface.resource_class = WlSurfaceResource
WlSurface.global_class = WlSurfaceGlobal
@@ -1,306 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2008-2011 Kristian Høgsberg
# Copyright © 2010-2011 Intel Corporation
# Copyright © 2012-2013 Collabora, Ltd.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation files
# (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge,
# publish, distribute, sublicense, and/or sell copies of the Software,
# and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice (including the
# next paragraph) shall be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from .wl_surface import WlSurface
class WlTouch(Interface):
"""Touchscreen input device
The :class:`WlTouch` interface represents a touchscreen associated with a
seat.
Touch interactions can consist of one or more contacts. For each contact, a
series of events is generated, starting with a down event, followed by zero
or more motion events, and ending with an up event. Events relating to the
same contact point can be identified by the ID of the sequence.
"""
name = "wl_touch"
version = 11
class WlTouchProxy(Proxy[WlTouch]):
interface = WlTouch
@WlTouch.request(version=3)
def release(self) -> None:
"""Release the touch object
"""
self._marshal(0)
self._destroy()
class WlTouchResource(Resource):
interface = WlTouch
@WlTouch.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Object, interface=WlSurface),
Argument(ArgumentType.Int),
Argument(ArgumentType.Fixed),
Argument(ArgumentType.Fixed),
)
def down(self, serial: int, time: int, surface: WlSurface, id: int, x: float, y: float) -> None:
"""Touch down event and beginning of a touch sequence
A new touch point has appeared on the surface. This touch point is
assigned a unique ID. Future events from this touch point reference
this ID. The ID ceases to be valid after a touch up event and may be
reused in the future.
:param serial:
serial number of the touch down event
:type serial:
`ArgumentType.Uint`
:param time:
timestamp with millisecond granularity
:type time:
`ArgumentType.Uint`
:param surface:
surface touched
:type surface:
:class:`~pywayland.protocol.wayland.WlSurface`
:param id:
the unique ID of this touch point
:type id:
`ArgumentType.Int`
:param x:
surface-local x coordinate
:type x:
`ArgumentType.Fixed`
:param y:
surface-local y coordinate
:type y:
`ArgumentType.Fixed`
"""
self._post_event(0, serial, time, surface, id, x, y)
@WlTouch.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Int),
)
def up(self, serial: int, time: int, id: int) -> None:
"""End of a touch event sequence
The touch point has disappeared. No further events will be sent for
this touch point and the touch point's ID is released and may be reused
in a future touch down event.
:param serial:
serial number of the touch up event
:type serial:
`ArgumentType.Uint`
:param time:
timestamp with millisecond granularity
:type time:
`ArgumentType.Uint`
:param id:
the unique ID of this touch point
:type id:
`ArgumentType.Int`
"""
self._post_event(1, serial, time, id)
@WlTouch.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Int),
Argument(ArgumentType.Fixed),
Argument(ArgumentType.Fixed),
)
def motion(self, time: int, id: int, x: float, y: float) -> None:
"""Update of touch point coordinates
A touch point has changed coordinates.
:param time:
timestamp with millisecond granularity
:type time:
`ArgumentType.Uint`
:param id:
the unique ID of this touch point
:type id:
`ArgumentType.Int`
:param x:
surface-local x coordinate
:type x:
`ArgumentType.Fixed`
:param y:
surface-local y coordinate
:type y:
`ArgumentType.Fixed`
"""
self._post_event(2, time, id, x, y)
@WlTouch.event()
def frame(self) -> None:
"""End of touch frame event
Indicates the end of a set of events that logically belong together. A
client is expected to accumulate the data in all events within the
frame before proceeding.
A :func:`WlTouch.frame()` terminates at least one event but otherwise
no guarantee is provided about the set of events within a frame. A
client must assume that any state not updated in a frame is unchanged
from the previously known state.
"""
self._post_event(3)
@WlTouch.event()
def cancel(self) -> None:
"""Touch session cancelled
Sent if the compositor decides the touch stream is a global gesture. No
further events are sent to the clients from that particular gesture.
Touch cancellation applies to all touch points currently active on this
client's surface. The client is responsible for finalizing the touch
points, future touch points on this surface may reuse the touch point
ID.
No frame event is required after the cancel event.
"""
self._post_event(4)
@WlTouch.event(
Argument(ArgumentType.Int),
Argument(ArgumentType.Fixed),
Argument(ArgumentType.Fixed),
version=6,
)
def shape(self, id: int, major: float, minor: float) -> None:
"""Update shape of touch point
Sent when a touchpoint has changed its shape.
This event does not occur on its own. It is sent before a
:func:`WlTouch.frame()` event and carries the new shape information for
any previously reported, or new touch points of that frame.
Other events describing the touch point such as :func:`WlTouch.down()`,
:func:`WlTouch.motion()` or :func:`WlTouch.orientation()` may be sent
within the same :func:`WlTouch.frame()`. A client should treat these
events as a single logical touch point update. The order of
:func:`WlTouch.shape()`, :func:`WlTouch.orientation()` and
:func:`WlTouch.motion()` is not guaranteed. A :func:`WlTouch.down()`
event is guaranteed to occur before the first :func:`WlTouch.shape()`
event for this touch ID but both events may occur within the same
:func:`WlTouch.frame()`.
A touchpoint shape is approximated by an ellipse through the major and
minor axis length. The major axis length describes the longer diameter
of the ellipse, while the minor axis length describes the shorter
diameter. Major and minor are orthogonal and both are specified in
surface-local coordinates. The center of the ellipse is always at the
touchpoint location as reported by :func:`WlTouch.down()` or
:func:`WlTouch.motion()`.
This event is only sent by the compositor if the touch device supports
shape reports. The client has to make reasonable assumptions about the
shape if it did not receive this event.
:param id:
the unique ID of this touch point
:type id:
`ArgumentType.Int`
:param major:
length of the major axis in surface-local coordinates
:type major:
`ArgumentType.Fixed`
:param minor:
length of the minor axis in surface-local coordinates
:type minor:
`ArgumentType.Fixed`
"""
self._post_event(5, id, major, minor)
@WlTouch.event(
Argument(ArgumentType.Int),
Argument(ArgumentType.Fixed),
version=6,
)
def orientation(self, id: int, orientation: float) -> None:
"""Update orientation of touch point
Sent when a touchpoint has changed its orientation.
This event does not occur on its own. It is sent before a
:func:`WlTouch.frame()` event and carries the new shape information for
any previously reported, or new touch points of that frame.
Other events describing the touch point such as :func:`WlTouch.down()`,
:func:`WlTouch.motion()` or :func:`WlTouch.shape()` may be sent within
the same :func:`WlTouch.frame()`. A client should treat these events as
a single logical touch point update. The order of
:func:`WlTouch.shape()`, :func:`WlTouch.orientation()` and
:func:`WlTouch.motion()` is not guaranteed. A :func:`WlTouch.down()`
event is guaranteed to occur before the first
:func:`WlTouch.orientation()` event for this touch ID but both events
may occur within the same :func:`WlTouch.frame()`.
The orientation describes the clockwise angle of a touchpoint's major
axis to the positive surface y-axis and is normalized to the -180 to
+180 degree range. The granularity of orientation depends on the touch
device, some devices only support binary rotation values between 0 and
90 degrees.
This event is only sent by the compositor if the touch device supports
orientation reports.
:param id:
the unique ID of this touch point
:type id:
`ArgumentType.Int`
:param orientation:
angle between major axis and positive surface y-axis in degrees
:type orientation:
`ArgumentType.Fixed`
"""
self._post_event(6, id, orientation)
class WlTouchGlobal(Global):
interface = WlTouch
WlTouch._gen_c()
WlTouch.proxy_class = WlTouchProxy
WlTouch.resource_class = WlTouchResource
WlTouch.global_class = WlTouchGlobal
@@ -1,26 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2018 Simon Ser
# Copyright © 2019 Andri Yngvason
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from .zwlr_screencopy_frame_v1 import ZwlrScreencopyFrameV1 # noqa: F401
from .zwlr_screencopy_manager_v1 import ZwlrScreencopyManagerV1 # noqa: F401
@@ -1,307 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2018 Simon Ser
# Copyright © 2019 Andri Yngvason
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
import enum
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from ..wayland import WlBuffer
class ZwlrScreencopyFrameV1(Interface):
"""A frame ready for copy
This object represents a single frame.
When created, a series of buffer events will be sent, each representing a
supported buffer type. The "buffer_done" event is sent afterwards to
indicate that all supported buffer types have been enumerated. The client
will then be able to send a "copy" request. If the capture is successful,
the compositor will send a "flags" followed by a "ready" event.
For objects version 2 or lower, :class:`~pywayland.protocol.wayland.WlShm`
buffers are always supported, ie. the "buffer" event is guaranteed to be
sent.
If the capture failed, the "failed" event is sent. This can happen anytime
before the "ready" event.
Once either a "ready" or a "failed" event is received, the client should
destroy the frame.
"""
name = "zwlr_screencopy_frame_v1"
version = 3
class error(enum.IntEnum):
already_used = 0
invalid_buffer = 1
class flags(enum.IntFlag):
y_invert = 1
class ZwlrScreencopyFrameV1Proxy(Proxy[ZwlrScreencopyFrameV1]):
interface = ZwlrScreencopyFrameV1
@ZwlrScreencopyFrameV1.request(
Argument(ArgumentType.Object, interface=WlBuffer),
)
def copy(self, buffer: WlBuffer) -> None:
"""Copy the frame
Copy the frame to the supplied buffer. The buffer must have a the
correct size, see :func:`ZwlrScreencopyFrameV1.buffer()` and
:func:`ZwlrScreencopyFrameV1.linux_dmabuf()`. The buffer needs to have
a supported format.
If the frame is successfully copied, a "flags" and a "ready" events are
sent. Otherwise, a "failed" event is sent.
:param buffer:
:type buffer:
:class:`~pywayland.protocol.wayland.WlBuffer`
"""
self._marshal(0, buffer)
@ZwlrScreencopyFrameV1.request()
def destroy(self) -> None:
"""Delete this object, used or not
Destroys the frame. This request can be sent at any time by the client.
"""
self._marshal(1)
self._destroy()
@ZwlrScreencopyFrameV1.request(
Argument(ArgumentType.Object, interface=WlBuffer),
version=2,
)
def copy_with_damage(self, buffer: WlBuffer) -> None:
"""Copy the frame when it's damaged
Same as copy, except it waits until there is damage to copy.
:param buffer:
:type buffer:
:class:`~pywayland.protocol.wayland.WlBuffer`
"""
self._marshal(2, buffer)
class ZwlrScreencopyFrameV1Resource(Resource):
interface = ZwlrScreencopyFrameV1
@ZwlrScreencopyFrameV1.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
)
def buffer(self, format: int, width: int, height: int, stride: int) -> None:
"""Wl_shm buffer information
Provides information about :class:`~pywayland.protocol.wayland.WlShm`
buffer parameters that need to be used for this frame. This event is
sent once after the frame is created if
:class:`~pywayland.protocol.wayland.WlShm` buffers are supported.
:param format:
buffer format
:type format:
`ArgumentType.Uint`
:param width:
buffer width
:type width:
`ArgumentType.Uint`
:param height:
buffer height
:type height:
`ArgumentType.Uint`
:param stride:
buffer stride
:type stride:
`ArgumentType.Uint`
"""
self._post_event(0, format, width, height, stride)
@ZwlrScreencopyFrameV1.event(
Argument(ArgumentType.Uint),
)
def flags(self, flags: int) -> None:
"""Frame flags
Provides flags about the frame. This event is sent once before the
"ready" event.
:param flags:
frame flags
:type flags:
`ArgumentType.Uint`
"""
self._post_event(1, flags)
@ZwlrScreencopyFrameV1.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
)
def ready(self, tv_sec_hi: int, tv_sec_lo: int, tv_nsec: int) -> None:
"""Indicates frame is available for reading
Called as soon as the frame is copied, indicating it is available for
reading. This event includes the time at which presentation happened
at.
The timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples,
each component being an unsigned 32-bit value. Whole seconds are in
tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo,
and the additional fractional part in tv_nsec as nanoseconds. Hence,
for valid timestamps tv_nsec must be in [0, 999999999]. The seconds
part may have an arbitrary offset at start.
After receiving this event, the client should destroy the object.
:param tv_sec_hi:
high 32 bits of the seconds part of the timestamp
:type tv_sec_hi:
`ArgumentType.Uint`
:param tv_sec_lo:
low 32 bits of the seconds part of the timestamp
:type tv_sec_lo:
`ArgumentType.Uint`
:param tv_nsec:
nanoseconds part of the timestamp
:type tv_nsec:
`ArgumentType.Uint`
"""
self._post_event(2, tv_sec_hi, tv_sec_lo, tv_nsec)
@ZwlrScreencopyFrameV1.event()
def failed(self) -> None:
"""Frame copy failed
This event indicates that the attempted frame copy has failed.
After receiving this event, the client should destroy the object.
"""
self._post_event(3)
@ZwlrScreencopyFrameV1.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
version=2,
)
def damage(self, x: int, y: int, width: int, height: int) -> None:
"""Carries the coordinates of the damaged region
This event is sent right before the ready event when copy_with_damage
is requested. It may be generated multiple times for each
copy_with_damage request.
The arguments describe a box around an area that has changed since the
last copy request that was derived from the current screencopy manager
instance.
The union of all regions received between the call to copy_with_damage
and a ready event is the total damage since the prior ready event.
:param x:
damaged x coordinates
:type x:
`ArgumentType.Uint`
:param y:
damaged y coordinates
:type y:
`ArgumentType.Uint`
:param width:
current width
:type width:
`ArgumentType.Uint`
:param height:
current height
:type height:
`ArgumentType.Uint`
"""
self._post_event(4, x, y, width, height)
@ZwlrScreencopyFrameV1.event(
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
Argument(ArgumentType.Uint),
version=3,
)
def linux_dmabuf(self, format: int, width: int, height: int) -> None:
"""Linux-dmabuf buffer information
Provides information about linux-dmabuf buffer parameters that need to
be used for this frame. This event is sent once after the frame is
created if linux-dmabuf buffers are supported.
:param format:
fourcc pixel format
:type format:
`ArgumentType.Uint`
:param width:
buffer width
:type width:
`ArgumentType.Uint`
:param height:
buffer height
:type height:
`ArgumentType.Uint`
"""
self._post_event(5, format, width, height)
@ZwlrScreencopyFrameV1.event(version=3)
def buffer_done(self) -> None:
"""All buffer types reported
This event is sent once after all buffer events have been sent.
The client should proceed to create a buffer of one of the supported
types, and send a "copy" request.
"""
self._post_event(6)
class ZwlrScreencopyFrameV1Global(Global):
interface = ZwlrScreencopyFrameV1
ZwlrScreencopyFrameV1._gen_c()
ZwlrScreencopyFrameV1.proxy_class = ZwlrScreencopyFrameV1Proxy
ZwlrScreencopyFrameV1.resource_class = ZwlrScreencopyFrameV1Resource
ZwlrScreencopyFrameV1.global_class = ZwlrScreencopyFrameV1Global
@@ -1,142 +0,0 @@
# This file has been autogenerated by the pywayland scanner
# Copyright © 2018 Simon Ser
# Copyright © 2019 Andri Yngvason
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
from __future__ import annotations
from pywayland.protocol_core import (
Argument,
ArgumentType,
Global,
Interface,
Proxy,
Resource,
)
from ..wayland import WlOutput
from .zwlr_screencopy_frame_v1 import ZwlrScreencopyFrameV1
class ZwlrScreencopyManagerV1(Interface):
"""Manager to inform clients and begin capturing
This object is a manager which offers requests to start capturing from a
source.
"""
name = "zwlr_screencopy_manager_v1"
version = 3
class ZwlrScreencopyManagerV1Proxy(Proxy[ZwlrScreencopyManagerV1]):
interface = ZwlrScreencopyManagerV1
@ZwlrScreencopyManagerV1.request(
Argument(ArgumentType.NewId, interface=ZwlrScreencopyFrameV1),
Argument(ArgumentType.Int),
Argument(ArgumentType.Object, interface=WlOutput),
)
def capture_output(self, overlay_cursor: int, output: WlOutput) -> Proxy[ZwlrScreencopyFrameV1]:
"""Capture an output
Capture the next frame of an entire output.
:param overlay_cursor:
composite cursor onto the frame
:type overlay_cursor:
`ArgumentType.Int`
:param output:
:type output:
:class:`~pywayland.protocol.wayland.WlOutput`
:returns:
:class:`~pywayland.protocol.wlr_screencopy_unstable_v1.ZwlrScreencopyFrameV1`
"""
frame = self._marshal_constructor(0, ZwlrScreencopyFrameV1, overlay_cursor, output)
return frame
@ZwlrScreencopyManagerV1.request(
Argument(ArgumentType.NewId, interface=ZwlrScreencopyFrameV1),
Argument(ArgumentType.Int),
Argument(ArgumentType.Object, interface=WlOutput),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
Argument(ArgumentType.Int),
)
def capture_output_region(self, overlay_cursor: int, output: WlOutput, x: int, y: int, width: int, height: int) -> Proxy[ZwlrScreencopyFrameV1]:
"""Capture an output's region
Capture the next frame of an output's region.
The region is given in output logical coordinates, see
xdg_output.logical_size. The region will be clipped to the output's
extents.
:param overlay_cursor:
composite cursor onto the frame
:type overlay_cursor:
`ArgumentType.Int`
:param output:
:type output:
:class:`~pywayland.protocol.wayland.WlOutput`
:param x:
:type x:
`ArgumentType.Int`
:param y:
:type y:
`ArgumentType.Int`
:param width:
:type width:
`ArgumentType.Int`
:param height:
:type height:
`ArgumentType.Int`
:returns:
:class:`~pywayland.protocol.wlr_screencopy_unstable_v1.ZwlrScreencopyFrameV1`
"""
frame = self._marshal_constructor(1, ZwlrScreencopyFrameV1, overlay_cursor, output, x, y, width, height)
return frame
@ZwlrScreencopyManagerV1.request()
def destroy(self) -> None:
"""Destroy the manager
All objects created by the manager will still remain valid, until their
appropriate destroy request has been called.
"""
self._marshal(2)
self._destroy()
class ZwlrScreencopyManagerV1Resource(Resource):
interface = ZwlrScreencopyManagerV1
class ZwlrScreencopyManagerV1Global(Global):
interface = ZwlrScreencopyManagerV1
ZwlrScreencopyManagerV1._gen_c()
ZwlrScreencopyManagerV1.proxy_class = ZwlrScreencopyManagerV1Proxy
ZwlrScreencopyManagerV1.resource_class = ZwlrScreencopyManagerV1Resource
ZwlrScreencopyManagerV1.global_class = ZwlrScreencopyManagerV1Global
@@ -1,192 +0,0 @@
#!/usr/bin/env python3
"""Route 000 — the baseline: `grim` as a subprocess, once per frame.
This is the shipped path (``hhstream``'s ``CommandCapture``), measured by the
frozen contract in ``HARNESS.md``: spawn, read to EOF, encode inside the timed
span -- because the fork is the thing we are trying to beat, and leaving it out
would flatter the baseline into something nobody runs.
Deliberately dumb: no connection is held, no buffer is reused, nothing is
cached. It answers "what does today cost?", and the answer is expected to be
dominated by process startup plus one full JPEG encode.
./producers/grim_producer.py --output hh-<session> --frames 300 --warmup 10 \
--mode jpeg --json
"""
from __future__ import annotations
import argparse
import json
import os
import resource
import subprocess
import sys
import time
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
from resources import MachineSample, resource_fields # noqa: E402
#: grim's own words: JPEG q80 at 1280x720 measured ~46 ms here, which is the
#: number ``docs/CONTRACT.md`` cites. `-c` asks for the cursor, exactly as the
#: module's `captureCommand` does, so this measures the shipped shape.
CAPTURE = ["grim", "-c"]
def encode_mode_args(mode: str) -> list[str]:
"""JPEG by default (the wire codec); PPM when ``--mode raw`` is asked for.
PPM is uncompressed RGB -- 2,764,816 bytes for 1280x720, header included --
so `raw` here really is "the pixels, no encoder", and it is the honest way
to price grim's encode separately from its capture. (grim rejects pbm/pnm/
rgb/bmp: ppm is its one uncompressed format.)
"""
if mode == "jpeg":
return ["-t", "jpeg", "-q", "80"]
return ["-t", "ppm"]
def grim_argv(output: str | None, mode: str) -> list[str]:
"""Assemble a grim command line.
**Order is load-bearing.** grim's output file is *positional*, and `-` is
stdout, so `-o NAME` has to come **before** that trailing `-`: with them the
other way round grim captions nothing and writes a 637-byte nothing to the
pipe while still exiting 0. (Found the hard way; the live app in
`src/hhstream_live/__main__.py` inserts `-o` before the trailing `-` for
exactly this reason.)
"""
argv = list(CAPTURE) + encode_mode_args(mode)
if output:
argv += ["-o", output]
return argv + ["-"]
def one_frame(argv: list[str]) -> tuple[float, int]:
"""Return (milliseconds, bytes) for a single subprocess capture."""
start = time.monotonic_ns()
proc = subprocess.run(argv, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL)
data = proc.stdout
elapsed = (time.monotonic_ns() - start) / 1e6
if proc.returncode != 0 or not data:
raise RuntimeError(f"grim failed (exit {proc.returncode}); is WAYLAND_DISPLAY set?")
return elapsed, len(data)
def stats(samples: list[float]) -> dict:
ordered = sorted(samples)
def pick(q: float) -> float:
return ordered[min(len(ordered) - 1, int(q * len(ordered)))]
return {
"min": round(ordered[0], 3),
"p50": round(pick(0.50), 3),
"mean": round(sum(ordered) / len(ordered), 3),
"p95": round(pick(0.95), 3),
"max": round(ordered[-1], 3),
}
def cpu_seconds() -> float:
usage = resource.getrusage(resource.RUSAGE_CHILDREN)
return usage.ru_utime + usage.ru_stime
def main() -> int:
parser = argparse.ArgumentParser(description=__doc__)
target = parser.add_mutually_exclusive_group(required=True)
target.add_argument("--output")
target.add_argument("--all", action="store_true")
parser.add_argument("--frames", type=int, default=300)
parser.add_argument("--warmup", type=int, default=10)
parser.add_argument("--mode", choices=["raw", "jpeg"], default="jpeg")
parser.add_argument("--json", action="store_true")
args = parser.parse_args()
argv = grim_argv(args.output, args.mode)
geometry: list[int] | None = None
for _ in range(args.warmup):
one_frame(argv)
# Resource counters are sampled around the *measured* loop only, so they line
# up with the per-frame times. Children, because this route's cost is a
# process per frame.
before = MachineSample(children=True)
samples: list[float] = []
sizes: list[int] = []
wall_start = time.monotonic_ns()
for index in range(args.frames):
elapsed, size = one_frame(argv)
samples.append(elapsed)
sizes.append(size)
if index == 0:
geometry = _geometry_of(output=args.output, mode=args.mode)
wall_ms = (time.monotonic_ns() - wall_start) / 1e6
after = MachineSample(children=True)
result = {
"route": "grim-subprocess",
"language": "python",
"protocol": "zwlr-screencopy-v1 (grim's client)",
"output": args.output or "all",
"geometry": geometry,
"mode": args.mode,
"warmup": args.warmup,
"frames": args.frames,
"frame_ms": stats(samples),
"fps_sustained": round(len(samples) / (sum(samples) / 1000.0), 2),
"wall_ms": round(wall_ms, 2),
"bytes_p50": sorted(sizes)[len(sizes) // 2],
"persistent": False,
"notes": (
"one grim process per frame, fork and encode inside the timed span; "
f"territory: {'--all (every output stitched)' if args.all else '--output'}; "
+ ("jpeg q80" if args.mode == "jpeg" else "ppm, unencoded")
),
}
result.update(
resource_fields(
before,
after,
frames=args.frames,
bytes_allocated=int(
(geometry[0] * 4 * geometry[1]) if geometry and args.mode == "raw" else 0
)
or None,
window_ms=wall_ms,
)
)
if args.json:
print(json.dumps(result))
else:
print(json.dumps(result, indent=2))
return 0
def _geometry_of(output: str | None, mode: str) -> list[int] | None:
"""Read the frame's own header for its size -- never guess it.
For a PNG/JPEG this is the file header; for pbm, the text header. One extra
capture outside the measurement, purely so the report says what it measured.
"""
import struct
try:
proc = subprocess.run(
list(CAPTURE) + ["-t", "png"] + (["-o", output] if output else []) + ["-"],
stdout=subprocess.PIPE,
stderr=subprocess.DEVNULL,
)
data = proc.stdout
if data[:8] == b"\x89PNG\r\n\x1a\n":
width, height = struct.unpack(">II", data[16:24])
return [width, height]
return None
except Exception:
return None
if __name__ == "__main__":
sys.exit(main())
-142
View File
@@ -1,142 +0,0 @@
#!/usr/bin/env python3
"""Resource measurement for the capture routes: RAM, and CPU from three angles.
Speed is not the whole answer: a route that reaches 15 fps by burning a core is
not one this machine can ship while it is also rendering windows. So every route
reports
- **its own** CPU and peak RSS (`getrusage`, `RUSAGE_CHILDREN` for the
subprocess-per-frame baseline, whose cost lives in children);
- **the machine's** CPU from `/proc/stat`, which is the number that catches a
route that is only fast because somebody else did more work;
- **the compositor's** CPU from `/proc/<hyprland>/stat`, which separates "the
capture is expensive" from "the capture made the compositor expensive".
Everything is sampled around the *measured* loop, never the warm-up, so the
numbers line up with the per-frame times in the result.
"""
from __future__ import annotations
import os
import resource
CLK_TCK = os.sysconf("SC_CLK_TCK")
def _hyprland_pid() -> int | None:
"""The compositor's pid, read from /proc rather than by shelling out.
`systemctl show -p MainPID` would be a CLI call, and a benchmark that shells
out to ask its own question is measuring something other than the route.
"""
try:
for entry in os.listdir("/proc"):
if not entry.isdigit():
continue
try:
with open(f"/proc/{entry}/comm") as handle:
comm = handle.read().strip()
except OSError:
continue
if "Hyprland" in comm:
return int(entry)
except OSError:
return None
return None
def _proc_cpu_ticks(pid: int | None) -> float | None:
"""utime+stime of one process, in seconds."""
if pid is None:
return None
try:
with open(f"/proc/{pid}/stat") as handle:
fields = handle.read().rsplit(")", 1)[1].split()
# After the comm field: state is field 3, so utime/stime (14/15 in the
# full line) land at 11 and 12 here.
return (int(fields[11]) + int(fields[12])) / CLK_TCK
except (OSError, IndexError, ValueError):
return None
def _system_cpu_seconds() -> float | None:
"""Total CPU consumed by everything, all cores, in seconds."""
try:
with open("/proc/stat") as handle:
line = handle.readline()
parts = [int(value) for value in line.split()[1:]]
# user nice system idle iowait irq softirq steal guest guest_nice
busy = parts[0] + parts[1] + parts[2] + parts[5] + parts[6] + parts[7]
return busy / CLK_TCK
except (OSError, ValueError, IndexError):
return None
class MachineSample:
"""One instant of the three CPU counters plus the RSS source."""
def __init__(self, children: bool) -> None:
self.children = children
self.pid = _hyprland_pid()
self.process_cpu = self._own_cpu_seconds()
self.system_cpu = _system_cpu_seconds()
self.compositor_cpu = _proc_cpu_ticks(self.pid)
def _own_cpu_seconds(self) -> float:
usage = resource.getrusage(
resource.RUSAGE_CHILDREN if self.children else resource.RUSAGE_SELF
)
return usage.ru_utime + usage.ru_stime
@property
def rss_peak_kb(self) -> int:
usage = resource.getrusage(
resource.RUSAGE_CHILDREN if self.children else resource.RUSAGE_SELF
)
# ru_maxrss is KiB on Linux, despite the name.
return int(usage.ru_maxrss)
def resource_fields(
before: MachineSample,
after: MachineSample,
frames: int,
bytes_allocated: int | None,
window_ms: float,
cores: int | None = None,
) -> dict:
"""The contract's resource block, from two samples around the measured loop."""
if frames <= 0:
frames = 1
notes: list[str] = []
system_delta_ms = None
if before.system_cpu is not None and after.system_cpu is not None:
system_delta_ms = (after.system_cpu - before.system_cpu) * 1000.0
compositor_ms = None
if before.compositor_cpu is not None and after.compositor_cpu is not None:
compositor_ms = (after.compositor_cpu - before.compositor_cpu) * 1000.0
own_ms = (after.process_cpu - before.process_cpu) * 1000.0
if compositor_ms is None:
notes.append("compositor CPU unreadable (/proc/<Hyprland>/stat)")
cores = cores or os.cpu_count() or 1
machine_pct = None
if system_delta_ms is not None and window_ms > 0:
machine_pct = system_delta_ms / window_ms * 100.0
return {
"cpu_ms_per_frame": round(own_ms / frames, 3),
"rss_peak_mb": round(after.rss_peak_kb / 1024, 2),
"rss_peak_kb_raw": after.rss_peak_kb,
"system_cpu_ms_per_frame": None if system_delta_ms is None else round(system_delta_ms / frames, 3),
"compositor_cpu_ms_per_frame": None if compositor_ms is None else round(compositor_ms / frames, 3),
"machine_cpu_pct": None if machine_pct is None else round(machine_pct, 1),
"machine_cpu_pct_of_all_cores": None if machine_pct is None else round(machine_pct / cores, 1),
"frames_bytes_allocated_p50": bytes_allocated,
"resource_notes": "; ".join(notes),
}
@@ -1,603 +0,0 @@
#!/usr/bin/env python3
"""Route 001b — raw `pywayland`: no subprocess, no helper binary.
One long-lived Wayland connection, one `wl_shm` buffer per output kept alive
between frames, and the capture driven directly over **`zwlr-screencopy`**
(what grim uses, and deprecated) or **`ext-image-copy-capture`** (its
replacement, which this compositor advertises alongside a source manager per
source kind). Which one actually ran is reported, never assumed.
Encoding is `turbojpeg` through `ctypes` -- the library grim itself links, so
both routes pay for the same JPEG. Doing it in-process is the point: the
baseline forks a process per frame and this does not.
Implements the frozen contract in ``HARNESS.md``:
./wayland_producer.py --output hh-<session> --frames 300 --warmup 10 \\
--mode jpeg --json
./wayland_producer.py --all --frames 300 --warmup 10 --mode raw --json
Flags beyond the contract, for debugging a route rather than measuring one:
``--protocol {auto,ext,screencopy}``, ``--list-outputs``, ``--wait-damage``
(ask the compositor to wait for new pixels instead of forcing a repaint --
this is the still-screen question, see the README).
Two pywayland facts this file exists to document: a dispatcher receives the
*proxy* as its first argument, and finishing without `display.disconnect()`
segfaults during interpreter teardown -- after the result is printed, so a
green run reads as exit 139.
"""
from __future__ import annotations
import argparse
import ctypes
import json
import mmap
import os
import resource
import select
import sys
import time
import wl.ext_image_capture_source_v1 as eics
import wl.ext_image_copy_capture_v1 as eicc
import wl.wayland as wl
import wl.wlr_screencopy_unstable_v1 as screencopy
from pywayland.client import Display
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
from resources import MachineSample, resource_fields # noqa: E402
# -- turbojpeg, minus the C headers -------------------------------------------
TJPF_BGRX = 3 # XRGB8888/ARGB8888 in little-endian memory is B,G,R,X
TJSAMP_420 = 2
QUALITY = 80 # grim's -q 80, so the two routes compress the same amount
class TurboJPEG:
"""The encoder grim links, called through ctypes.
`libjpeg-turbo` is a spike-local dependency (see shell.nix); the shipped
package would have to declare it, or publish PNG -- which is 2-3x the bytes.
**Declare every argtype.** Without them ctypes passes pointers through a
default signature and `tjCompress2` reads the wrong width/pitch -- which is a
segfault, not a wrong number, and it took the whole process down mid-run
(the result line never printed) the first time this was written.
"""
def __init__(self) -> None:
self.lib = ctypes.CDLL(os.environ.get("TURBOJPEG_PATH", "libturbojpeg.so"))
self.lib.tjInitCompress.argtypes = []
self.lib.tjInitCompress.restype = ctypes.c_void_p
self.lib.tjCompress2.argtypes = [
ctypes.c_void_p, # tjhandle
ctypes.c_void_p, # srcBuf
ctypes.c_int, # width
ctypes.c_int, # pitch
ctypes.c_int, # height
ctypes.c_int, # pixelFormat
ctypes.POINTER(ctypes.c_void_p), # jpegBuf
ctypes.POINTER(ctypes.c_ulong), # jpegSize
ctypes.c_int, # jpegSubsamp
ctypes.c_int, # jpegQual
ctypes.c_int, # flags
]
self.lib.tjCompress2.restype = ctypes.c_int
self.lib.tjFree.argtypes = [ctypes.c_void_p]
self.lib.tjDestroy.argtypes = [ctypes.c_void_p]
self.handle = self.lib.tjInitCompress()
if not self.handle:
raise RuntimeError("tjInitCompress failed")
self._out = ctypes.c_void_p()
self._size = ctypes.c_ulong()
def compress(self, address: int, width: int, height: int, pitch: int) -> tuple[bytes, float]:
start = time.monotonic_ns()
rc = self.lib.tjCompress2(
ctypes.c_void_p(self.handle),
ctypes.c_void_p(address),
ctypes.c_int(width),
ctypes.c_int(pitch),
ctypes.c_int(height),
ctypes.c_int(TJPF_BGRX),
ctypes.byref(self._out),
ctypes.byref(self._size),
ctypes.c_int(TJSAMP_420),
ctypes.c_int(QUALITY),
0,
)
if rc != 0:
raise RuntimeError(f"tjCompress2 failed: {rc}")
data = ctypes.string_at(self._out, self._size.value)
elapsed = (time.monotonic_ns() - start) / 1e6
self.lib.tjFree(self._out)
# **Reset to NULL after freeing.** turbojpeg treats a non-NULL
# `*jpegBuf` as a caller-supplied destination buffer, so leaving the
# freed pointer in place makes the next call write into freed memory:
# a heap-corrupting segfault, several frames later, with no stack trace
# pointing at the encoder. This is the bug that ate the first jpeg run.
self._out = ctypes.c_void_p()
self._size = ctypes.c_ulong()
return data, elapsed
def close(self) -> None:
if self.handle:
self.lib.tjDestroy(ctypes.c_void_p(self.handle))
self.handle = None
# -- shm buffers ---------------------------------------------------------------
class ShmBuffer:
"""One `wl_shm` pool + buffer + mmap, sized once and reused per frame."""
def __init__(self, shm, width: int, height: int, stride: int, fmt: int):
self.width, self.height, self.stride, self.fmt = width, height, stride, fmt
self.size = stride * height
self.fd = os.memfd_create("hhstream-spike", 0)
os.ftruncate(self.fd, self.size)
self.map = mmap.mmap(self.fd, self.size, prot=mmap.PROT_READ | mmap.PROT_WRITE)
self.pool = shm.create_pool(self.fd, self.size)
self.buffer = self.pool.create_buffer(0, width, height, stride, fmt)
self.address = ctypes.addressof(ctypes.c_char.from_buffer(self.map))
def destroy(self) -> None:
for step in (self.buffer.destroy, self.pool.destroy):
try:
step()
except Exception:
pass
try:
self.map.close()
os.close(self.fd)
except Exception:
pass
class OutputSession:
"""One output, one protocol, one reusable buffer (ext) or a frame per grab."""
def __init__(self, client: "Capture", label: str | None, output, fmt: int, wait_damage: bool):
self.client = client
self.label = label or "?"
self.output = output
self.wait_damage = wait_damage
self.buffer: ShmBuffer | None = None
self.session = None
self.ready = False
self.failed = False
self.geometry: tuple[int, int] | None = None
self._session_done = False
self.formats: list[int] = []
self._wanted_fmt = fmt
if client.protocol.startswith("ext"):
self.source = client.ext_source_mgr.create_source(output)
self.session = client.ext_mgr.create_session(self.source, 0)
self.session.dispatcher["buffer_size"] = self._on_buffer_size
self.session.dispatcher["shm_format"] = self._on_shm_format
self.session.dispatcher["done"] = self._on_session_done
self.client.wait(lambda: self._session_done)
# The session advertises its constraints *before* any frame exists:
# a size, then one `shm_format` per format it can deliver, then
# `done`. Only now can a buffer be allocated -- a frame created
# before this point has nothing to attach (`attach_buffer` on None
# raises, which is how this was found).
if self.geometry is None:
raise RuntimeError(f"the session for {self.label} never sent a buffer size")
width, height = self.geometry
fmt = self.formats[0] if self.formats else 1 # XRGB8888
self.buffer = ShmBuffer(client.shm, width, height, width * 4, fmt)
# -- ext-image-copy-capture --------------------------------------------
def _on_buffer_size(self, session, width: int, height: int) -> None:
self.geometry = (width, height)
def _on_shm_format(self, session, fmt: int) -> None:
self.formats.append(fmt)
def _on_session_done(self, session) -> None:
self._session_done = True
def grab_ext(self) -> None:
self.ready = self.failed = False
frame = self.session.create_frame()
frame.dispatcher["ready"] = lambda proxy: setattr(self, "ready", True)
frame.dispatcher["failed"] = lambda proxy: setattr(self, "failed", True)
frame.dispatcher["transform"] = lambda proxy, t: None
frame.dispatcher["damage"] = lambda proxy, *rest: None
frame.dispatcher["presentation_time"] = lambda proxy, *rest: None
frame.attach_buffer(self.buffer.buffer)
frame.damage_buffer(0, 0, self.buffer.width, self.buffer.height)
frame.capture()
self.client.wait(lambda: self.ready or self.failed)
frame.destroy()
# -- zwlr-screencopy ---------------------------------------------------
def grab_screencopy(self) -> None:
self.ready = self.failed = False
frame = self.client.screencopy_mgr.capture_output(1, self.output)
frame.dispatcher["buffer"] = self._on_sc_buffer
frame.dispatcher["flags"] = lambda proxy, flags: None
frame.dispatcher["damage"] = lambda proxy, *rest: None
frame.dispatcher["ready"] = lambda proxy, *rest: setattr(self, "ready", True)
frame.dispatcher["failed"] = lambda proxy: setattr(self, "failed", True)
self._sc_frame = frame
self.client.wait(lambda: self.buffer is not None)
if self.wait_damage:
frame.copy_with_damage(self.buffer.buffer)
else:
frame.copy(self.buffer.buffer)
self.client.wait(lambda: self.ready or self.failed)
frame.destroy()
def _on_sc_buffer(self, frame, fmt: int, width: int, height: int, stride: int) -> None:
if self.buffer is None or (self.buffer.width, self.buffer.height, self.buffer.stride) != (
width,
height,
stride,
):
if self.buffer:
self.buffer.destroy()
self.buffer = ShmBuffer(self.client.shm, width, height, stride, fmt)
self.geometry = (width, height)
class Capture:
def __init__(self, protocol: str, names_wanted: list[str] | None, want_all: bool, wait_damage: bool):
self.display = Display()
self.display.connect()
self.registry = self.display.get_registry()
self.globals: dict[str, tuple[int, int]] = {}
self._output_globals: list[tuple[int, int]] = []
self._output_names: dict[object, str] = {}
self._output_positions: dict[object, tuple[int, int]] = {}
self._output_proxies: list = []
self.shm = None
self.screencopy_mgr = None
self.ext_mgr = None
self.ext_source_mgr = None
self.protocol = None
self.wait_damage = wait_damage
self.sessions: list[OutputSession] = []
self.stage_ms = {"capture": 0.0, "encode": 0.0}
self._canvas: ctypes.Array | None = None
self._canvas_geometry: tuple[int, int] | None = None
self.registry.dispatcher["global"] = self._on_global
self.display.roundtrip()
if "wl_shm" not in self.globals:
raise RuntimeError("no wl_shm: the compositor cannot hand us pixels")
self.protocol = self._pick_protocol(protocol)
shm_name, shm_version = self.globals["wl_shm"]
self.shm = self.registry.bind(shm_name, wl.WlShm, shm_version)
for name, version in self._output_globals:
output = self.registry.bind(name, wl.WlOutput, min(version, 4))
self._output_proxies.append(output) # a GC'd proxy stops delivering events
output.dispatcher["name"] = self._on_output_name
output.dispatcher["geometry"] = self._on_output_geometry
self.display.roundtrip()
# Sorted by position, not by registry order: `--all` stitches these
# left to right, and "the order the compositor announced its outputs"
# is not a promise about where they are on the desktop.
self.outputs: list[tuple[str, object]] = sorted(
(
(self._output_names.get(proxy, f"output-{index}"), proxy)
for index, proxy in enumerate(self._output_proxies)
),
key=lambda pair: (self._output_positions.get(pair[1], (1 << 30, 0)), pair[0]),
)
if not want_all:
wanted = set(names_wanted or [])
chosen = [pair for pair in self.outputs if pair[0] in wanted]
missing = wanted - {label for label, _ in chosen}
if missing:
raise RuntimeError(
f"no such output: {sorted(missing)}; this compositor has "
f"{sorted(label for label, _ in self.outputs)}"
)
self.outputs = chosen
if not self.outputs:
raise RuntimeError("no outputs to capture")
def open_sessions(self) -> None:
"""Start a capture session per target output. Separate from __init__ so
`--list-outputs` can enumerate without setting any capture up."""
if self.sessions:
return
self.sessions = [
OutputSession(self, label, proxy, fmt=0, wait_damage=self.wait_damage)
for label, proxy in self.outputs
]
# -- registry plumbing -------------------------------------------------
def _on_global(self, registry, name: int, interface: str, version: int) -> None:
self.globals[interface] = (name, version)
if interface == "wl_output":
self._output_globals.append((name, version))
def _on_output_name(self, output, name: str) -> None:
self._output_names[output] = name
def _on_output_geometry(self, output, x: int, y: int, physical_width: int,
physical_height: int, subpixel: int, make: str,
model: str, transform: int) -> None:
"""Where this output is in the layout -- the stitch order for `--all`."""
self._output_positions[output] = (x, y)
def _pick_protocol(self, requested: str) -> str:
have_ext = (
"ext_image_copy_capture_manager_v1" in self.globals
and "ext_output_image_capture_source_manager_v1" in self.globals
)
have_scr = "zwlr_screencopy_manager_v1" in self.globals
if requested == "ext" and not have_ext:
raise RuntimeError("--protocol ext asked for, but the compositor does not advertise it")
if requested == "screencopy" and not have_scr:
raise RuntimeError("--protocol screencopy asked for, but the compositor does not advertise it")
use_ext = have_ext if requested == "auto" else requested == "ext"
if not use_ext and not have_scr:
raise RuntimeError("neither capture protocol is available")
if use_ext:
name, version = self.globals["ext_image_copy_capture_manager_v1"]
self.ext_mgr = self.registry.bind(name, eicc.ExtImageCopyCaptureManagerV1, version)
name, version = self.globals["ext_output_image_capture_source_manager_v1"]
self.ext_source_mgr = self.registry.bind(
name, eics.ExtOutputImageCaptureSourceManagerV1, version
)
return "ext-image-copy-capture-v1"
name, version = self.globals["zwlr_screencopy_manager_v1"]
self.screencopy_mgr = self.registry.bind(name, screencopy.ZwlrScreencopyManagerV1, version)
return "zwlr-screencopy-v1"
# -- dispatch ----------------------------------------------------------
def wait(self, done, timeout: float = 10.0) -> None:
"""Pump events until *done()*, or raise. Never blocks forever.
`display.dispatch(block=False)` processes only events **already read**
from the socket -- it never reads. A wait built on it (plus `select`)
therefore times out on a compositor that is answering perfectly, which
cost an hour of this spike. The read is `dispatch(block=True)`, and the
"never hang" guarantee comes from a real alarm rather than from polling.
"""
import signal
def on_alarm(signum, frame): # pragma: no cover - exercised on failure
raise TimeoutError(
"the compositor never became ready within "
f"{timeout:.0f}s (still screen? see --wait-damage)"
)
previous = signal.signal(signal.SIGALRM, on_alarm)
signal.setitimer(signal.ITIMER_REAL, timeout)
try:
self.display.flush()
while not done():
self.display.dispatch(block=True)
finally:
signal.setitimer(signal.ITIMER_REAL, 0)
signal.signal(signal.SIGALRM, previous)
# -- the measured path -------------------------------------------------
def grab(self) -> tuple[int, int]:
"""One frame of every target output; returns the stitched geometry."""
start = time.monotonic_ns()
for session in self.sessions:
if self.protocol.startswith("ext"):
session.grab_ext()
else:
session.grab_screencopy()
if session.failed:
raise RuntimeError(f"capture failed on {session.label}")
self.stage_ms["capture"] += (time.monotonic_ns() - start) / 1e6
width = sum(session.buffer.width for session in self.sessions)
height = max(session.buffer.height for session in self.sessions)
return width, height
def jpeg(self, encoder: TurboJPEG) -> bytes | None:
"""Encode the frame the wire would carry, stitching first if needed.
The first version of this returned ``None`` for `--all` and left the
stitch "to the caller" -- which no caller did, so the `--all --mode
jpeg` cell reported an encode of 0.0 ms and `bytes_p50: null` while
looking like a successful run. That cell is the one `hhstream`
publishes today, so the silent hole was in the only number that
decides anything.
The stitch is charged to the **encode** stage, not to capture: it is
work this route does to turn N output buffers into one image, and it
is exactly the work `grim -c` does inside its own process.
"""
if len(self.sessions) == 1:
buffer = self.sessions[0].buffer
data, elapsed = encoder.compress(
buffer.address, buffer.width, buffer.height, buffer.stride
)
self.stage_ms["encode"] += elapsed
return data
start = time.monotonic_ns()
width, height, stride, address = self._stitch()
stitch_ms = (time.monotonic_ns() - start) / 1e6
data, elapsed = encoder.compress(address, width, height, stride)
self.stage_ms["encode"] += stitch_ms + elapsed
self.stage_ms["stitch"] = self.stage_ms.get("stitch", 0.0) + stitch_ms
return data
def _stitch(self) -> tuple[int, int, int, int]:
"""Copy every output buffer side by side into one canvas.
Allocated once and reused, like the per-output buffers: a fresh
10 MB canvas per frame would be measuring the allocator. Rows are
copied one `memmove` at a time because the canvas stride is wider
than any single output's.
"""
width = sum(session.buffer.width for session in self.sessions)
height = max(session.buffer.height for session in self.sessions)
stride = width * 4
if self._canvas is None or self._canvas_geometry != (width, height):
self._canvas = ctypes.create_string_buffer(stride * height)
self._canvas_geometry = (width, height)
base = ctypes.addressof(self._canvas)
x_offset = 0
for session in self.sessions:
buffer = session.buffer
row_bytes = buffer.width * 4
for row in range(min(buffer.height, height)):
ctypes.memmove(
base + row * stride + x_offset * 4,
buffer.address + row * buffer.stride,
row_bytes,
)
x_offset += buffer.width
return width, height, stride, base
def buffer_bytes(self) -> int | None:
"""Every byte of frame buffer this route holds, canvas included."""
held = [session.buffer.size for session in self.sessions if session.buffer]
if not held:
return None
total = sum(held)
if self._canvas is not None:
total += len(self._canvas)
return total
def close(self) -> None:
for session in getattr(self, "sessions", []):
if session.buffer:
session.buffer.destroy()
self.display.disconnect()
def stats(samples: list[float]) -> dict:
ordered = sorted(samples)
def pick(q: float) -> float:
return ordered[min(len(ordered) - 1, int(q * len(ordered)))]
return {
"min": round(ordered[0], 3),
"p50": round(pick(0.50), 3),
"mean": round(sum(ordered) / len(ordered), 3),
"p95": round(pick(0.95), 3),
"max": round(ordered[-1], 3),
}
def main() -> int:
parser = argparse.ArgumentParser(description=__doc__)
target = parser.add_mutually_exclusive_group(required=True)
target.add_argument("--output", action="append", help="wl_output name; repeat for several")
target.add_argument("--all", action="store_true", help="every output, stitched")
target.add_argument("--list-outputs", action="store_true")
parser.add_argument("--frames", type=int, default=300)
parser.add_argument("--warmup", type=int, default=10)
parser.add_argument("--mode", choices=["raw", "jpeg"], default="jpeg")
parser.add_argument("--protocol", choices=["auto", "ext", "screencopy"], default="auto")
parser.add_argument("--wait-damage", action="store_true", help="wait for new pixels instead of forcing a repaint")
parser.add_argument("--json", action="store_true")
args = parser.parse_args()
if args.list_outputs:
client = Capture("auto", None, True, False)
for label, _ in client.outputs:
print(label)
client.close()
return 0
client = Capture(
args.protocol, args.output, args.all, wait_damage=args.wait_damage
)
client.open_sessions()
encoder = TurboJPEG() if args.mode == "jpeg" else None
geometry: tuple[int, int] | None = None
try:
for _ in range(args.warmup):
client.grab()
if encoder:
client.jpeg(encoder)
# Sampled around the measured loop only: a persistent route's cost is in
# this process, so RUSAGE_SELF, not children.
before = MachineSample(children=False)
client.stage_ms = {"capture": 0.0, "encode": 0.0}
samples: list[float] = []
sizes: list[int] = []
wall_start = time.monotonic_ns()
for _ in range(args.frames):
frame_start = time.monotonic_ns()
geometry = client.grab()
data = client.jpeg(encoder) if encoder else None
samples.append((time.monotonic_ns() - frame_start) / 1e6)
if data is not None:
sizes.append(len(data))
wall_ms = (time.monotonic_ns() - wall_start) / 1e6
after = MachineSample(children=False)
finally:
protocol = client.protocol
buffer_bytes = client.buffer_bytes()
client.close()
if encoder:
encoder.close()
result = {
"route": "pywayland-in-process",
"language": "python",
"protocol": protocol,
"output": args.output[0] if args.output else "all",
"geometry": list(geometry) if geometry else None,
"mode": args.mode,
"warmup": args.warmup,
"frames": len(samples),
"frame_ms": stats(samples),
"stage_ms": {
"capture": round(client.stage_ms["capture"] / max(1, len(samples)), 3),
"encode": round(client.stage_ms["encode"] / max(1, len(samples)), 3),
"stitch": round(client.stage_ms.get("stitch", 0.0) / max(1, len(samples)), 3),
},
"fps_sustained": round(len(samples) / (sum(samples) / 1000.0), 2) if samples else 0.0,
"wall_ms": round(wall_ms, 2),
"bytes_p50": sorted(sizes)[len(sizes) // 2] if sizes else None,
"persistent": True,
"notes": (
f"one connection, buffers reused, turbojpeg q{QUALITY} in-process; "
f"{len(client.outputs)} output(s); "
+ ("waiting for damage" if args.wait_damage else "forcing a repaint per frame")
+ (f"; stitched {len(client.outputs)} outputs" if len(client.outputs) > 1 else "")
),
}
result.update(
resource_fields(
before,
after,
frames=len(samples),
bytes_allocated=buffer_bytes,
window_ms=wall_ms,
)
)
print(json.dumps(result) if args.json else json.dumps(result, indent=2))
# **Exit without running teardown.** pywayland/CFFI finalizers segfault inside
# libwayland-client at interpreter shutdown (16 of them in this spike's logs,
# all `python3.14 … segfault … libwayland-client.so`), *after* the result is
# printed — so a green run reports exit 139 and, worse, the compositor was
# observed crashing in the same second as a batch of these. The bytes are
# flushed; everything after this point is library cleanup we do not need.
sys.stdout.flush()
sys.stderr.flush()
os._exit(0)
if __name__ == "__main__":
sys.exit(main())
@@ -1,219 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="ext_foreign_toplevel_list_v1">
<copyright>
Copyright © 2018 Ilia Bozhinov
Copyright © 2020 Isaac Freund
Copyright © 2022 wb9688
Copyright © 2023 i509VCB
Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
without fee, provided that the above copyright notice appear in
all copies and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of
the copyright holders not be used in advertising or publicity
pertaining to distribution of the software without specific,
written prior permission. The copyright holders make no
representations about the suitability of this software for any
purpose. It is provided "as is" without express or implied
warranty.
THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.
</copyright>
<description summary="list toplevels">
The purpose of this protocol is to provide protocol object handles for
toplevels, possibly originating from another client.
This protocol is intentionally minimalistic and expects additional
functionality (e.g. creating a screencopy source from a toplevel handle,
getting information about the state of the toplevel) to be implemented
in extension protocols.
The compositor may choose to restrict this protocol to a special client
launched by the compositor itself or expose it to all clients,
this is compositor policy.
The key words "must", "must not", "required", "shall", "shall not",
"should", "should not", "recommended", "may", and "optional" in this
document are to be interpreted as described in IETF RFC 2119.
Warning! The protocol described in this file is currently in the testing
phase. Backward compatible changes may be added together with the
corresponding interface version bump. Backward incompatible changes can
only be done by creating a new major version of the extension.
</description>
<interface name="ext_foreign_toplevel_list_v1" version="1">
<description summary="list toplevels">
A toplevel is defined as a surface with a role similar to xdg_toplevel.
XWayland surfaces may be treated like toplevels in this protocol.
After a client binds the ext_foreign_toplevel_list_v1, each mapped
toplevel window will be sent using the ext_foreign_toplevel_list_v1.toplevel
event.
Clients which only care about the current state can perform a roundtrip after
binding this global.
For each instance of ext_foreign_toplevel_list_v1, the compositor must
create a new ext_foreign_toplevel_handle_v1 object for each mapped toplevel.
If a compositor implementation sends the ext_foreign_toplevel_list_v1.finished
event after the global is bound, the compositor must not send any
ext_foreign_toplevel_list_v1.toplevel events.
</description>
<event name="toplevel">
<description summary="a toplevel has been created">
This event is emitted whenever a new toplevel window is created. It is
emitted for all toplevels, regardless of the app that has created them.
All initial properties of the toplevel (identifier, title, app_id) will be sent
immediately after this event using the corresponding events for
ext_foreign_toplevel_handle_v1. The compositor will use the
ext_foreign_toplevel_handle_v1.done event to indicate when all data has
been sent.
</description>
<arg name="toplevel" type="new_id" interface="ext_foreign_toplevel_handle_v1"/>
</event>
<event name="finished">
<description summary="the compositor has finished with the toplevel manager">
This event indicates that the compositor is done sending events
to this object. The client should destroy the object.
See ext_foreign_toplevel_list_v1.destroy for more information.
The compositor must not send any more toplevel events after this event.
</description>
</event>
<request name="stop">
<description summary="stop sending events">
This request indicates that the client no longer wishes to receive
events for new toplevels.
The Wayland protocol is asynchronous, meaning the compositor may send
further toplevel events until the stop request is processed.
The client should wait for a ext_foreign_toplevel_list_v1.finished
event before destroying this object.
</description>
</request>
<request name="destroy" type="destructor">
<description summary="destroy the ext_foreign_toplevel_list_v1 object">
This request should be called either when the client will no longer
use the ext_foreign_toplevel_list_v1 or after the finished event
has been received to allow destruction of the object.
If a client wishes to destroy this object it should send a
ext_foreign_toplevel_list_v1.stop request and wait for a ext_foreign_toplevel_list_v1.finished
event, then destroy the handles and then this object.
</description>
</request>
</interface>
<interface name="ext_foreign_toplevel_handle_v1" version="1">
<description summary="a mapped toplevel">
A ext_foreign_toplevel_handle_v1 object represents a mapped toplevel
window. A single app may have multiple mapped toplevels.
</description>
<request name="destroy" type="destructor">
<description summary="destroy the ext_foreign_toplevel_handle_v1 object">
This request should be used when the client will no longer use the handle
or after the closed event has been received to allow destruction of the
object.
When a handle is destroyed, a new handle may not be created by the server
until the toplevel is unmapped and then remapped. Destroying a toplevel handle
is not recommended unless the client is cleaning up child objects
before destroying the ext_foreign_toplevel_list_v1 object, the toplevel
was closed or the toplevel handle will not be used in the future.
Other protocols which extend the ext_foreign_toplevel_handle_v1
interface should require destructors for extension interfaces be
called before allowing the toplevel handle to be destroyed.
</description>
</request>
<event name="closed">
<description summary="the toplevel has been closed">
The server will emit no further events on the ext_foreign_toplevel_handle_v1
after this event. Any requests received aside from the destroy request must
be ignored. Upon receiving this event, the client should destroy the handle.
Other protocols which extend the ext_foreign_toplevel_handle_v1
interface must also ignore requests other than destructors.
</description>
</event>
<event name="done">
<description summary="all information about the toplevel has been sent">
This event is sent after all changes in the toplevel state have
been sent.
This allows changes to the ext_foreign_toplevel_handle_v1 properties
to be atomically applied. Other protocols which extend the
ext_foreign_toplevel_handle_v1 interface may use this event to also
atomically apply any pending state.
This event must not be sent after the ext_foreign_toplevel_handle_v1.closed
event.
</description>
</event>
<event name="title">
<description summary="title change">
The title of the toplevel has changed.
The configured state must not be applied immediately. See
ext_foreign_toplevel_handle_v1.done for details.
</description>
<arg name="title" type="string"/>
</event>
<event name="app_id">
<description summary="app_id change">
The app id of the toplevel has changed.
The configured state must not be applied immediately. See
ext_foreign_toplevel_handle_v1.done for details.
</description>
<arg name="app_id" type="string"/>
</event>
<event name="identifier">
<description summary="a stable identifier for a toplevel">
This identifier is used to check if two or more toplevel handles belong
to the same toplevel.
The identifier is useful for command line tools or privileged clients
which may need to reference an exact toplevel across processes or
instances of the ext_foreign_toplevel_list_v1 global.
The compositor must only send this event when the handle is created.
The identifier must be unique per toplevel and its handles. Two different
toplevels must not have the same identifier. The identifier is only valid
as long as the toplevel is mapped. If the toplevel is unmapped the identifier
must not be reused. An identifier must not be reused by the compositor to
ensure there are no races when sharing identifiers between processes.
An identifier is a string that contains up to 32 printable ASCII bytes.
An identifier must not be an empty string. It is recommended that a
compositor includes an opaque generation value in identifiers. How the
generation value is used when generating the identifier is implementation
dependent.
</description>
<arg name="identifier" type="string"/>
</event>
</interface>
</protocol>
@@ -1,109 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="ext_image_capture_source_v1">
<copyright>
Copyright © 2022 Andri Yngvason
Copyright © 2024 Simon Ser
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
</copyright>
<description summary="opaque image capture source objects">
This protocol serves as an intermediary between capturing protocols and
potential image capture sources such as outputs and toplevels.
This protocol may be extended to support more image capture sources in the
future, thereby adding those image capture sources to other protocols that
use the image capture source object without having to modify those
protocols.
Warning! The protocol described in this file is currently in the testing
phase. Backward compatible changes may be added together with the
corresponding interface version bump. Backward incompatible changes can
only be done by creating a new major version of the extension.
</description>
<interface name="ext_image_capture_source_v1" version="1" frozen="true">
<description summary="opaque image capture source object">
The image capture source object is an opaque descriptor for a capturable
resource. This resource may be any sort of entity from which an image
may be derived.
Note, because ext_image_capture_source_v1 objects are created from multiple
independent factory interfaces, the ext_image_capture_source_v1 interface is
frozen at version 1.
</description>
<request name="destroy" type="destructor">
<description summary="delete this object">
Destroys the image capture source. This request may be sent at any time
by the client.
</description>
</request>
</interface>
<interface name="ext_output_image_capture_source_manager_v1" version="1">
<description summary="image capture source manager for outputs">
A manager for creating image capture source objects for wl_output objects.
</description>
<request name="create_source">
<description summary="create source object for output">
Creates a source object for an output. Images captured from this source
will show the same content as the output. Some elements may be omitted,
such as cursors and overlays that have been marked as transparent to
capturing.
</description>
<arg name="source" type="new_id" interface="ext_image_capture_source_v1"/>
<arg name="output" type="object" interface="wl_output"/>
</request>
<request name="destroy" type="destructor">
<description summary="delete this object">
Destroys the manager. This request may be sent at any time by the client
and objects created by the manager will remain valid after its
destruction.
</description>
</request>
</interface>
<interface name="ext_foreign_toplevel_image_capture_source_manager_v1" version="1">
<description summary="image capture source manager for foreign toplevels">
A manager for creating image capture source objects for
ext_foreign_toplevel_handle_v1 objects.
</description>
<request name="create_source">
<description summary="create source object for foreign toplevel">
Creates a source object for a foreign toplevel handle. Images captured
from this source will show the same content as the toplevel.
</description>
<arg name="source" type="new_id" interface="ext_image_capture_source_v1"/>
<arg name="toplevel_handle" type="object" interface="ext_foreign_toplevel_handle_v1"/>
</request>
<request name="destroy" type="destructor">
<description summary="delete this object">
Destroys the manager. This request may be sent at any time by the client
and objects created by the manager will remain valid after its
destruction.
</description>
</request>
</interface>
</protocol>
@@ -1,456 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="ext_image_copy_capture_v1">
<copyright>
Copyright © 2021-2023 Andri Yngvason
Copyright © 2024 Simon Ser
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
</copyright>
<description summary="image capturing into client buffers">
This protocol allows clients to ask the compositor to capture image sources
such as outputs and toplevels into user submitted buffers.
Warning! The protocol described in this file is currently in the testing
phase. Backward compatible changes may be added together with the
corresponding interface version bump. Backward incompatible changes can
only be done by creating a new major version of the extension.
</description>
<interface name="ext_image_copy_capture_manager_v1" version="1">
<description summary="manager to inform clients and begin capturing">
This object is a manager which offers requests to start capturing from a
source.
</description>
<enum name="error">
<entry name="invalid_option" value="1" summary="invalid option flag"/>
</enum>
<enum name="options" bitfield="true">
<entry name="paint_cursors" value="1" summary="paint cursors onto captured frames"/>
</enum>
<request name="create_session">
<description summary="capture an image capture source">
Create a capturing session for an image capture source.
If the paint_cursors option is set, cursors shall be composited onto
the captured frame. The cursor must not be composited onto the frame
if this flag is not set.
If the options bitfield is invalid, the invalid_option protocol error
is sent.
</description>
<arg name="session" type="new_id" interface="ext_image_copy_capture_session_v1"/>
<arg name="source" type="object" interface="ext_image_capture_source_v1"/>
<arg name="options" type="uint" enum="options"/>
</request>
<request name="create_pointer_cursor_session">
<description summary="capture the pointer cursor of an image capture source">
Create a cursor capturing session for the pointer of an image capture
source.
</description>
<arg name="session" type="new_id" interface="ext_image_copy_capture_cursor_session_v1"/>
<arg name="source" type="object" interface="ext_image_capture_source_v1"/>
<arg name="pointer" type="object" interface="wl_pointer"/>
</request>
<request name="destroy" type="destructor">
<description summary="destroy the manager">
Destroy the manager object.
Other objects created via this interface are unaffected.
</description>
</request>
</interface>
<interface name="ext_image_copy_capture_session_v1" version="1">
<description summary="image copy capture session">
This object represents an active image copy capture session.
After a capture session is created, buffer constraint events will be
emitted from the compositor to tell the client which buffer types and
formats are supported for reading from the session. The compositor may
re-send buffer constraint events whenever they change.
To advertise buffer constraints, the compositor must send in no
particular order: zero or more shm_format and dmabuf_format events, zero
or one dmabuf_device event, and exactly one buffer_size event. Then the
compositor must send a done event.
When the client has received all the buffer constraints, it can create a
buffer accordingly, attach it to the capture session using the
attach_buffer request, set the buffer damage using the damage_buffer
request and then send the capture request.
</description>
<enum name="error">
<entry name="duplicate_frame" value="1"
summary="create_frame sent before destroying previous frame"/>
</enum>
<event name="buffer_size">
<description summary="image capture source dimensions">
Provides the dimensions of the source image in buffer pixel coordinates.
The client must attach buffers that match this size.
</description>
<arg name="width" type="uint" summary="buffer width"/>
<arg name="height" type="uint" summary="buffer height"/>
</event>
<event name="shm_format">
<description summary="shm buffer format">
Provides the format that must be used for shared-memory buffers.
This event may be emitted multiple times, in which case the client may
choose any given format.
</description>
<arg name="format" type="uint" enum="wl_shm.format" summary="shm format"/>
</event>
<event name="dmabuf_device">
<description summary="dma-buf device">
This event advertises the device buffers must be allocated on for
dma-buf buffers.
In general the device is a DRM node. The DRM node type (primary vs.
render) is unspecified. Clients must not rely on the compositor sending
a particular node type. Clients cannot check two devices for equality
by comparing the dev_t value.
</description>
<arg name="device" type="array" summary="device dev_t value"/>
</event>
<event name="dmabuf_format">
<description summary="dma-buf format">
Provides the format that must be used for dma-buf buffers.
The client may choose any of the modifiers advertised in the array of
64-bit unsigned integers.
This event may be emitted multiple times, in which case the client may
choose any given format.
</description>
<arg name="format" type="uint" summary="drm format code"/>
<arg name="modifiers" type="array" summary="drm format modifiers"/>
</event>
<event name="done">
<description summary="all constraints have been sent">
This event is sent once when all buffer constraint events have been
sent.
The compositor must always end a batch of buffer constraint events with
this event, regardless of whether it sends the initial constraints or
an update.
</description>
</event>
<event name="stopped">
<description summary="session is no longer available">
This event indicates that the capture session has stopped and is no
longer available. This can happen in a number of cases, e.g. when the
underlying source is destroyed, if the user decides to end the image
capture, or if an unrecoverable runtime error has occurred.
The client should destroy the session after receiving this event.
</description>
</event>
<request name="create_frame">
<description summary="create a frame">
Create a capture frame for this session.
At most one frame object can exist for a given session at any time. If
a client sends a create_frame request before a previous frame object
has been destroyed, the duplicate_frame protocol error is raised.
</description>
<arg name="frame" type="new_id" interface="ext_image_copy_capture_frame_v1"/>
</request>
<request name="destroy" type="destructor">
<description summary="delete this object">
Destroys the session. This request can be sent at any time by the
client.
This request doesn't affect ext_image_copy_capture_frame_v1 objects created by
this object.
</description>
</request>
</interface>
<interface name="ext_image_copy_capture_frame_v1" version="1">
<description summary="image capture frame">
This object represents an image capture frame.
The client should attach a buffer, damage the buffer, and then send a
capture request.
If the capture is successful, the compositor must send the frame metadata
(transform, damage, presentation_time in any order) followed by the ready
event.
If the capture fails, the compositor must send the failed event.
</description>
<enum name="error">
<entry name="no_buffer" value="1" summary="capture sent without attach_buffer"/>
<entry name="invalid_buffer_damage" value="2" summary="invalid buffer damage"/>
<entry name="already_captured" value="3" summary="capture request has been sent"/>
</enum>
<request name="destroy" type="destructor">
<description summary="destroy this object">
Destroys the frame. This request can be sent at any time by the
client.
</description>
</request>
<request name="attach_buffer">
<description summary="attach buffer to session">
Attach a buffer to the session.
The wl_buffer.release request is unused.
The new buffer replaces any previously attached buffer.
This request must not be sent after capture, or else the
already_captured protocol error is raised.
</description>
<arg name="buffer" type="object" interface="wl_buffer"/>
</request>
<request name="damage_buffer">
<description summary="damage buffer">
Apply damage to the buffer which is to be captured next. This request
may be sent multiple times to describe a region.
The client indicates the accumulated damage since this wl_buffer was
last captured. During capture, the compositor will update the buffer
with at least the union of the region passed by the client and the
region advertised by ext_image_copy_capture_frame_v1.damage.
When a wl_buffer is captured for the first time, or when the client
doesn't track damage, the client must damage the whole buffer.
This is for optimisation purposes. The compositor may use this
information to reduce copying.
These coordinates originate from the upper left corner of the buffer.
If x or y are strictly negative, or if width or height are negative or
zero, the invalid_buffer_damage protocol error is raised.
This request must not be sent after capture, or else the
already_captured protocol error is raised.
</description>
<arg name="x" type="int" summary="region x coordinate"/>
<arg name="y" type="int" summary="region y coordinate"/>
<arg name="width" type="int" summary="region width"/>
<arg name="height" type="int" summary="region height"/>
</request>
<request name="capture">
<description summary="capture a frame">
Capture a frame.
Unless this is the first successful captured frame performed in this
session, the compositor may wait an indefinite amount of time for the
source content to change before performing the copy.
This request may only be sent once, or else the already_captured
protocol error is raised. A buffer must be attached before this request
is sent, or else the no_buffer protocol error is raised.
</description>
</request>
<event name="transform">
<description summary="buffer transform">
This event is sent before the ready event and holds the transform that
the compositor has applied to the buffer contents.
</description>
<arg name="transform" type="uint" enum="wl_output.transform"/>
</event>
<event name="damage">
<description summary="buffer damaged region">
This event is sent before the ready event. It may be generated multiple
times to describe a region.
The first captured frame in a session will always carry full damage.
Subsequent frames' damaged regions describe which parts of the buffer
have changed since the last ready event.
These coordinates originate in the upper left corner of the buffer.
</description>
<arg name="x" type="int" summary="damage x coordinate"/>
<arg name="y" type="int" summary="damage y coordinate"/>
<arg name="width" type="int" summary="damage width"/>
<arg name="height" type="int" summary="damage height"/>
</event>
<event name="presentation_time">
<description summary="presentation time of the frame">
This event indicates the time at which the frame is presented to the
output in system monotonic time. This event is sent before the ready
event.
The timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples,
each component being an unsigned 32-bit value. Whole seconds are in
tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo,
and the additional fractional part in tv_nsec as nanoseconds. Hence,
for valid timestamps tv_nsec must be in [0, 999999999].
</description>
<arg name="tv_sec_hi" type="uint"
summary="high 32 bits of the seconds part of the timestamp"/>
<arg name="tv_sec_lo" type="uint"
summary="low 32 bits of the seconds part of the timestamp"/>
<arg name="tv_nsec" type="uint"
summary="nanoseconds part of the timestamp"/>
</event>
<event name="ready">
<description summary="frame is available for reading">
Called as soon as the frame is copied, indicating it is available
for reading.
The buffer may be re-used by the client after this event.
After receiving this event, the client must destroy the object.
</description>
</event>
<enum name="failure_reason">
<entry name="unknown" value="0">
<description summary="unknown runtime error">
An unspecified runtime error has occurred. The client may retry.
</description>
</entry>
<entry name="buffer_constraints" value="1">
<description summary="buffer constraints mismatch">
The buffer submitted by the client doesn't match the latest session
constraints. The client should re-allocate its buffers and retry.
</description>
</entry>
<entry name="stopped" value="2">
<description summary="session is no longer available">
The session has stopped. See ext_image_copy_capture_session_v1.stopped.
</description>
</entry>
</enum>
<event name="failed">
<description summary="capture failed">
This event indicates that the attempted frame copy has failed.
After receiving this event, the client must destroy the object.
</description>
<arg name="reason" type="uint" enum="failure_reason"/>
</event>
</interface>
<interface name="ext_image_copy_capture_cursor_session_v1" version="1">
<description summary="cursor capture session">
This object represents a cursor capture session. It extends the base
capture session with cursor-specific metadata.
</description>
<enum name="error">
<entry name="duplicate_session" value="1" summary="get_capture_session sent twice"/>
</enum>
<request name="destroy" type="destructor">
<description summary="delete this object">
Destroys the session. This request can be sent at any time by the
client.
This request doesn't affect ext_image_copy_capture_frame_v1 objects created by
this object.
</description>
</request>
<request name="get_capture_session">
<description summary="get image copy capturer session">
Gets the image copy capture session for this cursor session.
The session will produce frames of the cursor image. The compositor may
pause the session when the cursor leaves the captured area.
This request must not be sent more than once, or else the
duplicate_session protocol error is raised.
</description>
<arg name="session" type="new_id" interface="ext_image_copy_capture_session_v1"/>
</request>
<event name="enter">
<description summary="cursor entered captured area">
Sent when a cursor enters the captured area. It shall be generated
before the "position" and "hotspot" events when and only when a cursor
enters the area.
The cursor enters the captured area when the cursor image intersects
with the captured area. Note, this is different from e.g.
wl_pointer.enter.
</description>
</event>
<event name="leave">
<description summary="cursor left captured area">
Sent when a cursor leaves the captured area. No "position" or "hotspot"
event is generated for the cursor until the cursor enters the captured
area again.
</description>
</event>
<event name="position">
<description summary="position changed">
Cursors outside the image capture source do not get captured and no
event will be generated for them.
The given position is the position of the cursor's hotspot and it is
relative to the main buffer's top left corner in transformed buffer
pixel coordinates. The coordinates may be negative or greater than the
main buffer size.
</description>
<arg name="x" type="int" summary="position x coordinates"/>
<arg name="y" type="int" summary="position y coordinates"/>
</event>
<event name="hotspot">
<description summary="hotspot changed">
The hotspot describes the offset between the cursor image and the
position of the input device.
The given coordinates are the hotspot's offset from the origin in
buffer coordinates.
Clients should not apply the hotspot immediately: the hotspot becomes
effective when the next ext_image_copy_capture_frame_v1.ready event is received.
Compositors may delay this event until the client captures a new frame.
</description>
<arg name="x" type="int" summary="hotspot x coordinates"/>
<arg name="y" type="int" summary="hotspot y coordinates"/>
</event>
</interface>
</protocol>
@@ -1,232 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="wlr_screencopy_unstable_v1">
<copyright>
Copyright © 2018 Simon Ser
Copyright © 2019 Andri Yngvason
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
</copyright>
<description summary="screen content capturing on client buffers">
This protocol allows clients to ask the compositor to copy part of the
screen content to a client buffer.
Warning! The protocol described in this file is experimental and
backward incompatible changes may be made. Backward compatible changes
may be added together with the corresponding interface version bump.
Backward incompatible changes are done by bumping the version number in
the protocol and interface names and resetting the interface version.
Once the protocol is to be declared stable, the 'z' prefix and the
version number in the protocol and interface names are removed and the
interface version number is reset.
</description>
<interface name="zwlr_screencopy_manager_v1" version="3">
<description summary="manager to inform clients and begin capturing">
This object is a manager which offers requests to start capturing from a
source.
</description>
<request name="capture_output">
<description summary="capture an output">
Capture the next frame of an entire output.
</description>
<arg name="frame" type="new_id" interface="zwlr_screencopy_frame_v1"/>
<arg name="overlay_cursor" type="int"
summary="composite cursor onto the frame"/>
<arg name="output" type="object" interface="wl_output"/>
</request>
<request name="capture_output_region">
<description summary="capture an output's region">
Capture the next frame of an output's region.
The region is given in output logical coordinates, see
xdg_output.logical_size. The region will be clipped to the output's
extents.
</description>
<arg name="frame" type="new_id" interface="zwlr_screencopy_frame_v1"/>
<arg name="overlay_cursor" type="int"
summary="composite cursor onto the frame"/>
<arg name="output" type="object" interface="wl_output"/>
<arg name="x" type="int"/>
<arg name="y" type="int"/>
<arg name="width" type="int"/>
<arg name="height" type="int"/>
</request>
<request name="destroy" type="destructor">
<description summary="destroy the manager">
All objects created by the manager will still remain valid, until their
appropriate destroy request has been called.
</description>
</request>
</interface>
<interface name="zwlr_screencopy_frame_v1" version="3">
<description summary="a frame ready for copy">
This object represents a single frame.
When created, a series of buffer events will be sent, each representing a
supported buffer type. The "buffer_done" event is sent afterwards to
indicate that all supported buffer types have been enumerated. The client
will then be able to send a "copy" request. If the capture is successful,
the compositor will send a "flags" followed by a "ready" event.
For objects version 2 or lower, wl_shm buffers are always supported, ie.
the "buffer" event is guaranteed to be sent.
If the capture failed, the "failed" event is sent. This can happen anytime
before the "ready" event.
Once either a "ready" or a "failed" event is received, the client should
destroy the frame.
</description>
<event name="buffer">
<description summary="wl_shm buffer information">
Provides information about wl_shm buffer parameters that need to be
used for this frame. This event is sent once after the frame is created
if wl_shm buffers are supported.
</description>
<arg name="format" type="uint" enum="wl_shm.format" summary="buffer format"/>
<arg name="width" type="uint" summary="buffer width"/>
<arg name="height" type="uint" summary="buffer height"/>
<arg name="stride" type="uint" summary="buffer stride"/>
</event>
<request name="copy">
<description summary="copy the frame">
Copy the frame to the supplied buffer. The buffer must have a the
correct size, see zwlr_screencopy_frame_v1.buffer and
zwlr_screencopy_frame_v1.linux_dmabuf. The buffer needs to have a
supported format.
If the frame is successfully copied, a "flags" and a "ready" events are
sent. Otherwise, a "failed" event is sent.
</description>
<arg name="buffer" type="object" interface="wl_buffer"/>
</request>
<enum name="error">
<entry name="already_used" value="0"
summary="the object has already been used to copy a wl_buffer"/>
<entry name="invalid_buffer" value="1"
summary="buffer attributes are invalid"/>
</enum>
<enum name="flags" bitfield="true">
<entry name="y_invert" value="1" summary="contents are y-inverted"/>
</enum>
<event name="flags">
<description summary="frame flags">
Provides flags about the frame. This event is sent once before the
"ready" event.
</description>
<arg name="flags" type="uint" enum="flags" summary="frame flags"/>
</event>
<event name="ready">
<description summary="indicates frame is available for reading">
Called as soon as the frame is copied, indicating it is available
for reading. This event includes the time at which presentation happened
at.
The timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples,
each component being an unsigned 32-bit value. Whole seconds are in
tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo,
and the additional fractional part in tv_nsec as nanoseconds. Hence,
for valid timestamps tv_nsec must be in [0, 999999999]. The seconds part
may have an arbitrary offset at start.
After receiving this event, the client should destroy the object.
</description>
<arg name="tv_sec_hi" type="uint"
summary="high 32 bits of the seconds part of the timestamp"/>
<arg name="tv_sec_lo" type="uint"
summary="low 32 bits of the seconds part of the timestamp"/>
<arg name="tv_nsec" type="uint"
summary="nanoseconds part of the timestamp"/>
</event>
<event name="failed">
<description summary="frame copy failed">
This event indicates that the attempted frame copy has failed.
After receiving this event, the client should destroy the object.
</description>
</event>
<request name="destroy" type="destructor">
<description summary="delete this object, used or not">
Destroys the frame. This request can be sent at any time by the client.
</description>
</request>
<!-- Version 2 additions -->
<request name="copy_with_damage" since="2">
<description summary="copy the frame when it's damaged">
Same as copy, except it waits until there is damage to copy.
</description>
<arg name="buffer" type="object" interface="wl_buffer"/>
</request>
<event name="damage" since="2">
<description summary="carries the coordinates of the damaged region">
This event is sent right before the ready event when copy_with_damage is
requested. It may be generated multiple times for each copy_with_damage
request.
The arguments describe a box around an area that has changed since the
last copy request that was derived from the current screencopy manager
instance.
The union of all regions received between the call to copy_with_damage
and a ready event is the total damage since the prior ready event.
</description>
<arg name="x" type="uint" summary="damaged x coordinates"/>
<arg name="y" type="uint" summary="damaged y coordinates"/>
<arg name="width" type="uint" summary="current width"/>
<arg name="height" type="uint" summary="current height"/>
</event>
<!-- Version 3 additions -->
<event name="linux_dmabuf" since="3">
<description summary="linux-dmabuf buffer information">
Provides information about linux-dmabuf buffer parameters that need to
be used for this frame. This event is sent once after the frame is
created if linux-dmabuf buffers are supported.
</description>
<arg name="format" type="uint" summary="fourcc pixel format"/>
<arg name="width" type="uint" summary="buffer width"/>
<arg name="height" type="uint" summary="buffer height"/>
</event>
<event name="buffer_done" since="3">
<description summary="all buffer types reported">
This event is sent once after all buffer events have been sent.
The client should proceed to create a buffer of one of the supported
types, and send a "copy" request.
</description>
</event>
</interface>
</protocol>
@@ -1,7 +0,0 @@
{
"window_ms": 10000.0,
"system_cpu_ms": 19910.0,
"compositor_cpu_ms": 9410.0,
"system_cpu_pct": 199.1,
"compositor_cpu_pct": 94.1
}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol ext-image-copy-capture-v1 (auto) mode jpeg target hh-chromium-gqkxz3 warmup 10 frames 200
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-chromium-gqkxz3@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 1280x720 bytes 107323 nonzero 105292
grimrs-capture: warmup 2/10 1280x720 bytes 107216 nonzero 105204
grimrs-capture: warmup 3/10 1280x720 bytes 107519 nonzero 105455
grimrs-capture: warmup 4/10 1280x720 bytes 107392 nonzero 105283
grimrs-capture: warmup 5/10 1280x720 bytes 107375 nonzero 105312
grimrs-capture: warmup 6/10 1280x720 bytes 107218 nonzero 105189
grimrs-capture: warmup 7/10 1280x720 bytes 107174 nonzero 105173
grimrs-capture: warmup 8/10 1280x720 bytes 107452 nonzero 105421
grimrs-capture: warmup 9/10 1280x720 bytes 107291 nonzero 105238
grimrs-capture: warmup 10/10 1280x720 bytes 107452 nonzero 105382
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"ext-image-copy-capture-v1 (auto)","output":"hh-chromium-gqkxz3","geometry":[1280,720],"mode":"jpeg","warmup":10,"frames":200,"frame_ms":{"min":61.074,"p50":124.039,"mean":132.54,"p95":198.748,"max":254.625},"fps_sustained":7.545,"wall_ms":26508.219,"cpu_ms_per_frame":6.6,"bytes_p50":107205.5,"persistent":true,"rss_peak_mb":746.25,"rss_peak_kb_raw":764156,"system_cpu_ms_per_frame":264.3,"compositor_cpu_ms_per_frame":123.1,"machine_cpu_pct":199.4,"frames_bytes_allocated_p50":3686400,"notes":"grim-rs 0.2.0 via Grim::new() (auto-detect); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-chromium-gqkxz3@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 105382."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol ext-image-copy-capture-v1 (auto) mode jpeg target hh-chromium-gqkxz3 warmup 10 frames 200
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-chromium-gqkxz3@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 1280x720 bytes 107394 nonzero 105367
grimrs-capture: warmup 2/10 1280x720 bytes 107137 nonzero 105116
grimrs-capture: warmup 3/10 1280x720 bytes 107298 nonzero 105216
grimrs-capture: warmup 4/10 1280x720 bytes 107092 nonzero 105064
grimrs-capture: warmup 5/10 1280x720 bytes 107031 nonzero 105045
grimrs-capture: warmup 6/10 1280x720 bytes 107334 nonzero 105280
grimrs-capture: warmup 7/10 1280x720 bytes 107182 nonzero 105134
grimrs-capture: warmup 8/10 1280x720 bytes 107395 nonzero 105345
grimrs-capture: warmup 9/10 1280x720 bytes 107333 nonzero 105326
grimrs-capture: warmup 10/10 1280x720 bytes 107105 nonzero 105080
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"ext-image-copy-capture-v1 (auto)","output":"hh-chromium-gqkxz3","geometry":[1280,720],"mode":"jpeg","warmup":10,"frames":200,"frame_ms":{"min":59.907,"p50":125.214,"mean":135.259,"p95":207.095,"max":324.014},"fps_sustained":7.393,"wall_ms":27051.989,"cpu_ms_per_frame":6.595,"bytes_p50":107203.5,"persistent":true,"rss_peak_mb":746.34,"rss_peak_kb_raw":764256,"system_cpu_ms_per_frame":269.1,"compositor_cpu_ms_per_frame":123.05,"machine_cpu_pct":199.0,"frames_bytes_allocated_p50":3686400,"notes":"grim-rs 0.2.0 via Grim::new() (auto-detect); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-chromium-gqkxz3@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 105080."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol ext-image-copy-capture-v1 (auto) mode raw target hh-chromium-gqkxz3 warmup 10 frames 200
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-chromium-gqkxz3@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 2/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 3/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 4/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 5/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 6/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 7/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 8/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 9/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 10/10 1280x720 bytes 3686400 nonzero 3679565
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"ext-image-copy-capture-v1 (auto)","output":"hh-chromium-gqkxz3","geometry":[1280,720],"mode":"raw","warmup":10,"frames":200,"frame_ms":{"min":44.16,"p50":122.21,"mean":130.086,"p95":189.49,"max":226.412},"fps_sustained":7.687,"wall_ms":26017.423,"cpu_ms_per_frame":1.628,"bytes_p50":null,"persistent":true,"rss_peak_mb":746.09,"rss_peak_kb_raw":763992,"system_cpu_ms_per_frame":258.6,"compositor_cpu_ms_per_frame":120.85,"machine_cpu_pct":198.8,"frames_bytes_allocated_p50":3686400,"notes":"grim-rs 0.2.0 via Grim::new() (auto-detect); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-chromium-gqkxz3@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 3679565."}
@@ -1,12 +0,0 @@
grimrs-capture: route grim-rs protocol ext-image-copy-capture-v1 (auto) mode raw target hh-chromium-gqkxz3 warmup 10 frames 200
grimrs-capture: outputs Virtual-1@0,0 1280x720 scale 1; hh-chromium-gqkxz3@1280,0 1280x720 scale 1
grimrs-capture: warmup 1/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 2/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 3/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 4/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 5/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 6/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 7/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 8/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 9/10 1280x720 bytes 3686400 nonzero 3679565
grimrs-capture: warmup 10/10 1280x720 bytes 3686400 nonzero 3679565
@@ -1 +0,0 @@
{"route":"grim-rs","language":"rust","protocol":"ext-image-copy-capture-v1 (auto)","output":"hh-chromium-gqkxz3","geometry":[1280,720],"mode":"raw","warmup":10,"frames":200,"frame_ms":{"min":46.164,"p50":117.913,"mean":125.337,"p95":194.097,"max":255.125},"fps_sustained":7.978,"wall_ms":25067.547,"cpu_ms_per_frame":1.551,"bytes_p50":null,"persistent":true,"rss_peak_mb":746.02,"rss_peak_kb_raw":763924,"system_cpu_ms_per_frame":249.6,"compositor_cpu_ms_per_frame":117.6,"machine_cpu_pct":199.1,"frames_bytes_allocated_p50":3686400,"notes":"grim-rs 0.2.0 via Grim::new() (auto-detect); copy target is a wl_shm buffer created inside each capture_* call, not a dma-buf the producer imports. Cursor not overlaid (the frozen argv has no cursor flag; hhstream-live's grim command passes -c). JPEG is Grim::to_jpeg, quality 80, the crate default and the live-stream setting. Raw timer stops when capture_* returns, which is after the crate copies the mapping into a Vec and swizzles XRGB/ARGB to RGBA (and applies any output transform or y-invert). The public API does not expose the mapped buffer before that, so raw includes work the contract says to leave outside the timer. Percentiles are linear interpolation on the sorted samples. cpu_ms_per_frame is getrusage(RUSAGE_SELF) utime+stime over the measured loop only, divided by frames. Frame buffers are freed between frames; that free is inside wall_ms and outside frame_ms. Outputs: Virtual-1@0,0 1280x720 scale 1; hh-chromium-gqkxz3@1280,0 1280x720 scale 1. No GPU on this machine; dma-buf was not used and is not claimed. This process does not move the pointer and does not start or stop a session; the pixels are whatever the compositor is already showing. Last warmup frame nonzero bytes: 3679565."}
Whitespace-only changes.
@@ -1 +0,0 @@
{"route": "grim-subprocess", "language": "python", "protocol": "zwlr-screencopy-v1 (grim's client)", "output": "hh-chromium-gqkxz3", "geometry": [1280, 720], "mode": "jpeg", "warmup": 10, "frames": 200, "frame_ms": {"min": 58.928, "p50": 116.179, "mean": 121.352, "p95": 164.512, "max": 200.886}, "fps_sustained": 8.24, "wall_ms": 24614.05, "bytes_p50": 130597, "persistent": false, "notes": "one grim process per frame, fork and encode inside the timed span; territory: --output; jpeg q80", "cpu_ms_per_frame": 5.005, "rss_peak_mb": 18.47, "rss_peak_kb_raw": 18916, "system_cpu_ms_per_frame": 245.05, "compositor_cpu_ms_per_frame": 115.05, "machine_cpu_pct": 199.1, "machine_cpu_pct_of_all_cores": 99.6, "frames_bytes_allocated_p50": null, "resource_notes": ""}
Whitespace-only changes.
@@ -1 +0,0 @@
{"route": "grim-subprocess", "language": "python", "protocol": "zwlr-screencopy-v1 (grim's client)", "output": "hh-chromium-gqkxz3", "geometry": [1280, 720], "mode": "jpeg", "warmup": 10, "frames": 200, "frame_ms": {"min": 67.203, "p50": 118.52, "mean": 124.224, "p95": 185.591, "max": 299.044}, "fps_sustained": 8.05, "wall_ms": 25182.14, "bytes_p50": 130590, "persistent": false, "notes": "one grim process per frame, fork and encode inside the timed span; territory: --output; jpeg q80", "cpu_ms_per_frame": 5.05, "rss_peak_mb": 18.45, "rss_peak_kb_raw": 18896, "system_cpu_ms_per_frame": 250.75, "compositor_cpu_ms_per_frame": 117.75, "machine_cpu_pct": 199.1, "machine_cpu_pct_of_all_cores": 99.6, "frames_bytes_allocated_p50": null, "resource_notes": ""}
Whitespace-only changes.
@@ -1 +0,0 @@
{"route": "grim-subprocess", "language": "python", "protocol": "zwlr-screencopy-v1 (grim's client)", "output": "hh-chromium-gqkxz3", "geometry": [1280, 720], "mode": "raw", "warmup": 10, "frames": 200, "frame_ms": {"min": 51.756, "p50": 120.321, "mean": 125.705, "p95": 190.299, "max": 253.325}, "fps_sustained": 7.96, "wall_ms": 25452.51, "bytes_p50": 2764816, "persistent": false, "notes": "one grim process per frame, fork and encode inside the timed span; territory: --output; ppm, unencoded", "cpu_ms_per_frame": 3.856, "rss_peak_mb": 20.56, "rss_peak_kb_raw": 21052, "system_cpu_ms_per_frame": 253.8, "compositor_cpu_ms_per_frame": 118.55, "machine_cpu_pct": 199.4, "machine_cpu_pct_of_all_cores": 99.7, "frames_bytes_allocated_p50": 3686400, "resource_notes": ""}
Whitespace-only changes.
@@ -1 +0,0 @@
{"route": "grim-subprocess", "language": "python", "protocol": "zwlr-screencopy-v1 (grim's client)", "output": "hh-chromium-gqkxz3", "geometry": [1280, 720], "mode": "raw", "warmup": 10, "frames": 200, "frame_ms": {"min": 64.061, "p50": 122.389, "mean": 127.307, "p95": 196.38, "max": 264.387}, "fps_sustained": 7.86, "wall_ms": 25757.6, "bytes_p50": 2764816, "persistent": false, "notes": "one grim process per frame, fork and encode inside the timed span; territory: --output; ppm, unencoded", "cpu_ms_per_frame": 3.858, "rss_peak_mb": 20.51, "rss_peak_kb_raw": 21004, "system_cpu_ms_per_frame": 256.65, "compositor_cpu_ms_per_frame": 118.25, "machine_cpu_pct": 199.3, "machine_cpu_pct_of_all_cores": 99.6, "frames_bytes_allocated_p50": 3686400, "resource_notes": ""}
Whitespace-only changes.
@@ -1 +0,0 @@
{"route": "pywayland-in-process", "language": "python", "protocol": "ext-image-copy-capture-v1", "output": "hh-chromium-gqkxz3", "geometry": [1280, 720], "mode": "jpeg", "warmup": 10, "frames": 200, "frame_ms": {"min": 30.44, "p50": 76.633, "mean": 71.153, "p95": 103.055, "max": 185.942}, "stage_ms": {"capture": 68.35, "encode": 2.708, "stitch": 0.0}, "fps_sustained": 14.05, "wall_ms": 14231.13, "bytes_p50": 105794, "persistent": true, "notes": "one connection, buffers reused, turbojpeg q80 in-process; 1 output(s); forcing a repaint per frame", "cpu_ms_per_frame": 1.811, "rss_peak_mb": 28.99, "rss_peak_kb_raw": 29688, "system_cpu_ms_per_frame": 141.75, "compositor_cpu_ms_per_frame": 66.55, "machine_cpu_pct": 199.2, "machine_cpu_pct_of_all_cores": 99.6, "frames_bytes_allocated_p50": 3686400, "resource_notes": ""}
Whitespace-only changes.
@@ -1 +0,0 @@
{"route": "pywayland-in-process", "language": "python", "protocol": "ext-image-copy-capture-v1", "output": "hh-chromium-gqkxz3", "geometry": [1280, 720], "mode": "jpeg", "warmup": 10, "frames": 200, "frame_ms": {"min": 38.593, "p50": 78.693, "mean": 71.507, "p95": 96.637, "max": 129.106}, "stage_ms": {"capture": 69.115, "encode": 2.339, "stitch": 0.0}, "fps_sustained": 13.98, "wall_ms": 14301.79, "bytes_p50": 105804, "persistent": true, "notes": "one connection, buffers reused, turbojpeg q80 in-process; 1 output(s); forcing a repaint per frame", "cpu_ms_per_frame": 1.776, "rss_peak_mb": 29.25, "rss_peak_kb_raw": 29956, "system_cpu_ms_per_frame": 142.65, "compositor_cpu_ms_per_frame": 67.9, "machine_cpu_pct": 199.5, "machine_cpu_pct_of_all_cores": 99.7, "frames_bytes_allocated_p50": 3686400, "resource_notes": ""}
Whitespace-only changes.
@@ -1 +0,0 @@
{"route": "pywayland-in-process", "language": "python", "protocol": "ext-image-copy-capture-v1", "output": "hh-chromium-gqkxz3", "geometry": [1280, 720], "mode": "raw", "warmup": 10, "frames": 200, "frame_ms": {"min": 22.685, "p50": 71.372, "mean": 69.708, "p95": 89.816, "max": 121.781}, "stage_ms": {"capture": 69.698, "encode": 0.0, "stitch": 0.0}, "fps_sustained": 14.35, "wall_ms": 13941.78, "bytes_p50": null, "persistent": true, "notes": "one connection, buffers reused, turbojpeg q80 in-process; 1 output(s); forcing a repaint per frame", "cpu_ms_per_frame": 0.311, "rss_peak_mb": 24.43, "rss_peak_kb_raw": 25020, "system_cpu_ms_per_frame": 138.6, "compositor_cpu_ms_per_frame": 65.85, "machine_cpu_pct": 198.8, "machine_cpu_pct_of_all_cores": 99.4, "frames_bytes_allocated_p50": 3686400, "resource_notes": ""}
Whitespace-only changes.
@@ -1 +0,0 @@
{"route": "pywayland-in-process", "language": "python", "protocol": "ext-image-copy-capture-v1", "output": "hh-chromium-gqkxz3", "geometry": [1280, 720], "mode": "raw", "warmup": 10, "frames": 200, "frame_ms": {"min": 41.241, "p50": 75.703, "mean": 69.499, "p95": 86.611, "max": 112.812}, "stage_ms": {"capture": 69.489, "encode": 0.0, "stitch": 0.0}, "fps_sustained": 14.39, "wall_ms": 13899.94, "bytes_p50": null, "persistent": true, "notes": "one connection, buffers reused, turbojpeg q80 in-process; 1 output(s); forcing a repaint per frame", "cpu_ms_per_frame": 0.318, "rss_peak_mb": 24.52, "rss_peak_kb_raw": 25112, "system_cpu_ms_per_frame": 138.35, "compositor_cpu_ms_per_frame": 66.45, "machine_cpu_pct": 199.1, "machine_cpu_pct_of_all_cores": 99.5, "frames_bytes_allocated_p50": 3686400, "resource_notes": ""}
Loaded 100 of 327 files, more files were not shown because too many files have changed in this diff. Show more