enricobuehlerandClaude Opus 5
c801465469
The docs already told users where to get it — the Bazzite sysext, an Arch package, a NixOS option — and none of the three were true. `rpm.yml` built the sysext without ever passing `--gamescope`, `arch.yml` did not know the PKGBUILD existed, and the nix derivation had never been evaluated once. Evaluating it found its central assumption wrong: `gamescope.unwrapped` does not exist on current nixpkgs, where `gamescope` IS the buildable derivation, so the override threw on every build. It now prefers `.unwrapped` where a future nixpkgs wraps it and checks the RESULT is patchable — `overrideAttrs` on a symlinkJoin succeeds and does nothing, which would install an UNPATCHED gamescope under a name the host reads as a promise of HDR. Both it and the PKGBUILD had also drifted to a stale patch list: two patches named where three exist, one of them under the level-1 filename retired when the cursor patch landed. Both read the patch directory now, so the list cannot go stale again. The PKGBUILD additionally delegates the whole build to `build-punktfunk-gamescope.sh` rather than re-deriving the meson invocation — its copy had already lost `force_fallback_for=wlroots`, and unlike Fedora 43, Arch ships wlroots, so that package would have linked it shared and shipped a binary that starts only on machines carrying the dev library. It asserts its own pinned rev matches the script's, the one thing makepkg needs statically. Both CI builds are cached on `packaging/gamescope/**`, which is the only reason this is affordable: that tree depends on nothing else in the repo, so a normal push restores a binary instead of spending ten minutes on someone else's C++. And both are best-effort. punktfunk works without this binary — SDR on the gamescope backend, which is what every release before this one did — so a hiccup building gamescope must not cost the packages those workflows exist to publish. A failure warns and is never cached, so the next run retries. `rpm.yml` also installs Fedora's own gamescope for its runtime libraries: the sysext verifies our binary by executing `--version`, and on a cache hit nothing else in the job would have pulled libavif/luajit/seatd in. Verified by evaluating and patch-phase-building the nix derivation against nixos-unstable: all three patches apply to nixpkgs' already-patched 3.16.25 tree, and the banner stamps +pfhdr2. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
8.8 KiB
punktfunk-gamescope — gamescope with 10-bit HDR PipeWire capture
Upstream gamescope's built-in PipeWire node is SDR-only: build_format_params() offers BGRx
and NV12, and paint_pipewire() hardcodes a Gamma-2.2 composite with the SDR screenshot LUT
set. An HDR game therefore reaches every capture consumer already tone-mapped down — which is
why the punktfunk gamescope backend has always streamed 8-bit, even though games can render
HDR on a headless gamescope today (--hdr-enabled --hdr-debug-force-support).
The patches here add the missing half, and nothing else. See
punktfunk-planning/design/gamescope-hdr-virtual-output.md for the full design.
| Patch | What | Upstream? |
|---|---|---|
0001-pipewire-offer-10-bit-BT.2020-PQ-capture-formats-HDR.patch |
Offer SPA xRGB_210LE/xBGR_210LE with MANDATORY SMPTE ST.2084 + BT.2020 props, map them to DRM_FORMAT_XRGB2101010/XBGR2101010, and composite them with g_ScreenshotColorMgmtLutsHDR + EOTF_PQ |
Yes — offered against gamescope#2126 |
0002-pipewire-optionally-composite-the-cursor-into-the-ca.patch |
--pipewire-composite-cursor (off by default): paint the pointer into the capture stream, using the same MouseCursor::paint call the scanout composite uses |
Yes — independently useful to any consumer with no cursor of its own |
0003-punktfunk-stamp-the-version-banner-with-pfhdrN.patch |
Append +pfhdr<N> to the --version banner |
No — ours only, retired when the two above land upstream |
Why the cursor patch matters more than it looks
gamescope keeps the pointer out of its PipeWire node — it lives on a hardware plane for scanout —
so punktfunk has always reconstructed it from XFixes and blended it into every frame host-side.
That blend is what forces the encode path onto its compute colour-conversion arm: the zero-copy
RGB-direct encode source (VK_VALVE_video_encode_rgb_conversion) hands the captured buffer to a
fixed-function front end with no blend stage. Painting the cursor into the node removes the reason
for the blend, and with it a full-frame pass per frame — a gamescope session becomes the first one
that can be genuinely zero-copy end to end.
Why the marker exists
punktfunk decides a session's shape before the virtual display exists: the bit depth at
handshake time (irrevocable — a PQ stream handed to an 8-bit encoder is a deliberate hard error),
and whether the host must composite the cursor before the encoder is even opened. Both answers
must therefore be static properties of the resolved binary, not optimistic negotiations. The host
runs <gamescope> --version once per boot and reads the revision — see gamescope_patch_level()
in crates/pf-vdisplay/src/vdisplay/linux/gamescope/discovery.rs.
The number is a monotonic patch-set revision, so one probe answers every capability:
| Level | Adds |
|---|---|
+pfhdr1 |
10-bit BT.2020/PQ capture formats |
+pfhdr2 |
…and --pipewire-composite-cursor |
Bump it whenever a patch adds or changes something the host must know about before it spawns.
⚠️ The two indirect spawn modes (the GAMESCOPE_BIN wrapper for gamescope-session-plus, and the
SteamOS PATH shim) pass these flags through PF_HDR_ARGS, so they share one dependency: if the
session ignores GAMESCOPE_BIN/PATH and execs the distro's gamescope, it gets neither the HDR
formats nor the cursor flag. HDR fails loudly there (the capture negotiation times out and latches
an SDR downgrade) — but a missing cursor would be silent, because the host was told the compositor
would paint the pointer and so painted none itself.
Both managed paths therefore verify after spawn: once the session's node appears,
verify_managed_spawn_flags reads the running compositor's /proc/<pid>/cmdline and refuses the
session if a flag we passed isn't there. The plan is fixed by then (cursor_blend feeds the encoder
open, which precedes the display), so the session cannot be corrected in place — instead the
capability is latched off for the process and the spawn fails, and the retry resolves a correct SDR
host-composited session. One rejected attempt per boot, then it converges.
The check fails open at every ambiguity: no flags expected, or no readable gamescope in
/proc, says nothing. Only a compositor we can see, missing a flag we can name, fails.
Which binary the host runs
Resolution order, applied identically by the bare spawn, the GAMESCOPE_BIN wrapper
(gamescope-session-plus) and the SteamOS PATH shim:
PUNKTFUNK_GAMESCOPE_BIN— absolute path overridepunktfunk-gamescopeonPATHgamescope
So installing this build under the name punktfunk-gamescope is enough; nothing replaces the
distro's gamescope.
Building
Pinned upstream: 8c676c39 (master, 2026-07-27 — tags through 3.16.25). The patches apply
cleanly to that commit; they touch src/pipewire.cpp, src/steamcompmgr.cpp and
src/meson.build only.
git clone https://github.com/ValveSoftware/gamescope.git
cd gamescope
git checkout 8c676c39
git submodule update --init --recursive # or let meson fetch the subprojects
git am /path/to/punktfunk/packaging/gamescope/patches/*.patch
meson setup build/ --prefix=/usr -Dpipewire=enabled
ninja -C build/
# install as punktfunk-gamescope, NOT as gamescope
install -Dm755 build/src/gamescope /usr/bin/punktfunk-gamescope
Build dependencies
They are gamescope's, not ours, and they vary by distro. Two shortcuts that work:
# Fedora / Bazzite (inside a toolbox/distrobox — the host is immutable)
sudo dnf install -y dnf-plugins-core meson ninja-build glslc
sudo dnf builddep -y gamescope
sudo dnf install -y xorg-x11-server-Xwayland-devel # NOT pulled by builddep; wlroots needs it
# Arch / SteamOS — see the makedepends in ./PKGBUILD
⚠️ dnf builddep gamescope resolves Fedora's packaged gamescope, which is older than the master
we pin, so it can come up short. xorg-x11-server-Xwayland-devel is the one that actually bit
(2026-07-28, Fedora 43): without it wlroots' configure fails with Neither a subproject directory nor a xserver.wrap file was found, several minutes into an otherwise clean run. If a different
one surfaces, meson names it — install and re-run with --srcdir so the clone is not repeated.
gamescope needs CAP_SYS_NICE for its realtime priority; the distro packages set it on their
own binary. Mirror it if you install ours system-wide:
setcap 'CAP_SYS_NICE=eip' /usr/bin/punktfunk-gamescope
How each channel ships it
Four packaging paths, one build recipe — build-punktfunk-gamescope.sh — because the two things
that are easy to get wrong (which patches get applied, and whether wlroots is linked statically)
must not be decided twice.
| Channel | Built by | Notes |
|---|---|---|
| Bazzite / Fedora Atomic | .gitea/workflows/rpm.yml → build-sysext.sh --gamescope |
Inside the matching Fedora container, per major — the binary is soname-coupled to its base exactly like the RPM |
| Arch / SteamOS | .gitea/workflows/arch.yml → makepkg on ./PKGBUILD |
Its own pkgbase in the same pacman repo; pacman -S punktfunk-gamescope |
| NixOS | packaging/nix/gamescope.nix (an overrideAttrs on nixpkgs' gamescope) |
The one path that does NOT call the script — nixpkgs already solves the submodules, and a nix closure names every library it links |
| Anything else | the script, by hand | See Building above |
Both CI builds are cached on packaging/gamescope/** and best-effort. Cached because this
tree depends on nothing else in the repo, so a normal push restores a binary instead of spending
ten minutes on someone else's C++; best-effort because punktfunk works without it (SDR on the
gamescope backend, which is what every release before this one did) and a hiccup building gamescope
must not cost the packages those workflows exist to publish. A failed build emits a ::warning::
and is never cached, so the next run retries.
Note what is NOT in that table: the .deb. Debian/Ubuntu boxes build it by hand for now.
Verifying the patch on a box (P0 exit)
punktfunk-gamescope --version # must contain +pfhdr2
punktfunk-gamescope --backend headless -W 1920 -H 1080 -r 60 \
--hdr-enabled --hdr-debug-force-support --pipewire-composite-cursor -- vkcube &
pw-dump | grep -A40 '"gamescope"' # node offers xRGB_210LE / xBGR_210LE
The stream is only 10-bit once a consumer asks for it: the formats are listed last, so any consumer that negotiates the 8-bit stream today keeps negotiating it bit-for-bit.
Rebase policy
The functional patch is two files and mirrors code that already exists in-tree (the HDR AVIF screenshot path), so it rebases cheaply. We pin the gamescope commit we ship; when upstream takes it, both patches are dropped and the host's capability probe becomes a plain version floor.