Defines an input device in the XR input subsystem.
To retrieve input features or route haptic feedback to XR input devices, specify an XRNode as the destination. Use XRNode.LeftHand and XRNode.RightHand to send haptic data to left or right devices. You can send haptic data either as an impulse or as a buffer of raw bytes that is played back through the haptic device. You can stop haptic output or query the device for its buffered capabilities at any time.
characteristics | Read Only. A bitmask of enumerated flags describing the characteristics of this InputDevice. |
isValid | Read Only. True if the device is currently a valid input device; otherwise false. |
manufacturer | The manufacturer of the connected Input Device. |
name | Read Only. The name of the device in the XR system. This is a platform provided unique identifier for the device. |
serialNumber | The serial number of the connected Input Device. Blank if no serial number is available. |
subsystem | Gets the XRInputSubsystem that reported this InputDevice. |
SendHapticBuffer | Sends a raw buffer of haptic data to the device. |
SendHapticImpulse | Sends a haptic impulse to a device. |
StopHaptics | Stop all haptic playback for a device. |
TryGetFeatureUsages | Gets a list of all the input feature usages available on this device. For example, "Trigger" or "Device Position". |
TryGetFeatureValue | Retrieves information about the input feature specified by the Usage parameter. Those functions which take a time parameter allow querying for that feature at a particular point in time |
TryGetHapticCapabilities | Gets the haptic capabilities of the device. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.