VuoList_VuoBlackmagicOutputDevice

Description

A list of VuoBlackmagicOutputDevice elements.

Classes
struct	VuoList_VuoBlackmagicOutputDevice_struct
	A list of VuoBlackmagicOutputDevice elements. More...

Typedefs
typedef const struct VuoList_VuoBlackmagicOutputDevice_struct *	VuoList_VuoBlackmagicOutputDevice
	A list of VuoBlackmagicOutputDevice elements. More...

Functions
VuoList_VuoBlackmagicOutputDevice	VuoListCreate_VuoBlackmagicOutputDevice (void)
	Creates a new list of VuoBlackmagicOutputDevice elements. More...
VuoList_VuoBlackmagicOutputDevice	VuoListCreateWithCount_VuoBlackmagicOutputDevice (const unsigned long count, const VuoBlackmagicOutputDevice value)
	Creates a new list of count instances of value. More...
VuoList_VuoBlackmagicOutputDevice	VuoListCopy_VuoBlackmagicOutputDevice (const VuoList_VuoBlackmagicOutputDevice list)
	Makes a shallow copy of list — its items are retained (not copied) by the new list. More...
VuoBlackmagicOutputDevice	VuoListGetValue_VuoBlackmagicOutputDevice (const VuoList_VuoBlackmagicOutputDevice list, const unsigned long index)
	Returns the VuoBlackmagicOutputDevice at index. More...
VuoBlackmagicOutputDevice *	VuoListGetData_VuoBlackmagicOutputDevice (const VuoList_VuoBlackmagicOutputDevice list)
	Returns a pointer to a C array containing the list items. More...
void	VuoListSetValue_VuoBlackmagicOutputDevice (const VuoList_VuoBlackmagicOutputDevice list, const VuoBlackmagicOutputDevice value, const unsigned long index, bool expandListIfNeeded)
	Changes the VuoBlackmagicOutputDevice at index. More...
void	VuoListInsertValue_VuoBlackmagicOutputDevice (const VuoList_VuoBlackmagicOutputDevice list, const VuoBlackmagicOutputDevice value, const unsigned long index)
	Inserts the VuoBlackmagicOutputDevice immediately before index. More...
void	VuoListPrependValue_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice list, const VuoBlackmagicOutputDevice value)
	Prepends value to list. More...
void	VuoListAppendValue_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice list, const VuoBlackmagicOutputDevice value)
	Appends value to list. More...
void	VuoListExchangeValues_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice list, const unsigned long indexA, const unsigned long indexB)
	Swaps the value at indexA with the value at indexB. More...
void	VuoListShuffle_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice list, const double chaos)
	Generates a random permutation of list. More...
void	VuoListReverse_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice list)
	Reverses the order of the items in list. More...
VuoList_VuoBlackmagicOutputDevice	VuoListSubset_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice 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_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice list)
	Removes the first value from list. More...
void	VuoListRemoveLastValue_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice list)
	Removes the last value from list. More...
void	VuoListRemoveAll_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice list)
	Removes all values from list. More...
void	VuoListRemoveValue_VuoBlackmagicOutputDevice (VuoList_VuoBlackmagicOutputDevice list, const unsigned long index)
	Removes the VuoBlackmagicOutputDevice at index. More...
unsigned long	VuoListGetCount_VuoBlackmagicOutputDevice (const VuoList_VuoBlackmagicOutputDevice list)
	Returns the number of elements in list. More...
VuoList_VuoBlackmagicOutputDevice	VuoList_VuoBlackmagicOutputDevice_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value. More...
struct json_object *	VuoList_VuoBlackmagicOutputDevice_getJson (const VuoList_VuoBlackmagicOutputDevice value)
	Encodes value as a JSON object. More...
char *	VuoList_VuoBlackmagicOutputDevice_getSummary (const VuoList_VuoBlackmagicOutputDevice value)
	Produces a brief human-readable summary of value. More...
VuoList_VuoBlackmagicOutputDevice	VuoList_VuoBlackmagicOutputDevice_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoList_VuoBlackmagicOutputDevice_getString (const VuoList_VuoBlackmagicOutputDevice value)
	Automatically generated function. More...

---

Class Documentation

VuoList_VuoBlackmagicOutputDevice_struct

struct VuoList_VuoBlackmagicOutputDevice_struct

Class Members
void *	l

Typedef Documentation

VuoList_VuoBlackmagicOutputDevice

typedef const struct VuoList_VuoBlackmagicOutputDevice_struct * VuoList_VuoBlackmagicOutputDevice

A list of VuoBlackmagicOutputDevice elements.

Function Documentation

VuoList_VuoBlackmagicOutputDevice_getJson()

struct json_object* VuoList_VuoBlackmagicOutputDevice_getJson

(

const VuoList_VuoBlackmagicOutputDevice

value

)

Encodes value as a JSON object.

VuoList_VuoBlackmagicOutputDevice_getString()

char* VuoList_VuoBlackmagicOutputDevice_getString

(

const VuoList_VuoBlackmagicOutputDevice

value

)

Automatically generated function.

VuoList_VuoBlackmagicOutputDevice_getSummary()

char* VuoList_VuoBlackmagicOutputDevice_getSummary

(

const VuoList_VuoBlackmagicOutputDevice

value

)

