Description

A list of VuoImageFormat elements.

Classes
struct	VuoList_VuoImageFormat_struct
	A list of VuoImageFormat elements. More...

Typedefs
typedef const struct VuoList_VuoImageFormat_struct *	VuoList_VuoImageFormat
	A list of VuoImageFormat elements. More...

Functions
VuoList_VuoImageFormat	VuoListCreate_VuoImageFormat (void)
	Creates a new list of VuoImageFormat elements. More...

VuoList_VuoImageFormat	VuoListCreateWithCount_VuoImageFormat (const unsigned long count, const VuoImageFormat value)
	Creates a new list of `count` instances of `value`. More...

VuoList_VuoImageFormat	VuoListCopy_VuoImageFormat (const VuoList_VuoImageFormat list)
	Makes a shallow copy of `list` — its items are retained (not copied) by the new list. More...

static unsigned long	VuoListIndexToCArrayIndex (long index, unsigned long listCount) __attribute__((const))
	Converts a Vuo-style `[1..n]` list index into a C-style `[0..n-1]` list index. More...

VuoImageFormat	VuoListGetValue_VuoImageFormat (const VuoList_VuoImageFormat list, const unsigned long index)
	Returns the VuoImageFormat at `index`. More...

VuoImageFormat *	VuoListGetData_VuoImageFormat (const VuoList_VuoImageFormat list)
	Returns a pointer to a C array containing the list items. More...

void	VuoListForeach_VuoImageFormat (const VuoList_VuoImageFormat list, bool(^function)(const VuoImageFormat value))
	Applies `function` to each of `list`'s items, serially in order of index. More...

void	VuoListSetValue_VuoImageFormat (const VuoList_VuoImageFormat list, const VuoImageFormat value, const unsigned long index, bool expandListIfNeeded)
	Changes the VuoImageFormat at `index`. More...

void	VuoListInsertValue_VuoImageFormat (const VuoList_VuoImageFormat list, const VuoImageFormat value, const unsigned long index)
	Inserts the `VuoImageFormat` immediately before `index`. More...

void	VuoListPrependValue_VuoImageFormat (VuoList_VuoImageFormat list, const VuoImageFormat value)
	Prepends `value` to `list`. More...

void	VuoListAppendValue_VuoImageFormat (VuoList_VuoImageFormat list, const VuoImageFormat value)
	Appends `value` to `list`. More...

