Struct HID.HIDDeviceDescriptor
HID descriptor for a HID class device.
Namespace: UnityEngine.InputSystem.HID
Syntax
[Serializable]
public struct HIDDeviceDescriptor
Remarks
This is a processed view of the combined descriptors provided by a HID as defined in the HID specification, i.e. it's a combination of information from the USB device descriptor, HID class descriptor, and HID report descriptor.
Fields
collections
Declaration
public HID.HIDCollectionDescriptor[] collections
Field Value
Type | Description |
---|---|
HID.HIDCollectionDescriptor[] |
elements
Declaration
public HID.HIDElementDescriptor[] elements
Field Value
Type | Description |
---|---|
HID.HIDElementDescriptor[] |
featureReportSize
Maximum size of individual feature reports exchanged with the device.
Declaration
public int featureReportSize
Field Value
Type | Description |
---|---|
Int32 |
inputReportSize
Maximum size of individual input reports sent by the device.
Declaration
public int inputReportSize
Field Value
Type | Description |
---|---|
Int32 |
outputReportSize
Maximum size of individual output reports sent to the device.
Declaration
public int outputReportSize
Field Value
Type | Description |
---|---|
Int32 |
productId
USB product ID.
Declaration
public int productId
Field Value
Type | Description |
---|---|
Int32 |
usage
Declaration
public int usage
Field Value
Type | Description |
---|---|
Int32 |
usagePage
Declaration
public HID.UsagePage usagePage
Field Value
Type | Description |
---|---|
HID.UsagePage |
vendorId
USB vendor ID.
Declaration
public int vendorId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
To get the string version of the vendor ID, see manufacturer on description.
Methods
FromJson(String)
Declaration
public static HID.HIDDeviceDescriptor FromJson(string json)
Parameters
Type | Name | Description |
---|---|---|
String | json |
Returns
Type | Description |
---|---|
HID.HIDDeviceDescriptor |
ToJson()
Declaration
public string ToJson()
Returns
Type | Description |
---|---|
String |