Produces a brief human-readable summary of value.

VuoList_VuoBlackmagicOutputDevice_makeFromJson()

VuoList_VuoBlackmagicOutputDevice VuoList_VuoBlackmagicOutputDevice_makeFromJson

(

struct json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

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

VuoList_VuoBlackmagicOutputDevice_makeFromString()

VuoList_VuoBlackmagicOutputDevice VuoList_VuoBlackmagicOutputDevice_makeFromString

(

const char *

str

)

Automatically generated function.

VuoListAppendValue_VuoBlackmagicOutputDevice()

void VuoListAppendValue_VuoBlackmagicOutputDevice	(	VuoList_VuoBlackmagicOutputDevice	list,
		const VuoBlackmagicOutputDevice	value
	)

Appends value to list.

VuoListCopy_VuoBlackmagicOutputDevice()

VuoList_VuoBlackmagicOutputDevice VuoListCopy_VuoBlackmagicOutputDevice

(

const VuoList_VuoBlackmagicOutputDevice

list

)

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

VuoListCreate_VuoBlackmagicOutputDevice()

VuoList_VuoBlackmagicOutputDevice VuoListCreate_VuoBlackmagicOutputDevice

(

void

)

Creates a new list of VuoBlackmagicOutputDevice elements.

VuoListCreateWithCount_VuoBlackmagicOutputDevice()

VuoList_VuoBlackmagicOutputDevice VuoListCreateWithCount_VuoBlackmagicOutputDevice	(	const unsigned long	count,
		const VuoBlackmagicOutputDevice	value
	)

Creates a new list of count instances of value.

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

VuoListExchangeValues_VuoBlackmagicOutputDevice()

void VuoListExchangeValues_VuoBlackmagicOutputDevice	(	VuoList_VuoBlackmagicOutputDevice	list,
		const unsigned long	indexA,
		const unsigned long	indexB
	)

Swaps the value at indexA with the value at indexB.

VuoListGetCount_VuoBlackmagicOutputDevice()

unsigned long VuoListGetCount_VuoBlackmagicOutputDevice

(

const VuoList_VuoBlackmagicOutputDevice

list

)

Returns the number of elements in list.

VuoListGetData_VuoBlackmagicOutputDevice()

VuoBlackmagicOutputDevice* VuoListGetData_VuoBlackmagicOutputDevice

(

const VuoList_VuoBlackmagicOutputDevice

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.

VuoListGetValue_VuoBlackmagicOutputDevice()

VuoBlackmagicOutputDevice VuoListGetValue_VuoBlackmagicOutputDevice	(	const VuoList_VuoBlackmagicOutputDevice	list,
		const unsigned long	index
	)

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

VuoListInsertValue_VuoBlackmagicOutputDevice()

void VuoListInsertValue_VuoBlackmagicOutputDevice	(	const VuoList_VuoBlackmagicOutputDevice	list,
		const VuoBlackmagicOutputDevice	value,
		const unsigned long	index
	)

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

VuoListPrependValue_VuoBlackmagicOutputDevice()

void VuoListPrependValue_VuoBlackmagicOutputDevice	(	VuoList_VuoBlackmagicOutputDevice	list,
		const VuoBlackmagicOutputDevice	value
	)

Prepends value to list.

VuoListRemoveAll_VuoBlackmagicOutputDevice()

void VuoListRemoveAll_VuoBlackmagicOutputDevice

(

VuoList_VuoBlackmagicOutputDevice

list

)

Removes all values from list.

VuoListRemoveFirstValue_VuoBlackmagicOutputDevice()

void VuoListRemoveFirstValue_VuoBlackmagicOutputDevice

(

VuoList_VuoBlackmagicOutputDevice

list

)

Removes the first value from list.

VuoListRemoveLastValue_VuoBlackmagicOutputDevice()

void VuoListRemoveLastValue_VuoBlackmagicOutputDevice

(

VuoList_VuoBlackmagicOutputDevice

list

)

Removes the last value from list.

VuoListRemoveValue_VuoBlackmagicOutputDevice()

void VuoListRemoveValue_VuoBlackmagicOutputDevice	(	VuoList_VuoBlackmagicOutputDevice	list,
		const unsigned long	index
	)

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

VuoListReverse_VuoBlackmagicOutputDevice()

void VuoListReverse_VuoBlackmagicOutputDevice

(

VuoList_VuoBlackmagicOutputDevice

list

)

Reverses the order of the items in list.

VuoListSetValue_VuoBlackmagicOutputDevice()

void VuoListSetValue_VuoBlackmagicOutputDevice	(	const VuoList_VuoBlackmagicOutputDevice	list,
		const VuoBlackmagicOutputDevice	value,
		const unsigned long	index,
		bool	expandListIfNeeded
	)

Changes the VuoBlackmagicOutputDevice 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.

VuoListShuffle_VuoBlackmagicOutputDevice()

void VuoListShuffle_VuoBlackmagicOutputDevice	(	VuoList_VuoBlackmagicOutputDevice	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.

VuoListSubset_VuoBlackmagicOutputDevice()

VuoList_VuoBlackmagicOutputDevice VuoListSubset_VuoBlackmagicOutputDevice	(	VuoList_VuoBlackmagicOutputDevice	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.