Vuo
2.0.0
|
Information about a Hid I/O device.
Classes | |
struct | VuoHidDevice |
Information about a USB HID device. More... | |
Enumerations | |
enum | VuoHidDevice_MatchType { VuoHidDevice_MatchName, VuoHidDevice_MatchLocation } |
Which field to match on. More... | |
Functions | |
VuoHidDevice | VuoHidDevice_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. More... | |
struct json_object * | VuoHidDevice_getJson (const VuoHidDevice value) |
Encodes value as a JSON object. More... | |
char * | VuoHidDevice_getSummary (const VuoHidDevice value) |
Returns a compact string representation of value . More... | |
bool | VuoHidDevice_areEqual (const VuoHidDevice valueA, const VuoHidDevice valueB) |
Returns true if the two values are equal. More... | |
bool | VuoHidDevice_isLessThan (const VuoHidDevice valueA, const VuoHidDevice valueB) |
Returns true if valueA is less than valueB . More... | |
bool | VuoHidDevice_realize (VuoHidDevice device, VuoHidDevice *realizedDevice) VuoWarnUnusedResult |
If device specifies name-matching: More... | |
VuoHidDevice | VuoHidDevice_makeFromString (const char *str) |
Automatically generated function. More... | |
char * | VuoHidDevice_getString (const VuoHidDevice value) |
Automatically generated function. More... | |
void | VuoHidDevice_retain (VuoHidDevice value) |
Automatically generated function. More... | |
void | VuoHidDevice_release (VuoHidDevice value) |
Automatically generated function. More... | |
struct VuoHidDevice |
Class Members | ||
---|---|---|
VuoList_VuoHidControl | controls | All the device's controls. |
VuoInteger | location |
Where the device is connected in the USB topology. kIOHIDLocationIDKey << 8 + kUSBInterfaceNumber |
VuoHidDevice_MatchType | matchType | Which field to use for matching a VuoHidDevice structure to an actual device. |
VuoText | name | The device's display name. |
VuoInteger | productID | |
VuoInteger | usage | |
VuoInteger | usagePage | |
VuoInteger | vendorID |
Which field to match on.
Definition at line 28 of file VuoHidDevice.h.
bool VuoHidDevice_areEqual | ( | const VuoHidDevice | valueA, |
const VuoHidDevice | valueB | ||
) |
Returns true if the two values are equal.
Definition at line 136 of file VuoHidDevice.c.
struct json_object* VuoHidDevice_getJson | ( | const VuoHidDevice | value | ) |
Encodes value
as a JSON object.
Definition at line 81 of file VuoHidDevice.c.
char* VuoHidDevice_getString | ( | const VuoHidDevice | value | ) |
Automatically generated function.
char* VuoHidDevice_getSummary | ( | const VuoHidDevice | value | ) |
Returns a compact string representation of value
.
Definition at line 249 of file VuoHidDevice.c.
bool VuoHidDevice_isLessThan | ( | const VuoHidDevice | valueA, |
const VuoHidDevice | valueB | ||
) |
Returns true if valueA
is less than valueB
.
Definition at line 168 of file VuoHidDevice.c.
VuoHidDevice VuoHidDevice_makeFromJson | ( | json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 64 of file VuoHidDevice.c.
VuoHidDevice VuoHidDevice_makeFromString | ( | const char * | str | ) |
Automatically generated function.
bool VuoHidDevice_realize | ( | VuoHidDevice | device, |
VuoHidDevice * | realizedDevice | ||
) |
If device
specifies name-matching:
realizedDevice
to a specific, existing device matched by its location, and returns true.realizedDevice
unset.If device
specifies location-matching, sets realizedDevice
to a copy of device
, and returns true. (Doesn't bother checking whether the location actually exists.)
Definition at line 182 of file VuoHidDevice.c.
void VuoHidDevice_release | ( | VuoHidDevice | value | ) |
Automatically generated function.
void VuoHidDevice_retain | ( | VuoHidDevice | value | ) |
Automatically generated function.