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.
struct json_object *	VuoColorSample_getJson (const VuoColorSample value)
	Encodes value as a JSON object.
VuoList_VuoColorSample	VuoColorSample_getAllowedValues (void)
	Returns a list of values that instances of this type can have.
char *	VuoColorSample_getSummary (const VuoColorSample value)
	Returns a compact string representation of value.
bool	VuoColorSample_areEqual (const VuoColorSample valueA, const VuoColorSample valueB)
	Returns true if the two values are equal.
bool	VuoColorSample_isLessThan (const VuoColorSample valueA, const VuoColorSample valueB)
	Returns true if valueA is less than valueB.
char *	VuoColorSample_getString (const VuoColorSample value)
	Automatically generated function.
void	VuoColorSample_retain (VuoColorSample value)
	Automatically generated function.
void	VuoColorSample_release (VuoColorSample value)
	Automatically generated function.

Macro Definition Documentation

VuoColorSample_SUPPORTS_COMPARISON

#define VuoColorSample_SUPPORTS_COMPARISON

Definition at line 36 of file VuoColorSample.h.

Enumeration Type Documentation

VuoColorSample

enum VuoColorSample

How to sample a color.

Definition at line 27 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 108 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 75 of file VuoColorSample.c.

VuoColorSample_getJson()

struct json_object * VuoColorSample_getJson

(

const VuoColorSample

value

)

Encodes value as a JSON object.

Definition at line 56 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 89 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 116 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 33 of file VuoColorSample.c.

VuoColorSample_release()

void VuoColorSample_release

(

VuoColorSample

value

)

Automatically generated function.

VuoColorSample_retain()

void VuoColorSample_retain

(

VuoColorSample

value

)

Automatically generated function.