Vuo  1.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Typedefs | Functions
VuoList_VuoImageColorDepth

Description

A list of VuoImageColorDepth elements.

Classes

struct  VuoList_VuoImageColorDepth_struct
 A list of VuoImageColorDepth elements. More...
 

Typedefs

typedef struct
VuoList_VuoImageColorDepth_struct
VuoList_VuoImageColorDepth
 A list of VuoImageColorDepth elements.
 

Functions

VuoList_VuoImageColorDepth VuoListCreate_VuoImageColorDepth (void)
 Creates a new list of VuoImageColorDepth elements.
 
VuoList_VuoImageColorDepth VuoListCreateWithCount_VuoImageColorDepth (const unsigned long count, const VuoImageColorDepth value)
 Creates a new list of count instances of value.
 
VuoList_VuoImageColorDepth VuoListCopy_VuoImageColorDepth (const VuoList_VuoImageColorDepth list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoImageColorDepth VuoListGetValue_VuoImageColorDepth (const VuoList_VuoImageColorDepth list, const unsigned long index)
 Returns the VuoImageColorDepth at index.
 
VuoImageColorDepthVuoListGetData_VuoImageColorDepth (const VuoList_VuoImageColorDepth list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoImageColorDepth (const VuoList_VuoImageColorDepth list, const VuoImageColorDepth value, const unsigned long index)
 Changes the VuoImageColorDepth at index.
 
void VuoListInsertValue_VuoImageColorDepth (const VuoList_VuoImageColorDepth list, const VuoImageColorDepth value, const unsigned long index)
 Inserts the VuoImageColorDepth immediately before index.
 
void VuoListPrependValue_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const VuoImageColorDepth value)
 Prepends value to list.
 
void VuoListAppendValue_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const VuoImageColorDepth value)
 Appends value to list.
 
void VuoListExchangeValues_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoImageColorDepth (VuoList_VuoImageColorDepth list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const signed long startIndex, const unsigned long itemCount)
 Removes items from the list except those in the range specified by startIndex and itemCount.
 
void VuoListRemoveFirstValue_VuoImageColorDepth (VuoList_VuoImageColorDepth list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoImageColorDepth (VuoList_VuoImageColorDepth list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoImageColorDepth (VuoList_VuoImageColorDepth list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const unsigned long index)
 Removes the VuoImageColorDepth at index.
 
unsigned long VuoListGetCount_VuoImageColorDepth (const VuoList_VuoImageColorDepth list)
 Returns the number of elements in list.
 
VuoList_VuoImageColorDepth VuoList_VuoImageColorDepth_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoImageColorDepth_getJson (const VuoList_VuoImageColorDepth value)
 Encodes value as a JSON object.
 
char * VuoList_VuoImageColorDepth_getSummary (const VuoList_VuoImageColorDepth value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoImageColorDepth VuoList_VuoImageColorDepth_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoImageColorDepth_getString (const VuoList_VuoImageColorDepth value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoImageColorDepth_struct
Class Members
void * l

Typedef Documentation

A list of VuoImageColorDepth elements.

Function Documentation

struct json_object* VuoList_VuoImageColorDepth_getJson ( const VuoList_VuoImageColorDepth  value)
read

Encodes value as a JSON object.

char* VuoList_VuoImageColorDepth_getString ( const VuoList_VuoImageColorDepth  value)

Automatically generated function.

char* VuoList_VuoImageColorDepth_getSummary ( const VuoList_VuoImageColorDepth  value)

Produces a brief human-readable summary of value.

VuoList_VuoImageColorDepth VuoList_VuoImageColorDepth_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]
VuoList_VuoImageColorDepth VuoList_VuoImageColorDepth_makeFromString ( const char *  str)

Automatically generated function.

void VuoListAppendValue_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list,
const VuoImageColorDepth  value 
)

Appends value to list.

VuoList_VuoImageColorDepth VuoListCopy_VuoImageColorDepth ( const VuoList_VuoImageColorDepth  list)

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

VuoList_VuoImageColorDepth VuoListCreate_VuoImageColorDepth ( void  )

Creates a new list of VuoImageColorDepth elements.

VuoList_VuoImageColorDepth VuoListCreateWithCount_VuoImageColorDepth ( const unsigned long  count,
const VuoImageColorDepth  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list,
const signed long  startIndex,
const unsigned long  itemCount 
)

Removes items from the list except those in the range specified by startIndex and itemCount.

void VuoListExchangeValues_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoImageColorDepth ( const VuoList_VuoImageColorDepth  list)

Returns the number of elements in list.

VuoImageColorDepth* VuoListGetData_VuoImageColorDepth ( const VuoList_VuoImageColorDepth  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.

VuoImageColorDepth VuoListGetValue_VuoImageColorDepth ( const VuoList_VuoImageColorDepth  list,
const unsigned long  index 
)

Returns the VuoImageColorDepth 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).

void VuoListInsertValue_VuoImageColorDepth ( const VuoList_VuoImageColorDepth  list,
const VuoImageColorDepth  value,
const unsigned long  index 
)

Inserts the VuoImageColorDepth 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.

void VuoListPrependValue_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list,
const VuoImageColorDepth  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list)

Removes the last value from list.

void VuoListRemoveValue_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list,
const unsigned long  index 
)

Removes the VuoImageColorDepth 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.

void VuoListReverse_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoImageColorDepth ( const VuoList_VuoImageColorDepth  list,
const VuoImageColorDepth  value,
const unsigned long  index 
)

Changes the VuoImageColorDepth at index.

Index values start at 1. 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).

void VuoListShuffle_VuoImageColorDepth ( VuoList_VuoImageColorDepth  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.