void	VuoListExchangeValues_VuoImageFormat (VuoList_VuoImageFormat list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at `indexA` with the value at `indexB`. More...

void	VuoListShuffle_VuoImageFormat (VuoList_VuoImageFormat list, const double chaos)
	Generates a random permutation of `list`. More...

void	VuoListReverse_VuoImageFormat (VuoList_VuoImageFormat list)
	Reverses the order of the items in `list`. More...

VuoList_VuoImageFormat	VuoListSubset_VuoImageFormat (VuoList_VuoImageFormat list, const signed long startIndex, const unsigned long itemCount)
	Returns a new list containing items from the original list in the range specified by `startIndex` and `itemCount`. More...

void	VuoListRemoveFirstValue_VuoImageFormat (VuoList_VuoImageFormat list)
	Removes the first value from `list`. More...

void	VuoListRemoveLastValue_VuoImageFormat (VuoList_VuoImageFormat list)
	Removes the last value from `list`. More...

void	VuoListRemoveAll_VuoImageFormat (VuoList_VuoImageFormat list)
	Removes all values from `list`. More...

void	VuoListRemoveValue_VuoImageFormat (VuoList_VuoImageFormat list, const unsigned long index)
	Removes the `VuoImageFormat` at `index`. More...

unsigned long	VuoListGetCount_VuoImageFormat (const VuoList_VuoImageFormat list)
	Returns the number of elements in `list`. More...

VuoList_VuoImageFormat	VuoList_VuoImageFormat_makeFromJson (struct json_object *js)
	Decodes the JSON object `js` to create a new value. More...

struct json_object *	VuoList_VuoImageFormat_getJson (const VuoList_VuoImageFormat value)
	Encodes `value` as a JSON object. More...

char *	VuoList_VuoImageFormat_getSummary (const VuoList_VuoImageFormat value)
	Produces a brief human-readable summary of `value`. More...

VuoList_VuoImageFormat	VuoList_VuoImageFormat_makeFromString (const char *str)
	Automatically generated function. More...

char *	VuoList_VuoImageFormat_getString (const VuoList_VuoImageFormat value)
	Automatically generated function. More...

Class Documentation

◆ VuoList_VuoImageFormat_struct

struct VuoList_VuoImageFormat_struct

Class Members
void *	l

Macro Definition Documentation

◆ VUO_LIST_INDEX_TO_C_ARRAY_INDEX

#define VUO_LIST_INDEX_TO_C_ARRAY_INDEX

Definition at line 54 of file VuoList_VuoImageFormat.h.

Typedef Documentation

◆ VuoList_VuoImageFormat

typedef const struct VuoList_VuoImageFormat_struct * VuoList_VuoImageFormat

A list of VuoImageFormat elements.

Function Documentation

◆ VuoList_VuoImageFormat_getJson()

struct json_object * VuoList_VuoImageFormat_getJson ( const VuoList_VuoImageFormat value )

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoImageFormat.cc.

◆ VuoList_VuoImageFormat_getString()

char * VuoList_VuoImageFormat_getString ( const VuoList_VuoImageFormat value )

Automatically generated function.

◆ VuoList_VuoImageFormat_getSummary()

char * VuoList_VuoImageFormat_getSummary ( const VuoList_VuoImageFormat value )

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoImageFormat.cc.

◆ VuoList_VuoImageFormat_makeFromJson()

VuoList_VuoImageFormat VuoList_VuoImageFormat_makeFromJson ( struct json_object * js )

Decodes the JSON object js to create a new value.

Example:: ["uno", "dos", "tres", "catorce"]

Definition at line 63 of file VuoList_VuoImageFormat.cc.

◆ VuoList_VuoImageFormat_makeFromString()

VuoList_VuoImageFormat VuoList_VuoImageFormat_makeFromString ( const char * str )

Automatically generated function.

◆ VuoListAppendValue_VuoImageFormat()

void VuoListAppendValue_VuoImageFormat	(	VuoList_VuoImageFormat	list,
		const VuoImageFormat	value
	)

Appends value to list.

Definition at line 308 of file VuoList_VuoImageFormat.cc.

◆ VuoListCopy_VuoImageFormat()

VuoList_VuoImageFormat VuoListCopy_VuoImageFormat ( const VuoList_VuoImageFormat list )

Makes a shallow copy of list — its items are retained (not copied) by the new list.

Definition at line 174 of file VuoList_VuoImageFormat.cc.

◆ VuoListCreate_VuoImageFormat()

VuoList_VuoImageFormat VuoListCreate_VuoImageFormat ( void )

Creates a new list of VuoImageFormat elements.

Definition at line 154 of file VuoList_VuoImageFormat.cc.

◆ VuoListCreateWithCount_VuoImageFormat()

VuoList_VuoImageFormat VuoListCreateWithCount_VuoImageFormat	(	const unsigned long	count,
		const VuoImageFormat	value
	)

Creates a new list of count instances of value.

Use this in conjunction with VuoListGetData_VuoImageFormat to quickly initialize a large list.

Definition at line 161 of file VuoList_VuoImageFormat.cc.

◆ VuoListExchangeValues_VuoImageFormat()

void VuoListExchangeValues_VuoImageFormat	(	VuoList_VuoImageFormat	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

Definition at line 318 of file VuoList_VuoImageFormat.cc.

◆ VuoListForeach_VuoImageFormat()

void VuoListForeach_VuoImageFormat	(	const VuoList_VuoImageFormat	list,
		bool(^)(const VuoImageFormat value)	function
	)

Applies function to each of list's items, serially in order of index.

If function returns false, visiting will stop immediately (possibly before all items have been visited).

Changed in Vuo 2.0.0:: New.

Definition at line 229 of file VuoList_VuoImageFormat.cc.

◆ VuoListGetCount_VuoImageFormat()

unsigned long VuoListGetCount_VuoImageFormat ( const VuoList_VuoImageFormat list )

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoImageFormat.cc.

◆ VuoListGetData_VuoImageFormat()

VuoImageFormat * VuoListGetData_VuoImageFormat ( const VuoList_VuoImageFormat list )

Returns a pointer to a C array containing the list items.

Use this if you need a fast way to get or change multiple list items.

You can modify values in the list by changing them in this array. Just don't attempt to access beyond the list size.

The pointer becomes invalid if you modify the list size using other functions (e.g., Insert, Prepend, Append, Cut, Remove); if you use those functions, just get a new pointer by calling this function again.

If the list has no items, returns NULL.

The pointer remains owned by the list; don't free it.

Definition at line 219 of file VuoList_VuoImageFormat.cc.

◆ VuoListGetValue_VuoImageFormat()

VuoImageFormat VuoListGetValue_VuoImageFormat	(	const VuoList_VuoImageFormat	list,
		const unsigned long	index
	)

Returns the VuoImageFormat at index.

Index values start at 1. If the list has no items, returns a default value. Attempting to access an out-of-bounds index returns the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

If iterating over an entire list, consider using VuoListGetData_VuoImageFormat or VuoListForeach_VuoImageFormat.

Definition at line 203 of file VuoList_VuoImageFormat.cc.

◆ VuoListIndexToCArrayIndex()

static unsigned long VuoListIndexToCArrayIndex	(	long	index,
		unsigned long	listCount
	)		const

inlinestatic

Converts a Vuo-style [1..n] list index into a C-style [0..n-1] list index.

If the index is less than 1, or larger than the size of the list, the returned index is clamped.

Definition at line 61 of file VuoList_VuoImageFormat.h.

◆ VuoListInsertValue_VuoImageFormat()

void VuoListInsertValue_VuoImageFormat	(	const VuoList_VuoImageFormat	list,
		const VuoImageFormat	value,
		const unsigned long	index
	)

Inserts the VuoImageFormat immediately before index.

Index values start at 1. Inserting at index 0 prepends the value to the list. Inserting at an index beyond the last value in the list appends the value to the list.

Definition at line 276 of file VuoList_VuoImageFormat.cc.

◆ VuoListPrependValue_VuoImageFormat()

void VuoListPrependValue_VuoImageFormat	(	VuoList_VuoImageFormat	list,
		const VuoImageFormat	value
	)

Prepends value to list.

Definition at line 298 of file VuoList_VuoImageFormat.cc.

◆ VuoListRemoveAll_VuoImageFormat()

void VuoListRemoveAll_VuoImageFormat ( VuoList_VuoImageFormat list )

Removes all values from list.

Definition at line 527 of file VuoList_VuoImageFormat.cc.

◆ VuoListRemoveFirstValue_VuoImageFormat()

void VuoListRemoveFirstValue_VuoImageFormat ( VuoList_VuoImageFormat list )

Removes the first value from list.

Definition at line 499 of file VuoList_VuoImageFormat.cc.

◆ VuoListRemoveLastValue_VuoImageFormat()

void VuoListRemoveLastValue_VuoImageFormat ( VuoList_VuoImageFormat list )

Removes the last value from list.

Definition at line 513 of file VuoList_VuoImageFormat.cc.

◆ VuoListRemoveValue_VuoImageFormat()

void VuoListRemoveValue_VuoImageFormat	(	VuoList_VuoImageFormat	list,
		const unsigned long	index
	)

Removes the VuoImageFormat at index.

Index values start at 1. Attempting to remove index 0 or an index beyond the last value in the list has no effect.

Definition at line 536 of file VuoList_VuoImageFormat.cc.

◆ VuoListReverse_VuoImageFormat()

void VuoListReverse_VuoImageFormat ( VuoList_VuoImageFormat list )

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoImageFormat.cc.

◆ VuoListSetValue_VuoImageFormat()

void VuoListSetValue_VuoImageFormat	(	const VuoList_VuoImageFormat	list,
		const VuoImageFormat	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the VuoImageFormat at index.

Index values start at 1.

If expandListIfNeeded is false: If the list has no items, nothing is changed. Attempting to change an out-of-bounds index changes the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

If expandListIfNeeded is true: If the list has less than index elements, it is expanded to accommodate the specified index. If index is 0, the list is resized to contain 1 item set to value.

Definition at line 241 of file VuoList_VuoImageFormat.cc.

◆ VuoListShuffle_VuoImageFormat()

void VuoListShuffle_VuoImageFormat	(	VuoList_VuoImageFormat	list,
		const double	chaos
	)

Generates a random permutation of list.

chaos ranges from 0 to 1. When chaos is 1, a full Fisher–Yates shuffle is performed. When less than 1, fewer iterations are performed.

Definition at line 401 of file VuoList_VuoImageFormat.cc.

◆ VuoListSubset_VuoImageFormat()

VuoList_VuoImageFormat VuoListSubset_VuoImageFormat	(	VuoList_VuoImageFormat	list,
		const signed long	startIndex,
		const unsigned long	itemCount
	)

Returns a new list containing items from the original list in the range specified by startIndex and itemCount.

Items in the new list are retained (not copied) from the original list.

Definition at line 431 of file VuoList_VuoImageFormat.cc.