VuoImageFormat

Description

An enum defining different image formats that Vuo is capable of exporting.

Enumerations
enum	VuoImageFormat {   VuoImageFormat_PNG, VuoImageFormat_JPEG, VuoImageFormat_TIFF, VuoImageFormat_BMP,   VuoImageFormat_HDR, VuoImageFormat_EXR, VuoImageFormat_GIF, VuoImageFormat_TARGA,   VuoImageFormat_WEBP }
	An enum defining different image formats that Vuo is capable of exporting. More...

Functions
VuoImageFormat	VuoImageFormat_makeFromJson (json_object *js)
json_object *	VuoImageFormat_getJson (const VuoImageFormat value)
char *	VuoImageFormat_getSummary (const VuoImageFormat value)
struct json_object *	VuoImageFormat_getValidFileExtensions (const VuoImageFormat format)
char *	VuoImageFormat_getExtension (const VuoImageFormat value)
VuoList_VuoImageFormat	VuoImageFormat_getAllowedValues (void)
	Returns a list of values that instances of this type can have. More...
bool	VuoImageFormat_areEqual (const VuoImageFormat value1, const VuoImageFormat value2)
	Returns true if the two formats are identical. More...
bool	VuoImageFormat_isLessThan (const VuoImageFormat value1, const VuoImageFormat value2)
	Returns true if value1 < value2. More...
VuoImageFormat	VuoImageFormat_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoImageFormat_getString (const VuoImageFormat value)
	Automatically generated function. More...
void	VuoImageFormat_retain (VuoImageFormat value)
	Automatically generated function. More...
void	VuoImageFormat_release (VuoImageFormat value)
	Automatically generated function. More...

Enumeration Type Documentation

VuoImageFormat

enum VuoImageFormat

An enum defining different image formats that Vuo is capable of exporting.

Definition at line 28 of file VuoImageFormat.h.

Function Documentation

VuoImageFormat_areEqual()

bool VuoImageFormat_areEqual	(	const VuoImageFormat	value1,
		const VuoImageFormat	value2
	)

Returns true if the two formats are identical.

Definition at line 246 of file VuoImageFormat.c.

VuoImageFormat_getAllowedValues()

VuoList_VuoImageFormat VuoImageFormat_getAllowedValues

(

void

)

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

Definition at line 107 of file VuoImageFormat.c.

VuoImageFormat_getExtension()

char * VuoImageFormat_getExtension

(

const VuoImageFormat

value

)

Return a char* that can be used as an extension.

Definition at line 206 of file VuoImageFormat.c.

VuoImageFormat_getJson()

struct json_object * VuoImageFormat_getJson

(

const VuoImageFormat

value

)

Encodes value as a JSON object.

Definition at line 67 of file VuoImageFormat.c.

VuoImageFormat_getString()

char* VuoImageFormat_getString

(

const VuoImageFormat

value

)

Automatically generated function.

VuoImageFormat_getSummary()

char * VuoImageFormat_getSummary

(

const VuoImageFormat

value

)

Same as VuoImageFormat_getString() but with some capitilization involved.

Definition at line 126 of file VuoImageFormat.c.

VuoImageFormat_getValidFileExtensions()

struct json_object * VuoImageFormat_getValidFileExtensions

(

const VuoImageFormat

format

)

Return an array of valid file extensions for this format (ex, JPEG returns {"jpeg", "jpg"}).

Definition at line 167 of file VuoImageFormat.c.

VuoImageFormat_isLessThan()

bool VuoImageFormat_isLessThan	(	const VuoImageFormat	value1,
		const VuoImageFormat	value2
	)

Returns true if value1 < value2.

Definition at line 254 of file VuoImageFormat.c.

VuoImageFormat_makeFromJson()

VuoImageFormat VuoImageFormat_makeFromJson

(

json_object *

js

)

Decodes the JSON object js, expected to contain a string, to create a new VuoImageFormat.

Definition at line 32 of file VuoImageFormat.c.

VuoImageFormat_makeFromString()

VuoImageFormat VuoImageFormat_makeFromString

(

const char *

str

)

Automatically generated function.

VuoImageFormat_release()

void VuoImageFormat_release

(

VuoImageFormat

value

)

Automatically generated function.

VuoImageFormat_retain()

void VuoImageFormat_retain

(

VuoImageFormat

value

)

Automatically generated function.