Vuo  2.3.2
Classes | Typedefs | Functions
VuoList_VuoBlendMode

Description

A list of VuoBlendMode elements.

Classes

struct  VuoList_VuoBlendMode_struct
 List type. More...
 

Typedefs

typedef const struct VuoList_VuoBlendMode_structVuoList_VuoBlendMode
 A list of VuoBlendMode elements. More...
 

Functions

VuoList_VuoBlendMode VuoListCreate_VuoBlendMode (void)
 Creates a new list of VuoBlendMode elements. More...
 
VuoList_VuoBlendMode VuoListCreateWithCount_VuoBlendMode (const unsigned long count, const VuoBlendMode value)
 Creates a new list of count instances of value. More...
 
VuoList_VuoBlendMode VuoListCopy_VuoBlendMode (const VuoList_VuoBlendMode list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
 
VuoBlendMode VuoListGetValue_VuoBlendMode (const VuoList_VuoBlendMode list, const unsigned long index)
 Returns the VuoBlendMode at index. More...
 
VuoBlendModeVuoListGetData_VuoBlendMode (const VuoList_VuoBlendMode list)
 Returns a pointer to a C array containing the list items. More...
 
void VuoListForeach_VuoBlendMode (const VuoList_VuoBlendMode list, bool(^function)(const VuoBlendMode value))
 Applies function to each of list's items, serially in order of index. More...
 
void VuoListSetValue_VuoBlendMode (const VuoList_VuoBlendMode list, const VuoBlendMode value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoBlendMode at index. More...
 
void VuoListInsertValue_VuoBlendMode (const VuoList_VuoBlendMode list, const VuoBlendMode value, const unsigned long index)
 Inserts the VuoBlendMode immediately before index. More...
 
void VuoListPrependValue_VuoBlendMode (VuoList_VuoBlendMode list, const VuoBlendMode value)
 Prepends value to list. More...
 
void VuoListAppendValue_VuoBlendMode (VuoList_VuoBlendMode list, const VuoBlendMode value)
 Appends value to list. More...
 
void VuoListExchangeValues_VuoBlendMode (VuoList_VuoBlendMode list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB. More...
 
void VuoListShuffle_VuoBlendMode (VuoList_VuoBlendMode list, const double chaos)
 Generates a random permutation of list. More...
 
void VuoListReverse_VuoBlendMode (VuoList_VuoBlendMode list)
 Reverses the order of the items in list. More...
 
VuoList_VuoBlendMode VuoListSubset_VuoBlendMode (VuoList_VuoBlendMode 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_VuoBlendMode (VuoList_VuoBlendMode list)
 Removes the first value from list. More...
 
void VuoListRemoveLastValue_VuoBlendMode (VuoList_VuoBlendMode list)
 Removes the last value from list. More...
 
void VuoListRemoveAll_VuoBlendMode (VuoList_VuoBlendMode list)
 Removes all values from list. More...
 
void VuoListRemoveValue_VuoBlendMode (VuoList_VuoBlendMode list, const unsigned long index)
 Removes the VuoBlendMode at index. More...
 
unsigned long VuoListGetCount_VuoBlendMode (const VuoList_VuoBlendMode list)
 Returns the number of elements in list. More...
 
VuoList_VuoBlendMode VuoList_VuoBlendMode_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoList_VuoBlendMode_getJson (const VuoList_VuoBlendMode value)
 Encodes value as a JSON object. More...
 
char * VuoList_VuoBlendMode_getSummary (const VuoList_VuoBlendMode value)
 Produces a brief human-readable summary of value. More...
 
VuoList_VuoBlendMode VuoList_VuoBlendMode_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoList_VuoBlendMode_getString (const VuoList_VuoBlendMode value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoList_VuoBlendMode_struct

struct VuoList_VuoBlendMode_struct
Class Members
void * l

Typedef Documentation

◆ VuoList_VuoBlendMode

A list of VuoBlendMode elements.

Function Documentation

◆ VuoList_VuoBlendMode_getJson()

struct json_object* VuoList_VuoBlendMode_getJson ( const VuoList_VuoBlendMode  value)

Encodes value as a JSON object.

Definition at line 84 of file VuoList_VuoBlendMode.cc.

◆ VuoList_VuoBlendMode_getString()

char* VuoList_VuoBlendMode_getString ( const VuoList_VuoBlendMode  value)

Automatically generated function.

◆ VuoList_VuoBlendMode_getSummary()

char* VuoList_VuoBlendMode_getSummary ( const VuoList_VuoBlendMode  value)

Produces a brief human-readable summary of value.

Definition at line 119 of file VuoList_VuoBlendMode.cc.

◆ VuoList_VuoBlendMode_makeFromJson()

VuoList_VuoBlendMode VuoList_VuoBlendMode_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_VuoBlendMode.cc.

◆ VuoList_VuoBlendMode_makeFromString()

VuoList_VuoBlendMode VuoList_VuoBlendMode_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoListAppendValue_VuoBlendMode()

void VuoListAppendValue_VuoBlendMode ( VuoList_VuoBlendMode  list,
const VuoBlendMode  value 
)

Appends value to list.

Definition at line 308 of file VuoList_VuoBlendMode.cc.

◆ VuoListCopy_VuoBlendMode()

VuoList_VuoBlendMode VuoListCopy_VuoBlendMode ( const VuoList_VuoBlendMode  list)

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

Definition at line 174 of file VuoList_VuoBlendMode.cc.

◆ VuoListCreate_VuoBlendMode()

VuoList_VuoBlendMode VuoListCreate_VuoBlendMode ( void  )

Creates a new list of VuoBlendMode elements.

Definition at line 154 of file VuoList_VuoBlendMode.cc.

◆ VuoListCreateWithCount_VuoBlendMode()

VuoList_VuoBlendMode VuoListCreateWithCount_VuoBlendMode ( const unsigned long  count,
const VuoBlendMode  value 
)

Creates a new list of count instances of value.

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

Definition at line 161 of file VuoList_VuoBlendMode.cc.

◆ VuoListExchangeValues_VuoBlendMode()

void VuoListExchangeValues_VuoBlendMode ( VuoList_VuoBlendMode  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_VuoBlendMode.cc.

◆ VuoListForeach_VuoBlendMode()

void VuoListForeach_VuoBlendMode ( const VuoList_VuoBlendMode  list,
bool(^)(const VuoBlendMode 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_VuoBlendMode.cc.

◆ VuoListGetCount_VuoBlendMode()

unsigned long VuoListGetCount_VuoBlendMode ( const VuoList_VuoBlendMode  list)

Returns the number of elements in list.

Definition at line 553 of file VuoList_VuoBlendMode.cc.

◆ VuoListGetData_VuoBlendMode()

VuoBlendMode* VuoListGetData_VuoBlendMode ( const VuoList_VuoBlendMode  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_VuoBlendMode.cc.

◆ VuoListGetValue_VuoBlendMode()

VuoBlendMode VuoListGetValue_VuoBlendMode ( const VuoList_VuoBlendMode  list,
const unsigned long  index 
)

Returns the VuoBlendMode 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_VuoBlendMode or VuoListForeach_VuoBlendMode.

Definition at line 203 of file VuoList_VuoBlendMode.cc.

◆ VuoListInsertValue_VuoBlendMode()

void VuoListInsertValue_VuoBlendMode ( const VuoList_VuoBlendMode  list,
const VuoBlendMode  value,
const unsigned long  index 
)

Inserts the VuoBlendMode 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_VuoBlendMode.cc.

◆ VuoListPrependValue_VuoBlendMode()

void VuoListPrependValue_VuoBlendMode ( VuoList_VuoBlendMode  list,
const VuoBlendMode  value 
)

Prepends value to list.

Definition at line 298 of file VuoList_VuoBlendMode.cc.

◆ VuoListRemoveAll_VuoBlendMode()

void VuoListRemoveAll_VuoBlendMode ( VuoList_VuoBlendMode  list)

Removes all values from list.

Definition at line 527 of file VuoList_VuoBlendMode.cc.

◆ VuoListRemoveFirstValue_VuoBlendMode()

void VuoListRemoveFirstValue_VuoBlendMode ( VuoList_VuoBlendMode  list)

Removes the first value from list.

Definition at line 499 of file VuoList_VuoBlendMode.cc.

◆ VuoListRemoveLastValue_VuoBlendMode()

void VuoListRemoveLastValue_VuoBlendMode ( VuoList_VuoBlendMode  list)

Removes the last value from list.

Definition at line 513 of file VuoList_VuoBlendMode.cc.

◆ VuoListRemoveValue_VuoBlendMode()

void VuoListRemoveValue_VuoBlendMode ( VuoList_VuoBlendMode  list,
const unsigned long  index 
)

Removes the VuoBlendMode 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_VuoBlendMode.cc.

◆ VuoListReverse_VuoBlendMode()

void VuoListReverse_VuoBlendMode ( VuoList_VuoBlendMode  list)

Reverses the order of the items in list.

Definition at line 422 of file VuoList_VuoBlendMode.cc.

◆ VuoListSetValue_VuoBlendMode()

void VuoListSetValue_VuoBlendMode ( const VuoList_VuoBlendMode  list,
const VuoBlendMode  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoBlendMode 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_VuoBlendMode.cc.

◆ VuoListShuffle_VuoBlendMode()

void VuoListShuffle_VuoBlendMode ( VuoList_VuoBlendMode  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_VuoBlendMode.cc.

◆ VuoListSubset_VuoBlendMode()

VuoList_VuoBlendMode VuoListSubset_VuoBlendMode ( VuoList_VuoBlendMode  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_VuoBlendMode.cc.