WIP: fix(input): the controller in the background stays out of the game while the Insert menu is open #1169
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
3 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1169
Loading…
Reference in a new issue
No description provided.
Delete branch "TrashPanda/Longshot:fix/background-pad-menu-hold"
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?
Type: fix · Risk: low · Tested on: Linux, RTX 4070 Ti (game-free checks) · Needs: any, a controller
Why
With "Controller in background" on, the Insert menu's hold on the controller only applied with the game in front: behind another window, a button pressed with the menu open, or still held after it closed, reached the game.
Restored from Hookshot 2963, by Joey Magnus, jarynclouatre, and split out of #286 so it can be reviewed and merged on its own.
How to reproduce
Seen on: any OS, a controller
Settings and switches: Controller in background on
Steps: put another window in front, open the Insert menu, press B, close the menu while B is held
Expected: Link does nothing until B is let go
Actual: Link acts on B
What changed
The menu's hold, the read and the merge are one helper,
pads_mergeinhost/nn_hid.c, used in front and behind. It keepsmain's per-input rule: after the menu closes, only the inputs it had wait until they are let go, and the sticks are the game's at once.Ported onto
main, which since changed the in-front hold to wait per input (the inputs the menu had, not the whole pad):pads_mergeismain's in-front block, now used behind too. The fixture's newpads-insertcase drivesmain'smenu_openand expects the sticks right after the close, asmaingives them in front.Commits, each with its original author and message:
9ded740cfix(input): the controller in the background stays out of the game while the Insert menu is open (jarynclouatre)With "Controller in background" on (or
HOS_INPUT_BACKGROUND=1),read_input's branch for a window behind another merged the padsstraight into the game's input. The Insert menu's hold, which the branch
for the window in front applies (the pads are the menu's while it is
open, and after it closed until they are let go), was missing there. A
button pressed with the menu open behind another window, or still held
after it closed, reached the game.
The hold, the read and the merge are one helper,
pads_merge, used byboth branches. The pads are still read while held back, so the letting
go is seen.
player_used()is still called only in front, as before,and the keyboard and mouse stay out behind other windows.
tests/test_input_background.pyand its fixture: a new case behindanother window with the pads allowed there. With the menu open, B and
the sticks do not reach the game, though the pads are read; with the
menu closed and B still held, nothing; after B is let go and pressed
again, B and the sticks arrive. On main the first frame already carries
B. The other 17 cases pass as before.
(
test_bake_portability:zstandard;nx2/test_texture_init_barrier.py:clang++); both fail the same onmain.
Co-authored-by: NotRexed [email protected]
Restored-from: https://github.com/NotRexed/Hookshot/pull/2963
391b7c82test: the pads-after-menu check cuts pads_merge, where read_input's pad block now is (Joey Magnus)Measurements
Verdict: nothing to measure: a correctness fix off the frame path, covered by game-free checks.
Flags and settings
None.
Testing
Tested: On Linux (kernel 7.0), RTX 4070 Ti,
main@71b1edd8, this PR @391b7c82:tests/test_input_background.pypass. The full suite (tests/run_all.py) has not been run on this branch yet; a comment will follow when it has.Not tested: The game with a controller behind another window. Opened as work in progress until it runs in the game.
Must be tested:
Risks
What could break: controller input around the Insert menu.
Turning it off: revert the commit.
Compatibility: Nothing changes.
Checklist
Everyone
type(scope): description) of the status line's type.can't be run by hand is in Testing's Not testable by hand, with why.
in Risks.
main.third_party/untouched (a new folder with aPROVENANCE.mdinstead).python -I -B tests/run_all.pypasses (any failure that also fails onmainis named).When it applies
mainand passing here.Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti 12 GB, NVIDIA 595.99.02, Ryzen 7 9800X3D: this branch built together with the other 18 split from #218 and #284-#288, merged onto main @
71b1edd8(make_game.py --update, build v3.0.0-rc.5-82-g5952bb3d), then played by a scripted tour through the control bridge (scripts/memtour.py: a save loaded, Zora's Domain, the Market, Hyrule Field and Death Mountain Trail, 40 s each with walking and camera swings). All 4 stops reached, a clean quit, and no device loss or Vulkan error in the log. Only scripted input ran; no controller was connected, so the Insert menu with a pad in the background was not tried by hand.This and #1168 both change
tests/test_input_background.py(the functions the check cuts fromhost/nn_hid.c). Whichever merges second needs a one-line rebase there: cutpads_in_background,pads_behindandpads_merge, in that order. Both were built and run together that way (see the first comment).Possibly related, for context:
Brought up to the ready-for-review standard (#1454): the checklist's Everyone list has two new boxes, added here from what this PR's description and comments show (please check they match what you know).
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.