Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOCS: Added missing documentation to XInputController.DeviceSubType #2066

Merged
merged 3 commits into from
Dec 6, 2024
Merged

DOCS: Added missing documentation to XInputController.DeviceSubType #2066

merged 3 commits into from
Dec 6, 2024

Conversation

ekcoh
Copy link
Collaborator

@ekcoh ekcoh commented Dec 2, 2024

Description

Added missing documentation to XInputController.DeviceSubType.

Emphasis on also remapping Xbox conventional controls to the corresponding Input System standardised Gamepad controls.

Testing status & QA

Please describe the testing already done by you and what testing you request/recommend QA to execute. If you used or created any testing project please link them here too for QA.

Overall Product Risks

Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.

  • Complexity:
  • Halo Effect:

Comments to reviewers

Please describe any additional information such as what to focus on, or historical info for the reviewers.

Checklist

Before review:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

After merge:

  • Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

@ekcoh ekcoh requested a review from duckets December 2, 2024 14:20
@ekcoh ekcoh marked this pull request as ready for review December 2, 2024 14:20
@ekcoh ekcoh added the DocsQualityWeek2024 Temporary label for docs week label Dec 2, 2024
lyndon-unity
lyndon-unity approved these changes Dec 2, 2024
View reviewed changes
Packages/com.unity.inputsystem/InputSystem/Plugins/XInput/XInputController.cs
/// Includes left and right stick as <see cref="Gamepad.leftStick" /> and <see cref="Gamepad.rightStick"/>,
/// left and right trigger as <see cref="Gamepad.leftTrigger"/> and <see cref="Gamepad.rightTrigger"/>,
/// directional pad as <see cref="Gamepad.dpad"/>,
/// and all standard buttons (<see cref="Gamepad.buttonSouth"/>, <see cref="Gamepad.buttonEast"/>,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slightly odd order SEWN
I would expect NESW (i.e clockwise) or alphabetical but its not very important ;)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kept MSDNs order

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these are basically straight off transformations of MSDNs definitions

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SEWN is a proper order, it's debatable whether SWEN is also valid based on the HID standards definition on how to order buttons, e.g. S is button0 since it has the minimum distance from the resting position of the finger used to press it, i.e. its the most ergonomically fit button (primary).

@ekcoh
Copy link
Collaborator Author

ekcoh commented Dec 3, 2024

Unclear why iOS test failure on this one, last failure was TextMesh Pro related, now it seems blank.

@ekcoh
Copy link
Collaborator Author

ekcoh commented Dec 4, 2024

Unclear why iOS test failure on this one, last failure was TextMesh Pro related, now it seems blank.

No longer an issue it seems

@ekcoh ekcoh merged commit a318c46 into develop Dec 6, 2024
77 checks passed
@ekcoh ekcoh deleted the docs-quality-week-2024-xinputcontroller-dsubtype branch December 6, 2024 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ritamerkl ritamerkl ritamerkl approved these changes

@lyndon-unity lyndon-unity lyndon-unity approved these changes

@duckets duckets duckets approved these changes

Assignees
No one assigned
Labels
DocsQualityWeek2024 Temporary label for docs week
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ekcoh @duckets @lyndon-unity @ritamerkl