ISX.InputDeviceDescription Struct Reference

Metadata for a device. Primarily used to find a matching template which we can then use to create a control setup for the device. More...

Public Attributes
string	interfaceName
	How we talk to the device; usually name of the underlying backend that feeds state for the device. More...
string	deviceClass
	What the interface thinks the device classifies as. More...
string	capabilities
	An optional JSON string listing device-specific capabilities. More...

Detailed Description

Metadata for a device. Primarily used to find a matching template which we can then use to create a control setup for the device.

Member Data Documentation

capabilities

string ISX.InputDeviceDescription.capabilities

An optional JSON string listing device-specific capabilities.

The primary use of this field is to allow custom template constructors to create templates on the fly from in-depth device descriptions delivered by external APIs.

In the case of HID, for example, this field contains a JSON representation of the HID descriptor as reported by the device driver. This descriptor contains information about all I/O elements on the device which can be used to determine the control setup and data format used by the device.

deviceClass

string ISX.InputDeviceDescription.deviceClass

What the interface thinks the device classifies as.

If there is no template specifically matching a device description, the device class is used as as fallback. If, for example, this field is set to "Gamepad", the "Gamepad" template is used as a fallback.

interfaceName

string ISX.InputDeviceDescription.interfaceName

How we talk to the device; usually name of the underlying backend that feeds state for the device.

Examples: "HID", "XInput"