[Merged by Bors] - Improve Gamepad DPad Button Detection #5220

zicklag · 2022-07-05T21:23:38Z

Objective

Enable the axis_dpad_to_button gilrs filter to map hats to dpad buttons on supported remotes.
Fixes DPad Buttons Presses Not Detected Leafwing-Studios/leafwing-input-manager#149
Might have fixed the confusion related to Direction pad buttons not working #3229

Solution

Enables the axis_dpad_to_button filter in gilrs which will use it's remote mapping information to see if there are hats mapped to dpads for that remote model. I don't really understand the logic it uses exactly, but it is usually enabled by default in gilrs and I believe it probably leads to more intuitive mapping compared to the current situation of dpad buttons being mapped to an axis.
Removes the GamepadAxisType::DPadX and GamepadAxisType::DPadY enum variants to avoid user confusion. Those variants should never be emitted anyway, for all supported remotes.

Changelog

Changed

Removed GamepadAxisType::DPadX and GamepadAxisType::DPadY in favor of using GamepadButtonType::DPad[Up/Down/Left/Right] instead.

Migration Guide

If your game reads gamepad events or queries the axis state of GamePadAxisType::DPadX or GamePadAxisType::DPadY, then you must migrate your code to check whether or not the GamepadButtonType::DPadUp, GamepadButtonType::DPadDown, etc. buttons were pressed instead.

alice-i-cecile

This is much more reasonable behavior, and I really like the improved consistency.

I think this means we need to remove the DPad axis variants on GamepadAxisType then? It seems like this will cause all dpad presses to be treated as button presses rather than axis events.

This is also good, because then there's exactly one way to handle dpad events.

zicklag · 2022-07-05T22:27:25Z

I think this means we need to remove the DPad axis variants on GamepadAxisType then?

That's a really good question. We might still need them there? I'm not positive.

As far as I can tell from the gilrs source code, the filter that does the axis-to-button conversion for the dpad uses its database of controller models to try see if that database says that some axis is in fact a dpad, but if there were a remote that wasn't in that database, or if the remote already has a dpad, then it might report a dpad as an axis instead.

The gilrs docs say:

This filter will do nothing if gamepad has dpad buttons (to prevent double events for same element) and if standard NativeEvCode for dpads is used by some other buttons. It will always try to map if SDL mappings contains mappings for all four hats.

So it sounds like there could still be scenarios where a DPad axis might be reported, and that the event conversion is best-effort.

alice-i-cecile · 2022-07-05T22:47:59Z

Hmm. I would personally be in favor of just removing the enum variants proactively and seeing what sort of bug reports we get. Those docs seem like they should be doing basically what we want. If we're still getting problems for users we can try manual deduplication, either in bevy or upstream.

If you / reviewers disagree, please at least leave a warning note on those variants, and point users to the corresponding buttons.

zicklag · 2022-07-05T23:28:34Z

OK, I'm good with that. If we get a bug report about the buttons not being detected, I think the solution will be to add a mapping to the controller database here and then update gilrs to use it, and that seems like a reasonable workflow.

I pushed an update.

alice-i-cecile

Changes LGTM now :) Make sure to remember to update your PR description!

Enable the `axis_dpad_to_button` gilrs filter to map hats to dpad buttons on supported remotes.

alice-i-cecile · 2022-07-06T01:49:44Z

@Shatur I'd like to hear your opinion on this.

Shatur

I think that the change is make sense.

Looks like Godot doesn't have DPadX or DPadY either: https://docs.godotengine.org/ru/stable/classes/class_%40globalscope.html#enum-globalscope-joysticklist

odecay · 2022-07-07T21:30:31Z

I don't have experience with gilrs but I personally find using Dpad buttons as independent direction inputs as opposed to mapping them as axes highly preferable. 👍

alice-i-cecile · 2022-07-11T14:02:59Z

bors r+

# Objective - Enable the `axis_dpad_to_button` gilrs filter to map hats to dpad buttons on supported remotes. - Fixes Leafwing-Studios/leafwing-input-manager#149 - Might have fixed the confusion related to #3229 ## Solution - Enables the `axis_dpad_to_button` filter in `gilrs` which will use it's remote mapping information to see if there are hats mapped to dpads for that remote model. I don't really understand the logic it uses exactly, but it is usually enabled by default in gilrs and I believe it probably leads to more intuitive mapping compared to the current situation of dpad buttons being mapped to an axis. - Removes the `GamepadAxisType::DPadX` and `GamepadAxisType::DPadY` enum variants to avoid user confusion. Those variants should never be emitted anyway, for all supported remotes. --- ## Changelog ### Changed - Removed `GamepadAxisType::DPadX` and `GamepadAxisType::DPadY` in favor of using `GamepadButtonType::DPad[Up/Down/Left/Right]` instead. ## Migration Guide If your game reads gamepad events or queries the axis state of `GamePadAxisType::DPadX` or `GamePadAxisType::DPadY`, then you must migrate your code to check whether or not the `GamepadButtonType::DPadUp`, `GamepadButtonType::DPadDown`, etc. buttons were pressed instead.

