WIP: fix(input): the gyro is at rest while the Insert menu is open #1171

Draft
TrashPanda wants to merge 1 commit from TrashPanda/Longshot:fix/gyro-rest-in-menu into main
Contributor

Type: fix · Risk: low · Tested on: Linux, RTX 4070 Ti (game-free checks) · Needs: a controller with motion

Why

With motion controls on, moving the controller while the Insert menu is open still aimed in the game, though the menu holds back the controller's buttons and sticks.

Restored from Hookshot 2962, by 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 with a gyro
Settings and switches: motion controls on
Steps: aim with the slingshot, open the Insert menu, move the controller, close the menu
Expected: the aim is where it was
Actual: the aim moved

What changed

motion_counts in host/nn_hid.c also takes the menu's state, so with the menu open the motion handler gives its at-rest state.

Commits, each with its original author and message:

6308e671 fix(input): the gyro is at rest while the Insert menu is open (jarynclouatre)

With motion controls on, opening the Insert menu holds back a pad's
buttons and sticks (read_input), but GetSixAxisSensorStates only
asked about the window and the "Controller in background" row. Moving
the controller while in the menu still aimed in the game.

Change

motion_counts in host/nn_hid.c takes the menu's state (rx_option(1, 0)) as well, and the motion counts only while the menu is closed. With
the menu open the handler gives its existing at-rest state; the switch
between live and at rest already renumbers the samples.

Testing

  • tests/test_motion_background.py: three new cases (menu open in
    front; open behind another window with "Controller in background" on;
    open with HOS_INPUT_BACKGROUND=1) give the pad at rest; the six cases
    from before are unchanged. On main the handler never looks at the menu
    (motion_counts has no parameter for it).
  • Full suite on Linux: 2 failures, each for a tool this machine lacks
    (test_bake_portability: zstandard;
    nx2/test_texture_init_barrier.py: clang++); both fail the same on
    main.
  • No controller was moved in the game.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2962

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 @ 6308e671: tests/test_motion_background.py pass. The full suite (tests/run_all.py) has not been run on this branch yet; a comment will follow when it has.

Not tested: Moving a controller in the game. Opened as work in progress until it runs in the game.

Must be tested:

  • Any OS, a controller with motion (by hand): the steps under How to reproduce, expecting the aim not to move

Risks

What could break: motion controls around the Insert menu.

Turning it off: revert the commit.

Compatibility: Nothing changes.

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).
  • Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what
    can't be run by hand is in Testing's Not testable by hand, with why.
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and
    in Risks.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main.
  • 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.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named).

When it applies

  • A game-free test added for the fix, failing on main and passing here.
