Vuo  2.3.2
Classes | Macros | Functions
VuoHidControl

Description

Information about a control on a USB HID device.

Classes

struct  VuoHidControl
 Information about a control on a USB HID device. More...
 

Functions

VuoHidControl VuoHidControl_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoHidControl_getJson (const VuoHidControl value)
 Encodes value as a JSON object. More...
 
char * VuoHidControl_getSummary (const VuoHidControl value)
 Returns a compact string representation of value. More...
 
bool VuoHidControl_areEqual (const VuoHidControl valueA, const VuoHidControl valueB)
 Returns true if the two values are equal. More...
 
bool VuoHidControl_isLessThan (const VuoHidControl valueA, const VuoHidControl valueB)
 Returns true if valueA is less than valueB. More...
 
VuoHidControl VuoHidControl_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoHidControl_getString (const VuoHidControl value)
 Automatically generated function. More...
 
void VuoHidControl_retain (VuoHidControl value)
 Automatically generated function. More...
 
void VuoHidControl_release (VuoHidControl value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoHidControl

struct VuoHidControl
Class Members
VuoInteger max The maximum possible value the control can take.
VuoInteger min The minimum possible value the control can take.
VuoText name The control's display name.
VuoInteger value The control's current or default value.

Function Documentation

◆ VuoHidControl_areEqual()

bool VuoHidControl_areEqual ( const VuoHidControl  valueA,
const VuoHidControl  valueB 
)

Returns true if the two values are equal.

Definition at line 87 of file VuoHidControl.c.

◆ VuoHidControl_getJson()

struct json_object* VuoHidControl_getJson ( const VuoHidControl  value)

Encodes value as a JSON object.

Definition at line 53 of file VuoHidControl.c.

◆ VuoHidControl_getString()

char* VuoHidControl_getString ( const VuoHidControl  value)

Automatically generated function.

◆ VuoHidControl_getSummary()

char* VuoHidControl_getSummary ( const VuoHidControl  value)

Returns a compact string representation of value.

Definition at line 119 of file VuoHidControl.c.

◆ VuoHidControl_isLessThan()

bool VuoHidControl_isLessThan ( const VuoHidControl  valueA,
const VuoHidControl  valueB 
)

Returns true if valueA is less than valueB.

Definition at line 107 of file VuoHidControl.c.

◆ VuoHidControl_makeFromJson()

VuoHidControl VuoHidControl_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"name": "System Menu Left",
"value": 0,
"min": 0,
"max": 1
}

Definition at line 40 of file VuoHidControl.c.

◆ VuoHidControl_makeFromString()

VuoHidControl VuoHidControl_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoHidControl_release()

void VuoHidControl_release ( VuoHidControl  value)

Automatically generated function.

◆ VuoHidControl_retain()

void VuoHidControl_retain ( VuoHidControl  value)

Automatically generated function.