Struct HID.HIDDeviceDescriptor

HID descriptor for a HID class device.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

Namespace: UnityEngine.InputSystem.HID

Assembly: Unity.InputSystem.dll

Syntax

[Serializable]
public struct HID.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
HIDCollectionDescriptor[]

elements

Declaration

public HID.HIDElementDescriptor[] elements

Field Value

Type	Description
HIDElementDescriptor[]

featureReportSize

Maximum size of individual feature reports exchanged with the device.

Declaration

public int featureReportSize

Field Value

Type	Description
int

inputReportSize

Maximum size of individual input reports sent by the device.

Declaration

public int inputReportSize

Field Value

Type	Description
int

outputReportSize

Maximum size of individual output reports sent to the device.

Declaration

public int outputReportSize

Field Value

Type	Description
int

productId

USB product ID.

Declaration

public int productId

Field Value

Type	Description
int

usage

Declaration

public int usage

Field Value

Type	Description
int

usagePage

Declaration

public HID.UsagePage usagePage

Field Value

Type	Description
HID.UsagePage

vendorId

USB vendor ID.

Declaration

public int vendorId

Field Value

Type	Description
int

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