WIP: fix(vk): Frame generation by and CRT lines shown only when they apply; Frame pacing and Threaded rendering on the Debug tab #1106

Draft
HumanBean wants to merge 1 commit from HumanBean/Longshot:menu-fg-crt-debug-rows into main
Owner

Type: fix · Risk: low · Tested on: not yet in the game (Linux build only) · Needs: any OS, any GPU: a look at the Insert menu

Why

The Insert menu's Graphics tab shows rows that mean nothing in the state the player has chosen, and two rows that are for
testing, not a player's choice:

  • Frame generation by flips between Built-in FG (Frame generation Off) and DLSS FG (on): NVIDIA's runtime is asked
    only once frame generation runs (since #1041). With
    Frame generation Off the row means nothing anyway.
  • CRT lines means nothing with the CRT filter Off.
  • Frame pacing and Threaded rendering are for testing and comparisons; the Quality presets and Auto choose them.

What changed

Frame generation by shows only with Frame generation on, CRT lines only with a CRT filter on, and Frame pacing and
Threaded rendering move to the Debug tab's Developer section.

  • menu: row_shown in gpu/vk/vk_menu.cpp hides opts.framegen_by while opts.framegen is 0 and opts.crt_lines
    while opts.crt_filter is 0, as it hides HDR's levels with HDR off. The Frame pacing and Threaded rendering rows move
    from TAB_GRAPHICS to TAB_DEBUG, after Save my pipeline list (the Quality presets still set Frame pacing; the options
    file keys are unchanged).
  • README: the option table moves the two rows under Debug (Developer:) and says when the other two show.
  • tests: test_menu_sections.py (the Graphics sections' rows), test_threaded_rendering.py (the row's tab, the README
    line), test_damage_debug_menu.py (two more Developer rows).

Measurements

Nothing to measure: which menu rows show, and on which tab.

Flags and settings

None: no option, key or switch changes; two rows change tab and two show only when they apply.

Testing

Tested: the renderer builds and links on Linux (dev_build.py pack over base 02903b04; vk_menu.cpp compiled).
No game-free checks were run on this PC (its owner's rule); no run in the game yet.

Not tested: the menu in the game; the updated checks.

Must be tested:

  • Any OS, any GPU: in the Insert menu's Graphics tab, set Frame generation Off, expecting no Frame generation by row,
    and back on, expecting it; set CRT filter Off, expecting no CRT lines row. Frame pacing and Threaded rendering are
    under Debug → Developer and change as before (Threaded rendering asks for a restart) (by hand).
  • The game-free checks: python -I -B tests/run_all.py (CI).

Risks

What could break: the keys and the pad stepping over the rows that come and go (row_shown is what every tab walk
asks, as for HDR's rows); a launcher or bridge setting Frame generation by or CRT lines while they are hidden (the
bridge lists the rows row_shown shows).

Turning it off: revert the commit.

Compatibility: nothing changes: the options file keeps every key and value.

Issues

See #1041

Checklist

Everyone

  • One topic.
  • The title is a Conventional Commit (type(scope): description) of the status line's type.
  • Why gives the reason plainly and links the issues that fit (the tracker searched).
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named). (not run on this PC: CI)
  • No game files, dumps, build output or generated files.
  • third_party/ untouched (a new folder with a PROVENANCE.md instead).
  • The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.

When it applies

  • AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.
  • Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen. (to come)
  • A check under tests/ that reads changed source updated in this PR, not weakened.
  • Docs updated.

🤖 Generated with Claude Code

**Type:** fix · **Risk:** low · **Tested on:** not yet in the game (Linux build only) · **Needs:** any OS, any GPU: a look at the Insert menu ## Why The Insert menu's Graphics tab shows rows that mean nothing in the state the player has chosen, and two rows that are for testing, not a player's choice: - **Frame generation by** flips between Built-in FG (Frame generation Off) and DLSS FG (on): NVIDIA's runtime is asked only once frame generation runs (since [#1041](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/1041)). With Frame generation Off the row means nothing anyway. - **CRT lines** means nothing with the CRT filter Off. - **Frame pacing** and **Threaded rendering** are for testing and comparisons; the Quality presets and Auto choose them. ## What changed Frame generation by shows only with Frame generation on, CRT lines only with a CRT filter on, and Frame pacing and Threaded rendering move to the Debug tab's Developer section. - menu: `row_shown` in `gpu/vk/vk_menu.cpp` hides `opts.framegen_by` while `opts.framegen` is 0 and `opts.crt_lines` while `opts.crt_filter` is 0, as it hides HDR's levels with HDR off. The Frame pacing and Threaded rendering rows move from `TAB_GRAPHICS` to `TAB_DEBUG`, after Save my pipeline list (the Quality presets still set Frame pacing; the options file keys are unchanged). - README: the option table moves the two rows under Debug (Developer:) and says when the other two show. - tests: `test_menu_sections.py` (the Graphics sections' rows), `test_threaded_rendering.py` (the row's tab, the README line), `test_damage_debug_menu.py` (two more Developer rows). ## Measurements Nothing to measure: which menu rows show, and on which tab. ### Flags and settings None: no option, key or switch changes; two rows change tab and two show only when they apply. ## Testing **Tested:** the renderer builds and links on Linux (`dev_build.py pack` over base 02903b04; `vk_menu.cpp` compiled). No game-free checks were run on this PC (its owner's rule); no run in the game yet. **Not tested:** the menu in the game; the updated checks. **Must be tested:** - Any OS, any GPU: in the Insert menu's Graphics tab, set Frame generation Off, expecting no Frame generation by row, and back on, expecting it; set CRT filter Off, expecting no CRT lines row. Frame pacing and Threaded rendering are under Debug → Developer and change as before (Threaded rendering asks for a restart) (by hand). - The game-free checks: `python -I -B tests/run_all.py` (CI). ## Risks **What could break:** the keys and the pad stepping over the rows that come and go (`row_shown` is what every tab walk asks, as for HDR's rows); a launcher or bridge setting Frame generation by or CRT lines while they are hidden (the bridge lists the rows `row_shown` shows). **Turning it off:** revert the commit. **Compatibility:** nothing changes: the options file keeps every key and value. ## Issues See #1041 ## Checklist ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. - [ ] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). (not run on this PC: CI) - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. ### When it applies - [x] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. - [ ] Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen. (to come) - [x] A check under `tests/` that reads changed source updated in this PR, not weakened. - [x] Docs updated. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
fix(vk): Frame generation by shown only with Frame generation on, CRT lines only with a CRT filter; Frame pacing and Threaded rendering on the Debug tab
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
CI / Conventional Commit title (pull_request) Successful in 9s
PR description / Description follows the template (pull_request_target) Successful in 11s
CI / Workflow lint (actionlint) (pull_request) Successful in 12s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 14s
Website / Website on Cloudflare (pull_request_target) Has been skipped
Third-party parts / As their notes say (pull_request) Successful in 18s
dbc9862ab9
Frame generation by flipped between Built-in FG and DLSS FG as Frame generation went Off and on (NVIDIA's runtime is
asked only once frame generation runs), and meant nothing while it was off: row_shown hides it then, as it hides HDR's
levels with HDR off, and CRT lines with the CRT filter off. Frame pacing and Threaded rendering are for testing, not a
player's choice: they move under the Debug tab's Developer heading (the Quality presets still set Frame pacing).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
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
CI / Conventional Commit title (pull_request) Successful in 9s
PR description / Description follows the template (pull_request_target) Successful in 11s
CI / Workflow lint (actionlint) (pull_request) Successful in 12s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 14s
Website / Website on Cloudflare (pull_request_target) Has been skipped
Third-party parts / As their notes say (pull_request) Successful in 18s
This pull request is marked as a work in progress.
This branch is out-of-date with the base branch
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'menu-fg-crt-debug-rows:HumanBean-menu-fg-crt-debug-rows'
git switch 'HumanBean-menu-fg-crt-debug-rows'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
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!1106
No description provided.