Fixed GetHapticCapabilitiesCommand always failing to execute #1776
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d missing haptic capabilities properties
jfreire-unity
requested changes
Oct 19, 2023
Packages/com.unity.inputsystem/InputSystem/Plugins/XR/Haptics/GetHapticCapabilitiesCommand.cs
Show resolved
Hide resolved
Packages/com.unity.inputsystem/InputSystem/Plugins/XR/Haptics/GetHapticCapabilitiesCommand.cs
Outdated
Show resolved
Hide resolved
The names won't match the UnityEngine.XR and IUnityXRInput.h names, but this is needed to avoid a breaking change. Renamed the optimal size field to more closely match the naming of maxBufferSize for consistency within Input System.
… API_MinorVersionsHaveNoBreakingChanges to fail. The value remains the same. The test could be updated in the future to recognize the value is the same, but for now it's easier to just revert the change.
|
Like @jamesmcgill I was getting failures of API_MinorVersionsHaveNoBreakingChanges when running locally on my computer, see #1763 (comment). I reverted the change of adding a redundant explicit field initialization to I also updated the branch to revert the obsolete and renaming I did previously. The names won't match the UnityEngine.XR namespace, but it seems we can't really do so without doing a breaking change. |
jfreire-unity
approved these changes
Oct 20, 2023
Packages/com.unity.inputsystem/InputSystem/Plugins/XR/Haptics/GetHapticCapabilitiesCommand.cs
Show resolved
Hide resolved
# Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md
# Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md
jamesmcgill
approved these changes
Oct 31, 2023
Packages/com.unity.inputsystem/InputSystem/Plugins/XR/Haptics/GetHapticCapabilitiesCommand.cs
Show resolved
Hide resolved
# Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md
# Conflicts: # Packages/com.unity.inputsystem/CHANGELOG.md
|
@chris-massie There is another PR about to land, so it's going to need another update soon I'm afraid. 😄 |
ekcoh
approved these changes
Nov 8, 2023
jamesmcgill
added a commit
that referenced
this pull request
Nov 8, 2023
* Fixed GetHapticCapabilitiesCommand always failing to execute and added missing haptic capabilities properties * Added setter to make migration better if the user was setting the old field * Fixed API_MinorVersionsHaveNoBreakingChanges by reverting renames The names won't match the UnityEngine.XR and IUnityXRInput.h names, but this is needed to avoid a breaking change. Renamed the optimal size field to more closely match the naming of maxBufferSize for consistency within Input System. * Reverted redundant explicit field initialization since it was causing API_MinorVersionsHaveNoBreakingChanges to fail. The value remains the same. The test could be updated in the future to recognize the value is the same, but for now it's easier to just revert the change. * Added xml-doc to public fields and methods --------- Co-authored-by: James McGill <jamesmcgill@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixed
GetHapticCapabilitiesCommandalways failing to execute.Changes made
Added new fields to the command to make the payload size in bytes match the expected size.
I modified the names of the command fields to match the names in Unity core and the XR module, and created deprecated properties that map to the new fields. The naming makes it more clear they only apply for buffered haptics. Though this is technically a breaking change, since the command never worked at all, I think this is acceptable.EDIT: I kept the old names to avoid API breaking.I also renamed the old properties inEDIT: Reverted since theHapticCapabilitiesto match XR module with auto migration. This is not a breaking change.API_MinorVersionsHaveNoBreakingChangestest isn't sophisticated enough to recognize this is allowed.Notes
Starting with Unity 2018.3, the
UnityXRHapticCapabilitiesstruct was modified to add new properties, which adjusted the size of the struct. TheXRInputSubsystemverifies that the size of the buffer passed to the command matches. It was previously always failing because 12 bytes != 20 bytes.Checklist
Before review:
Changed,Fixed,Addedsections.([case %number%](https://issuetracker.unity3d.com/issues/...)).Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.