Vuo  2.0.0
Macros | Enumerations | Functions
VuoColorSample

Description

How to sample a color.

Enumerations

enum  VuoColorSample {
  VuoColorSample_Average, VuoColorSample_DarkestComponents, VuoColorSample_DarkestColor, VuoColorSample_LightestComponents,
  VuoColorSample_LightestColor
}
 How to sample a color. More...
 

Functions

VuoColorSample VuoColorSample_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoColorSample_getJson (const VuoColorSample value)
 Encodes value as a JSON object. More...
 
VuoList_VuoColorSample VuoColorSample_getAllowedValues (void)
 Returns a list of values that instances of this type can have. More...
 
char * VuoColorSample_getSummary (const VuoColorSample value)
 Returns a compact string representation of value. More...
 
bool VuoColorSample_areEqual (const VuoColorSample valueA, const VuoColorSample valueB)
 Returns true if the two values are equal. More...
 
bool VuoColorSample_isLessThan (const VuoColorSample valueA, const VuoColorSample valueB)
 Returns true if valueA is less than valueB. More...
 
VuoColorSample VuoColorSample_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoColorSample_getString (const VuoColorSample value)
 Automatically generated function. More...
 
void VuoColorSample_retain (VuoColorSample value)
 Automatically generated function. More...
 
void VuoColorSample_release (VuoColorSample value)
 Automatically generated function. More...
 

Enumeration Type Documentation

◆ VuoColorSample

How to sample a color.

Definition at line 28 of file VuoColorSample.h.

Function Documentation

◆ VuoColorSample_areEqual()

bool VuoColorSample_areEqual ( const VuoColorSample  valueA,
const VuoColorSample  valueB 
)

Returns true if the two values are equal.

Definition at line 110 of file VuoColorSample.c.

◆ VuoColorSample_getAllowedValues()

VuoList_VuoColorSample VuoColorSample_getAllowedValues ( void  )

Returns a list of values that instances of this type can have.

Definition at line 77 of file VuoColorSample.c.

◆ VuoColorSample_getJson()

struct json_object* VuoColorSample_getJson ( const VuoColorSample  value)

Encodes value as a JSON object.

Definition at line 58 of file VuoColorSample.c.

◆ VuoColorSample_getString()

char* VuoColorSample_getString ( const VuoColorSample  value)

Automatically generated function.

◆ VuoColorSample_getSummary()

char* VuoColorSample_getSummary ( const VuoColorSample  value)

Returns a compact string representation of value.

Definition at line 91 of file VuoColorSample.c.

◆ VuoColorSample_isLessThan()

bool VuoColorSample_isLessThan ( const VuoColorSample  valueA,
const VuoColorSample  valueB 
)

Returns true if valueA is less than valueB.

Definition at line 118 of file VuoColorSample.c.

◆ VuoColorSample_makeFromJson()

VuoColorSample VuoColorSample_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
"darker-component"

Definition at line 35 of file VuoColorSample.c.

◆ VuoColorSample_makeFromString()

VuoColorSample VuoColorSample_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoColorSample_release()

void VuoColorSample_release ( VuoColorSample  value)

Automatically generated function.

◆ VuoColorSample_retain()

void VuoColorSample_retain ( VuoColorSample  value)

Automatically generated function.