WIP: fix(input): the native mouse camera leaves the view to the game while the mouse is released #1173

Draft
TrashPanda wants to merge 1 commit from TrashPanda/Longshot:fix/released-mouse-camera into main
Contributor

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

Why

With the native mouse camera, releasing the mouse (Esc, a menu, another window) froze the camera at its last angle: the game's own camera moves, such as swinging behind Link, were undone every frame until the mouse was captured again.

Restored from Hookshot 2947, by jarynclouatre, and split out of #286 so it can be reviewed and merged on its own.

How to reproduce

Seen on: any OS
Settings and switches: native mouse camera on
Steps: release the mouse with Esc and walk with the stick or keys
Expected: the game's camera follows Link
Actual: the camera stays where the mouse left it

What changed

hos_mouse_camera in host/mouse_native.c asks hos_mouse_take first; with the mouse released it forgets its angles and leaves the camera to the game, and the next captured frame starts from the game's angles.

Commits, each with its original author and message:

d1e04562 fix(input): the native mouse camera leaves the view to the game while the mouse is released (jarynclouatre)

With the native mouse camera, hos_mouse_camera skipped the mouse's
motion while the mouse was released (Esc, a menu open, or the window
losing focus), but it still wrote its last yaw and pitch back into the
camera every frame. The game's own camera work, such as swinging behind
Link, was undone until the mouse was captured again or the stick moved.

Change

In host/mouse_native.c, hos_mouse_camera asks hos_mouse_take
first. With the mouse released it forgets its angles and leaves the
camera alone, so the next captured frame starts from the game's angles,
the same way it already does after the stick turns the camera.

Testing

  • tests/test_mouse_native.py, new case: with capture off the game's
    yaw (10) is kept, and once the mouse is captured again a turn starts
    from it (11). It fails on main and passes here.
  • Full suite on Linux: 442 passed, 85 skipped, 1 failed
    (test_bake_portability: zstandard is not installed on this machine;
    it fails the same on main).
  • Not tested in the game.

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

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 @ d1e04562: tests/test_mouse_native.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: The game with the mouse released. Opened as work in progress until it runs in the game.

Must be tested:

  • Any OS (by hand): the steps under How to reproduce, expecting the camera to follow Link

Risks

What could break: the native mouse camera.

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:** any ## Why With the native mouse camera, releasing the mouse (Esc, a menu, another window) froze the camera at its last angle: the game's own camera moves, such as swinging behind Link, were undone every frame until the mouse was captured again. Restored from [Hookshot 2947](https://github.com/NotRexed/Hookshot/pull/2947), 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 **Settings and switches:** native mouse camera on **Steps:** release the mouse with Esc and walk with the stick or keys **Expected:** the game's camera follows Link **Actual:** the camera stays where the mouse left it ## What changed `hos_mouse_camera` in `host/mouse_native.c` asks `hos_mouse_take` first; with the mouse released it forgets its angles and leaves the camera to the game, and the next captured frame starts from the game's angles. Commits, each with its original author and message: <details><summary><code>d1e04562</code> fix(input): the native mouse camera leaves the view to the game while the mouse is released (jarynclouatre)</summary> With the native mouse camera, `hos_mouse_camera` skipped the mouse's motion while the mouse was released (Esc, a menu open, or the window losing focus), but it still wrote its last yaw and pitch back into the camera every frame. The game's own camera work, such as swinging behind Link, was undone until the mouse was captured again or the stick moved. #### Change In `host/mouse_native.c`, `hos_mouse_camera` asks `hos_mouse_take` first. With the mouse released it forgets its angles and leaves the camera alone, so the next captured frame starts from the game's angles, the same way it already does after the stick turns the camera. #### Testing - `tests/test_mouse_native.py`, new case: with capture off the game's yaw (10) is kept, and once the mouse is captured again a turn starts from it (11). It fails on main and passes here. - Full suite on Linux: 442 passed, 85 skipped, 1 failed (`test_bake_portability`: `zstandard` is not installed on this machine; it fails the same on main). - Not tested in the game. Restored-from: https://github.com/NotRexed/Hookshot/pull/2947 </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 @ d1e04562: `tests/test_mouse_native.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:** The game with the mouse released. Opened as work in progress until it runs in the game. **Must be tested:** - Any OS (by hand): the steps under How to reproduce, expecting the camera to follow Link ## Risks **What could break:** the native mouse camera. **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 native mouse camera leaves the view to the game while the mouse is released
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 9s
d1e0456276
With the native mouse camera, `hos_mouse_camera` skipped the mouse's
motion while the mouse was released (Esc, a menu open, or the window
losing focus), but it still wrote its last yaw and pitch back into the
camera every frame. The game's own camera work, such as swinging behind
Link, was undone until the mouse was captured again or the stick moved.

## Change

In `host/mouse_native.c`, `hos_mouse_camera` asks `hos_mouse_take`
first. With the mouse released it forgets its angles and leaves the
camera alone, so the next captured frame starts from the game's angles,
the same way it already does after the stick turns the camera.

## Testing

- `tests/test_mouse_native.py`, new case: with capture off the game's
yaw (10) is kept, and once the mouse is captured again a turn starts
from it (11). It fails on main and passes here.
- Full suite on Linux: 442 passed, 85 skipped, 1 failed
(`test_bake_portability`: `zstandard` is not installed on this machine;
it fails the same on main).
- Not tested in the game.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2947
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. Only scripted input ran; the native mouse camera with the mouse released 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. Only scripted input ran; the native mouse camera with the mouse released was not tried by hand.
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 the mouse-released camera was not tried by hand.
  • 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 the mouse-released camera was not tried by hand. - *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 9s
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/released-mouse-camera:TrashPanda-fix/released-mouse-camera'
git switch 'TrashPanda-fix/released-mouse-camera'
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!1173
No description provided.