Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoImageColorDepth

Description

A list of VuoImageColorDepth elements.

Classes

struct  VuoList_VuoImageColorDepth_struct
 List type. More...
 

Typedefs

typedef const struct VuoList_VuoImageColorDepth_structVuoList_VuoImageColorDepth
 A list of VuoImageColorDepth elements. More...
 

Functions

VuoList_VuoImageColorDepth VuoListCreate_VuoImageColorDepth (void)
 Creates a new list of VuoImageColorDepth elements. More...
 
VuoList_VuoImageColorDepth VuoListCreateWithCount_VuoImageColorDepth (const unsigned long count, const VuoImageColorDepth value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoImageColorDepth VuoListCopy_VuoImageColorDepth (const VuoList_VuoImageColorDepth list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoImageColorDepth VuoListGetValue_VuoImageColorDepth (const VuoList_VuoImageColorDepth list, const unsigned long index)
 Returns the VuoImageColorDepth at index. More...
 
VuoImageColorDepthVuoListGetData_VuoImageColorDepth (const VuoList_VuoImageColorDepth list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoImageColorDepth (const VuoList_VuoImageColorDepth list, bool(^function)(const VuoImageColorDepth value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoImageColorDepth (const VuoList_VuoImageColorDepth list, const VuoImageColorDepth value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoImageColorDepth at index. More...
 
void VuoListInsertValue_VuoImageColorDepth (const VuoList_VuoImageColorDepth list, const VuoImageColorDepth value, const unsigned long index)
 Inserts the VuoImageColorDepth immediately before index. More...
 
void VuoListPrependValue_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const VuoImageColorDepth value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const VuoImageColorDepth value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoImageColorDepth (VuoList_VuoImageColorDepth list)
 Reverses the order of the items in list. More...
 
VuoList_VuoImageColorDepth VuoListSubset_VuoImageColorDepth (VuoList_VuoImageColorDepth 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_VuoImageColorDepth (VuoList_VuoImageColorDepth list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoImageColorDepth (VuoList_VuoImageColorDepth list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoImageColorDepth (VuoList_VuoImageColorDepth list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoImageColorDepth (VuoList_VuoImageColorDepth list, const unsigned long index)
 Removes the VuoImageColorDepth at index. More...
 
unsigned long VuoListGetCount_VuoImageColorDepth (const VuoList_VuoImageColorDepth list)
 Returns the number of elements in list. More...
 
VuoList_VuoImageColorDepth VuoList_VuoImageColorDepth_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoImageColorDepth_getJson (const VuoList_VuoImageColorDepth value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoImageColorDepth_getSummary (const VuoList_VuoImageColorDepth value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoImageColorDepth VuoList_VuoImageColorDepth_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoImageColorDepth_getString (const VuoList_VuoImageColorDepth value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoImageColorDepth_struct

struct VuoList_VuoImageColorDepth_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoImageColorDepth

A list of VuoImageColorDepth elements.

Function Documentation

◆ VuoList_VuoImageColorDepth_getJson()

struct json_object* VuoList_VuoImageColorDepth_getJson ( const VuoList_VuoImageColorDepth  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoImageColorDepth.cc.

◆ VuoList_VuoImageColorDepth_getString()

char* VuoList_VuoImageColorDepth_getString ( const VuoList_VuoImageColorDepth  value)

Automatically generated function.

◆ VuoList_VuoImageColorDepth_getSummary()

char* VuoList_VuoImageColorDepth_getSummary ( const VuoList_VuoImageColorDepth  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoImageColorDepth.cc.

◆ VuoList_VuoImageColorDepth_makeFromJson()

VuoList_VuoImageColorDepth VuoList_VuoImageColorDepth_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_VuoImageColorDepth.cc.

◆ VuoList_VuoImageColorDepth_makeFromString()

VuoList_VuoImageColorDepth VuoList_VuoImageColorDepth_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoImageColorDepth()

void VuoListAppendValue_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list,
const VuoImageColorDepth  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListCopy_VuoImageColorDepth()

VuoList_VuoImageColorDepth VuoListCopy_VuoImageColorDepth ( const VuoList_VuoImageColorDepth  list)

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

Definition at line 174 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListCreate_VuoImageColorDepth()

VuoList_VuoImageColorDepth VuoListCreate_VuoImageColorDepth ( void  )

Creates a new list of VuoImageColorDepth elements.

Definition at line 154 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListCreateWithCount_VuoImageColorDepth()

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.

Definition at line 161 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListExchangeValues_VuoImageColorDepth()

void VuoListExchangeValues_VuoImageColorDepth ( VuoList_VuoImageColorDepth  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_VuoImageColorDepth.cc.

◆ VuoListForeach_VuoImageColorDepth()

void VuoListForeach_VuoImageColorDepth ( const VuoList_VuoImageColorDepth  list,
bool(^)(const VuoImageColorDepth 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_VuoImageColorDepth.cc.

◆ VuoListGetCount_VuoImageColorDepth()

unsigned long VuoListGetCount_VuoImageColorDepth ( const VuoList_VuoImageColorDepth  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListGetData_VuoImageColorDepth()

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.

Definition at line 219 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListGetValue_VuoImageColorDepth()

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).

If iterating over an entire list, consider using VuoListGetData_VuoImageColorDepth or VuoListForeach_VuoImageColorDepth.

Definition at line 203 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListInsertValue_VuoImageColorDepth()

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.

Definition at line 276 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListPrependValue_VuoImageColorDepth()

void VuoListPrependValue_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list,
const VuoImageColorDepth  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListRemoveAll_VuoImageColorDepth()

void VuoListRemoveAll_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListRemoveFirstValue_VuoImageColorDepth()

void VuoListRemoveFirstValue_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListRemoveLastValue_VuoImageColorDepth()

void VuoListRemoveLastValue_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListRemoveValue_VuoImageColorDepth()

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.

Definition at line 536 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListReverse_VuoImageColorDepth()

void VuoListReverse_VuoImageColorDepth ( VuoList_VuoImageColorDepth  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListSetValue_VuoImageColorDepth()

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

Changes the VuoImageColorDepth 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_VuoImageColorDepth.cc.

◆ VuoListShuffle_VuoImageColorDepth()

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.

Definition at line 401 of file VuoList_VuoImageColorDepth.cc.

◆ VuoListSubset_VuoImageColorDepth()

VuoList_VuoImageColorDepth VuoListSubset_VuoImageColorDepth ( VuoList_VuoImageColorDepth  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_VuoImageColorDepth.cc.