WIP: docs(guide): recapture the Graphics menu image on main 936d4e00, its fixture stubbing the ReShade runtime #2095

Closed
HumanBean wants to merge 1 commit from HumanBean/Longshot:docs/guide-graphics-recapture into main
Owner

Summary

The "Guide screenshots / Guide images and local UI source review" check fails on main, and so on every open pull request: 16 of the files recorded for the Graphics menu image (docs/user/images/guide/settings-graphics.png) changed after the revision last reviewed for it, eee321b6. Its game-free capture fixture no longer built either. The ReShade menu module (#1861) calls ReShade runtime functions that scripts/screenshots/menu.cpp did not stub, so the link failed.

This pull request reviews each change and recaptures the image:

  • Fixture: scripts/screenshots/menu.cpp stubs the seven ReShade runtime calls the menu links against. The stubs list no user presets, give no status line and change no picture.

  • What changed in the image: I rendered eee321b6 and main 936d4e00 with the same toolchain. The two differ only in two places:

    • the version text;
    • the thumb of the Graphics scrollbar. It is now 172 px tall instead of 196 px, because the page gained rows below the visible area: the Post-processing heading with ReShade preset and Compare ReShade Preset (#1861), and Grass distance (#1382).
  • What did not change: the visible rows, labels, values, Quality preset help, tabs and keyboard prompts. The other changes are not drawn in this view: the help for Output resolution (#1859), the FPS counter details rows (#1657), the restart and preview dialogs, the translations, and the renderer and policy headers.

  • Recapture: because the scrollbar changed, the image is recaptured from main 936d4e00 with the fixed fixture.

  • Records: manifest.json now records:

    • the new capture and the same revision as reviewed;
    • all 130 source hashes, including six new dependencies the compiler found (gpu/vk/menu/reshade.{cpp,h}, gpu/vk/reshade/fx_{builtin,clarity,runtime}.h, gpu/vk/upscale_route.h);
    • the fixture hashes and the toolchain;
    • a note on the comparison.

    The guide's caption (docs/user/graphics-and-controls.md) and the images README name the new revision.

Read first: scripts/screenshots/menu.cpp (the stubs), then the settings-graphics.png entry in docs/user/images/guide/manifest.json.

Testing

Tested: Docs and the capture fixture only. The game does not run any of this, so I made no game run. On Linux (CachyOS, clang 23.1.4, sdl2-compat 2.32.74, libpng 1.6.59), I ran three game-free captures through the job queue in --mode light:

  • scripts/screenshots/capture_menu.py --views graphics at eee321b6, with that revision's own fixture;
  • the same capture on main 936d4e00, with this branch's fixture;
  • the same capture again from this branch's own commit, as a cross-check.

Pixel diffs:

  • eee321b6 against main: only the version text (x 1066–1260, y 25–38) and the scrollbar thumb (x 41–45, y 254–278) differ.
  • The main capture against this branch's capture: only the version text differs.

I looked at the new image myself. It shows no private path, no game asset and no saved state. python3 -I -B scripts/check_guide_screenshots.py --review-sources now prints no REVIEW REQUIRED. It still prints NOT CHECKED for the six Launcher images: they need --launcher-source, and the CI workflow doesn't pass it.

Still to test:

  • CI: the Guide screenshots workflow and the rest of mise run test on the head, expecting them to pass. I ran no test suite on this PC (by hand: read the CI result).
  • Rendered guide: build the website, then look at the Graphics guide page at desktop and 360–390 px width, in light and dark themes. Expect the new image to load and its caption to read "main 936d4e00 (after nightly 695)" (by hand).

Measurements

Nothing to measure: this changes a guide image, its records and the game-free capture fixture, none of which the game runs.

Risks

Nothing in the game or the player's files changes. The fixture's ReShade stubs exist only in the documentation capture build. A future ReShade runtime call the menu makes will fail the fixture's link the same way, so someone will notice it. The pixels of the new image differ throughout from the old one because the capture toolchain changed (from clang 18 and SDL 2.30 to clang 23 and sdl2-compat 2.32), but the UI it shows looks the same. Reverting is enough.

Checklist

Ready for review

  • One topic, on current main; the title is a Conventional Commit.
  • Tested on my own PC, in the game for a change the game runs, as Testing says. (The game runs nothing here. The fixture capture ran on my PC.)
  • mise run test passes (any failure that also fails on main is named). Not run on this PC: test suites run only in CI here. The guide checker passes locally.
  • Measured against main, or Measurements says why there is nothing to measure.
  • No game files, build output or hand-edited generated files; third_party/ untouched; nothing GPL-incompatible.

When it applies

  • Screenshots of the same spot on main and here, for a change that shows on screen. (Before and after in the comments.)
  • Docs updated.
  • AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.

Ready to merge

  • Everything in Still to test has run, its results in Tested.
  • Tier 1 hardware it can affect is tested (docs/dev/standards.md, "Hardware tiers").
  • Approved in review, every comment answered.
  • CI passes on the head; on current main, measured again or a comment says why the numbers still hold.

🤖 Generated with Claude Code

https://claude.ai/code/session_017vw8e2uxGKQxzDeQ15jjNK

https://claude.ai/code/session_017vw8e2uxGKQxzDeQ15jjNK

## Summary The "Guide screenshots / Guide images and local UI source review" check fails on `main`, and so on every open pull request: 16 of the files recorded for the Graphics menu image (`docs/user/images/guide/settings-graphics.png`) changed after the revision last reviewed for it, `eee321b6`. Its game-free capture fixture no longer built either. The ReShade menu module (#1861) calls ReShade runtime functions that `scripts/screenshots/menu.cpp` did not stub, so the link failed. This pull request reviews each change and recaptures the image: - **Fixture:** `scripts/screenshots/menu.cpp` stubs the seven ReShade runtime calls the menu links against. The stubs list no user presets, give no status line and change no picture. - **What changed in the image:** I rendered `eee321b6` and `main` `936d4e00` with the same toolchain. The two differ only in two places: - the version text; - the thumb of the Graphics scrollbar. It is now 172 px tall instead of 196 px, because the page gained rows below the visible area: the Post-processing heading with **ReShade preset** and **Compare ReShade Preset** (#1861), and **Grass distance** (#1382). - **What did not change:** the visible rows, labels, values, Quality preset help, tabs and keyboard prompts. The other changes are not drawn in this view: the help for Output resolution (#1859), the FPS counter details rows (#1657), the restart and preview dialogs, the translations, and the renderer and policy headers. - **Recapture:** because the scrollbar changed, the image is recaptured from `main` `936d4e00` with the fixed fixture. - **Records:** `manifest.json` now records: - the new capture and the same revision as reviewed; - all 130 source hashes, including six new dependencies the compiler found (`gpu/vk/menu/reshade.{cpp,h}`, `gpu/vk/reshade/fx_{builtin,clarity,runtime}.h`, `gpu/vk/upscale_route.h`); - the fixture hashes and the toolchain; - a note on the comparison. The guide's caption (`docs/user/graphics-and-controls.md`) and the images README name the new revision. Read first: `scripts/screenshots/menu.cpp` (the stubs), then the `settings-graphics.png` entry in `docs/user/images/guide/manifest.json`. ## Testing **Tested:** Docs and the capture fixture only. The game does not run any of this, so I made no game run. On Linux (CachyOS, clang 23.1.4, sdl2-compat 2.32.74, libpng 1.6.59), I ran three game-free captures through the job queue in `--mode light`: - `scripts/screenshots/capture_menu.py --views graphics` at `eee321b6`, with that revision's own fixture; - the same capture on `main` `936d4e00`, with this branch's fixture; - the same capture again from this branch's own commit, as a cross-check. Pixel diffs: - `eee321b6` against `main`: only the version text (x 1066–1260, y 25–38) and the scrollbar thumb (x 41–45, y 254–278) differ. - The `main` capture against this branch's capture: only the version text differs. I looked at the new image myself. It shows no private path, no game asset and no saved state. `python3 -I -B scripts/check_guide_screenshots.py --review-sources` now prints no `REVIEW REQUIRED`. It still prints `NOT CHECKED` for the six Launcher images: they need `--launcher-source`, and the CI workflow doesn't pass it. **Still to test:** - CI: the Guide screenshots workflow and the rest of `mise run test` on the head, expecting them to pass. I ran no test suite on this PC (by hand: read the CI result). - Rendered guide: build the website, then look at the Graphics guide page at desktop and 360–390 px width, in light and dark themes. Expect the new image to load and its caption to read "main 936d4e00 (after nightly 695)" (by hand). ## Measurements Nothing to measure: this changes a guide image, its records and the game-free capture fixture, none of which the game runs. ## Risks Nothing in the game or the player's files changes. The fixture's ReShade stubs exist only in the documentation capture build. A future ReShade runtime call the menu makes will fail the fixture's link the same way, so someone will notice it. The pixels of the new image differ throughout from the old one because the capture toolchain changed (from clang 18 and SDL 2.30 to clang 23 and sdl2-compat 2.32), but the UI it shows looks the same. Reverting is enough. ## Checklist ### Ready for review - [x] One topic, on current `main`; the title is a Conventional Commit. - [x] Tested on my own PC, in the game for a change the game runs, as Testing says. (The game runs nothing here. The fixture capture ran on my PC.) - [ ] `mise run test` passes (any failure that also fails on `main` is named). Not run on this PC: test suites run only in CI here. The guide checker passes locally. - [x] Measured against `main`, or Measurements says why there is nothing to measure. - [x] No game files, build output or hand-edited generated files; `third_party/` untouched; nothing GPL-incompatible. ### When it applies - [x] Screenshots of the same spot on `main` and here, for a change that shows on screen. (Before and after in the comments.) - [x] Docs updated. - [x] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. ### Ready to merge - [ ] Everything in Still to test has run, its results in Tested. - [ ] Tier 1 hardware it can affect is tested (docs/dev/standards.md, "Hardware tiers"). - [ ] Approved in review, every comment answered. - [ ] CI passes on the head; on current `main`, measured again or a comment says why the numbers still hold. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_017vw8e2uxGKQxzDeQ15jjNK https://claude.ai/code/session_017vw8e2uxGKQxzDeQ15jjNK
docs(guide): recapture the Graphics menu image on main 936d4e00, its fixture stubbing the ReShade runtime
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request_target) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 14s
CI / Workflow lint (actionlint) (pull_request) Successful in 25s
Guide screenshots / Guide images and local UI source review (pull_request) Successful in 26s
Third-party parts / As their notes say (pull_request) Successful in 28s
PR description / Description follows the template (pull_request_target) Successful in 12s
CI / Website build and checks (pull_request) Failing after 29s
ac83ea87a2
The guide-screenshot check failed on main: 16 of the Graphics image's
recorded UI sources had changed since its reviewed revision eee321b6.
The menu fixture no longer linked either: the ReShade menu module (#1861)
calls the ReShade runtime, which the fixture now stubs (no presets, no
status, no picture change).

Rendered with one toolchain, eee321b6 and main 936d4e00 differ only in
the version text and the Graphics scrollbar's thumb, shortened by the
rows the page gained below the visible area (Post-processing with the
ReShade rows, #1861; Grass distance, #1382). The visible rows, labels,
values, help and prompts are unchanged. The image is recaptured from
main with the fixed fixture, and the manifest records the new capture,
its 130 source hashes (six new dependencies: the ReShade module and
runtime headers, upscale_route.h), the fixture hashes and toolchain;
the guide's caption and the images README name the new revision.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_017vw8e2uxGKQxzDeQ15jjNK
Author
Owner

The Graphics image before (main's published one, an older toolchain) and after (this PR, captured game-free on main 936d4e00). The UI is the same; only the version text and the scrollbar thumb (two new rows below the view: Grass distance, and the ReShade rows) differ.

settings-graphics-main.png

settings-graphics-pr.png

The Graphics image before (main's published one, an older toolchain) and after (this PR, captured game-free on main 936d4e00). The UI is the same; only the version text and the scrollbar thumb (two new rows below the view: Grass distance, and the ReShade rows) differ. ![settings-graphics-main.png](https://git.magicbean.dev/attachments/88832223-82de-466e-bc41-f32932dde1ed) ![settings-graphics-pr.png](https://git.magicbean.dev/attachments/aa1992ce-3d4d-415e-b628-36f0c6b95e14)
Member

Possibly related, for context:

  • PR #1466 docs(guide): the Graphics guide image is retained after #1309, #1362 and #1464 — Earlier repair of the same Graphics guide review-check failure
Possibly related, for context: - PR #1466 docs(guide): the Graphics guide image is retained after #1309, #1362 and #1464 — Earlier repair of the same Graphics guide review-check failure
HumanBean closed this pull request 2026-11-21 18:16:20 +00:00
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request_target) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 14s
CI / Workflow lint (actionlint) (pull_request) Successful in 25s
Guide screenshots / Guide images and local UI source review (pull_request) Successful in 26s
Third-party parts / As their notes say (pull_request) Successful in 28s
PR description / Description follows the template (pull_request_target) Successful in 12s
CI / Website build and checks (pull_request) Failing after 29s

Pull request closed

Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
MagicBeanDev/Longshot!2095
No description provided.