bors · 2022-07-11T14:35:57Z

Pull request successfully merged into main.

Build succeeded:

# Objective - Enable the `axis_dpad_to_button` gilrs filter to map hats to dpad buttons on supported remotes. - Fixes Leafwing-Studios/leafwing-input-manager#149 - Might have fixed the confusion related to bevyengine#3229 ## Solution - Enables the `axis_dpad_to_button` filter in `gilrs` which will use it's remote mapping information to see if there are hats mapped to dpads for that remote model. I don't really understand the logic it uses exactly, but it is usually enabled by default in gilrs and I believe it probably leads to more intuitive mapping compared to the current situation of dpad buttons being mapped to an axis. - Removes the `GamepadAxisType::DPadX` and `GamepadAxisType::DPadY` enum variants to avoid user confusion. Those variants should never be emitted anyway, for all supported remotes. --- ## Changelog ### Changed - Removed `GamepadAxisType::DPadX` and `GamepadAxisType::DPadY` in favor of using `GamepadButtonType::DPad[Up/Down/Left/Right]` instead. ## Migration Guide If your game reads gamepad events or queries the axis state of `GamePadAxisType::DPadX` or `GamePadAxisType::DPadY`, then you must migrate your code to check whether or not the `GamepadButtonType::DPadUp`, `GamepadButtonType::DPadDown`, etc. buttons were pressed instead.

This was referenced Jul 5, 2022

Direction pad buttons not working #3229

Closed

DPad Buttons Presses Not Detected Leafwing-Studios/leafwing-input-manager#149

Closed

alice-i-cecile added C-Bug An unexpected or incorrect behavior A-Input Player input via keyboard, mouse, gamepad, and more labels Jul 5, 2022

alice-i-cecile reviewed Jul 5, 2022

View reviewed changes

zicklag force-pushed the dpad-mapping branch from 2155a3c to a975e7f Compare July 5, 2022 23:28

alice-i-cecile approved these changes Jul 5, 2022

View reviewed changes

alice-i-cecile added the M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Jul 5, 2022

zicklag force-pushed the dpad-mapping branch from a975e7f to c4d17ee Compare July 5, 2022 23:39

Improve Gamepad DPad Button Detection

c4d17ee

Enable the `axis_dpad_to_button` gilrs filter to map hats to dpad buttons on supported remotes.

Shatur approved these changes Jul 6, 2022

View reviewed changes

alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jul 6, 2022

alice-i-cecile mentioned this pull request Jul 7, 2022

cargo run --example gamepad_input not getting RightTrigger2 on linux #5240

Open

bors bot changed the title ~~Improve Gamepad DPad Button Detection~~ [Merged by Bors] - Improve Gamepad DPad Button Detection Jul 11, 2022

bors bot closed this Jul 11, 2022

mockersf mentioned this pull request Oct 16, 2022

Switch Joy-Con (Left / Right) support on macOS #6269

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - Improve Gamepad DPad Button Detection #5220

[Merged by Bors] - Improve Gamepad DPad Button Detection #5220

zicklag commented Jul 5, 2022 •

edited

Loading

alice-i-cecile left a comment •

edited

Loading

zicklag commented Jul 5, 2022 •

edited

Loading

alice-i-cecile commented Jul 5, 2022

zicklag commented Jul 5, 2022

alice-i-cecile left a comment

alice-i-cecile commented Jul 6, 2022

Shatur left a comment

odecay commented Jul 7, 2022 •

edited

Loading

alice-i-cecile commented Jul 11, 2022

bors bot commented Jul 11, 2022

[Merged by Bors] - Improve Gamepad DPad Button Detection #5220

[Merged by Bors] - Improve Gamepad DPad Button Detection #5220

Conversation

zicklag commented Jul 5, 2022 • edited Loading

Objective

Solution

Changelog

Changed

Migration Guide

alice-i-cecile left a comment • edited Loading

Choose a reason for hiding this comment

zicklag commented Jul 5, 2022 • edited Loading

alice-i-cecile commented Jul 5, 2022

zicklag commented Jul 5, 2022

alice-i-cecile left a comment

Choose a reason for hiding this comment

alice-i-cecile commented Jul 6, 2022

Shatur left a comment

Choose a reason for hiding this comment

odecay commented Jul 7, 2022 • edited Loading

alice-i-cecile commented Jul 11, 2022

bors bot commented Jul 11, 2022

zicklag commented Jul 5, 2022 •

edited

Loading

alice-i-cecile left a comment •

edited

Loading

zicklag commented Jul 5, 2022 •

edited

Loading

odecay commented Jul 7, 2022 •

edited

Loading