**Type:** fix · **Risk:** low · **Tested on:** Linux, RTX 4070 Ti (game-free checks) · **Needs:** a controller with motion ## Why With motion controls on, moving the controller while the Insert menu is open still aimed in the game, though the menu holds back the controller's buttons and sticks. Restored from [Hookshot 2962](https://github.com/NotRexed/Hookshot/pull/2962), by jarynclouatre, and split out of [#286](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/286) so it can be reviewed and merged on its own. ## How to reproduce **Seen on:** any OS, a controller with a gyro **Settings and switches:** motion controls on **Steps:** aim with the slingshot, open the Insert menu, move the controller, close the menu **Expected:** the aim is where it was **Actual:** the aim moved ## What changed `motion_counts` in `host/nn_hid.c` also takes the menu's state, so with the menu open the motion handler gives its at-rest state. Commits, each with its original author and message: <details><summary><code>6308e671</code> fix(input): the gyro is at rest while the Insert menu is open (jarynclouatre)</summary> With motion controls on, opening the Insert menu holds back a pad's buttons and sticks (`read_input`), but `GetSixAxisSensorStates` only asked about the window and the "Controller in background" row. Moving the controller while in the menu still aimed in the game. #### Change `motion_counts` in `host/nn_hid.c` takes the menu's state (`rx_option(1, 0)`) as well, and the motion counts only while the menu is closed. With the menu open the handler gives its existing at-rest state; the switch between live and at rest already renumbers the samples. #### Testing - `tests/test_motion_background.py`: three new cases (menu open in front; open behind another window with "Controller in background" on; open with `HOS_INPUT_BACKGROUND=1`) give the pad at rest; the six cases from before are unchanged. On main the handler never looks at the menu (`motion_counts` has no parameter for it). - Full suite on Linux: 2 failures, each for a tool this machine lacks (`test_bake_portability`: `zstandard`; `nx2/test_texture_init_barrier.py`: `clang++`); both fail the same on main. - No controller was moved in the game. Restored-from: https://github.com/NotRexed/Hookshot/pull/2962 </details> ## 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 @ 6308e671: `tests/test_motion_background.py` pass. The full suite (`tests/run_all.py`) has not been run on this branch yet; a comment will follow when it has. **Not tested:** Moving a controller in the game. Opened as work in progress until it runs in the game. **Must be tested:** - Any OS, a controller with motion (by hand): the steps under How to reproduce, expecting the aim not to move ## Risks **What could break:** motion controls around the Insert menu. **Turning it off:** revert the commit. **Compatibility:** Nothing changes. ## 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] Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what can't be run by hand is in Testing's Not testable by hand, with why. - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and in Risks. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. - [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. - [ ] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). ### When it applies - [x] A game-free test added for the fix, failing on `main` and passing here.
fix(input): the gyro is at rest while the Insert menu is open
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 10s
6308e671b6
With motion controls on, opening the Insert menu holds back a pad's
buttons and sticks (`read_input`), but `GetSixAxisSensorStates` only
asked about the window and the "Controller in background" row. Moving
the controller while in the menu still aimed in the game.

## Change

`motion_counts` in `host/nn_hid.c` takes the menu's state (`rx_option(1,
0)`) as well, and the motion counts only while the menu is closed. With
the menu open the handler gives its existing at-rest state; the switch
between live and at rest already renumbers the samples.

## Testing

- `tests/test_motion_background.py`: three new cases (menu open in
front; open behind another window with "Controller in background" on;
open with `HOS_INPUT_BACKGROUND=1`) give the pad at rest; the six cases
from before are unchanged. On main the handler never looks at the menu
(`motion_counts` has no parameter for it).
- Full suite on Linux: 2 failures, each for a tool this machine lacks
(`test_bake_portability`: `zstandard`;
`nx2/test_texture_init_barrier.py`: `clang++`); both fail the same on
main.
- No controller was moved in the game.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2962
Author
Contributor

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. No gyro controller was connected; the Insert menu with a moving gyro was not tried by hand.

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. No gyro controller was connected; the Insert menu with a moving gyro was not tried by hand.
Collaborator

Possibly related, for context:

  • PR #1169 WIP: fix(input): the controller in the background stays out of the game while the Insert menu is open — Open overlapping Insert-menu controller-input fix in the same host input code.
Possibly related, for context: - PR #1169 WIP: fix(input): the controller in the background stays out of the game while the Insert menu is open — Open overlapping Insert-menu controller-input fix in the same host input code.
Owner

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).

  • Tested on my own PC: ticked: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, though no gyro controller was connected.
  • Nothing gets worse that I know of: ticked: Measurements gives a verdict of nothing to measure for a correctness fix, and Risks names no slower, latency or memory cost.
Brought up to the [ready-for-review standard](https://git.magicbean.dev/MagicBeanDev/Longshot/src/branch/main/CONTRIBUTING.md#ready-for-review-out-of-wip) (#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). - *Tested on my own PC*: ticked: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, though no gyro controller was connected. - *Nothing gets worse that I know of*: ticked: Measurements gives a verdict of nothing to measure for a correctness fix, and Risks names no slower, latency or memory cost.
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 10s
This pull request is marked as a work in progress.
Some workflows are waiting to be reviewed.
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 'fix/gyro-rest-in-menu:TrashPanda-fix/gyro-rest-in-menu'
git switch 'TrashPanda-fix/gyro-rest-in-menu'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
3 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!1171
No description provided.