WIP: docs(guide): recapture the Graphics menu image on main 936d4e00, its fixture stubbing the ReShade runtime #2095
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!2095
Loading…
Reference in a new issue
No description provided.
Delete branch "HumanBean/Longshot:docs/guide-graphics-recapture"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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 thatscripts/screenshots/menu.cppdid not stub, so the link failed.This pull request reviews each change and recaptures the image:
Fixture:
scripts/screenshots/menu.cppstubs 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
eee321b6andmain936d4e00with the same toolchain. The two differ only in two places: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
main936d4e00with the fixed fixture.Records:
manifest.jsonnow records:gpu/vk/menu/reshade.{cpp,h},gpu/vk/reshade/fx_{builtin,clarity,runtime}.h,gpu/vk/upscale_route.h);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 thesettings-graphics.pngentry indocs/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 graphicsateee321b6, with that revision's own fixture;main936d4e00, with this branch's fixture;Pixel diffs:
eee321b6againstmain: only the version text (x 1066–1260, y 25–38) and the scrollbar thumb (x 41–45, y 254–278) differ.maincapture 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-sourcesnow prints noREVIEW REQUIRED. It still printsNOT CHECKEDfor the six Launcher images: they need--launcher-source, and the CI workflow doesn't pass it.Still to test:
mise run teston the head, expecting them to pass. I ran no test suite on this PC (by hand: read the CI result).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
main; the title is a Conventional Commit.mise run testpasses (any failure that also fails onmainis named). Not run on this PC: test suites run only in CI here. The guide checker passes locally.main, or Measurements says why there is nothing to measure.third_party/untouched; nothing GPL-incompatible.When it applies
mainand here, for a change that shows on screen. (Before and after in the comments.)Assisted-by:/Co-Authored-By:trailers.Ready to merge
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
936d4e00, its fixture stubbing the ReShade runtimeThe 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.Possibly related, for context:
Pull request closed