Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 2.21 KB

File metadata and controls

21 lines (16 loc) · 2.21 KB
uid input-system-device-descriptions

Device descriptions

The Input System uses the device description defined as a InputDeviceDescription primarily during the Device discovery process. When a new Device is reported (by the runtime or by the user), the system then attempts to find a Device layout that matches the Device description contained in the report. This process is based on Device matching.

After a Device has been created, you can retrieve the description it was created from through the InputDevice.description property.

Every description has a set of standard fields:

Field Description
interfaceName Identifier for the interface/API that is making the Device available. In many cases, this corresponds to the name of the platform, but there are several more specific interfaces that are commonly used: HID, RawInput, XInput.
This field is required.
deviceClass A broad categorization of the Device. For example, "Gamepad" or "Keyboard".
product Name of the product as reported by the Device/driver itself.
manufacturer Name of the manufacturer as reported by the Device/driver itself.
version If available, provides the version of the driver or hardware for the Device.
serial If available, provides the serial number for the Device.
capabilities A string in JSON format that describes Device/interface-specific capabilities. See the section on capabilities.