Description

Copyright: Copyright © 2012–2017 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see http://vuo.org/license.

Classes
struct	VuoCompositionState
	Runtime information about a composition or subcomposition. More...

Functions
struct VuoCompositionState *	vuoCreateCompositionState (void runtimeState, const char compositionIdentifier)
	Creates a composition state.

void *	vuoGetCompositionStateRuntimeState (struct VuoCompositionState *compositionState)
	Gets the composition state's `runtimeState` field.

const char *	vuoGetCompositionStateCompositionIdentifier (struct VuoCompositionState *compositionState)
	Gets the composition state's `compositionIdentifier` field.

void	vuoFreeCompositionState (struct VuoCompositionState *compositionState)
	Frees the composition state (but not its fields).

void	vuoAddCompositionStateToThreadLocalStorage (const struct VuoCompositionState *compositionState)
	Stores compositionState in thread-local storage, making it available via a call to vuoCopyCompositionStateFromThreadLocalStorage() on the same thread.

void	vuoRemoveCompositionStateFromThreadLocalStorage (void)
	Removes the stored composition state (if any) in thread-local storage, making it no longer available to vuoCopyCompositionStateFromThreadLocalStorage().

void *	vuoCopyCompositionStateFromThreadLocalStorage (void)
	Retrieves a copy of a composition state previously stored by vuoAddCompositionStateToThreadLocalStorage() on the current thread, or null if no composition state is found.

uint64_t	vuoGetCompositionUniqueIdentifier (const struct VuoCompositionState *compositionState)
	Returns a numerical ID for the composition that is unique process-wide and persists across live-coding reloads.

Variables
pthread_key_t	vuoCompositionStateKey
	Key used to store and retrieve composition state from thread-local state.

Class Documentation

struct VuoCompositionState

Class Members
const char *	compositionIdentifier	The identifier of this (sub)composition, unique among the top-level composition and its subcompositions.
void *	runtimeState	The VuoRuntimeState of the top-level composition.

void vuoAddCompositionStateToThreadLocalStorage ( const struct VuoCompositionState * compositionState )

Stores compositionState in thread-local storage, making it available via a call to vuoCopyCompositionStateFromThreadLocalStorage() on the same thread.

void* vuoCopyCompositionStateFromThreadLocalStorage ( void )

Retrieves a copy of a composition state previously stored by vuoAddCompositionStateToThreadLocalStorage() on the current thread, or null if no composition state is found.

The returned VuoCompositionState's compositionIdentifier field is null.

struct VuoCompositionState* vuoCreateCompositionState	(	void *	runtimeState,
		const char *	compositionIdentifier
	)

read

Creates a composition state.

The composition state does not take ownership of runtimeState or compositionIdentifier.

void vuoFreeCompositionState ( struct VuoCompositionState * compositionState )

Frees the composition state (but not its fields).

const char* vuoGetCompositionStateCompositionIdentifier ( struct VuoCompositionState * compositionState )

Gets the composition state's compositionIdentifier field.

void* vuoGetCompositionStateRuntimeState ( struct VuoCompositionState * compositionState )

Gets the composition state's runtimeState field.

uint64_t vuoGetCompositionUniqueIdentifier ( const struct VuoCompositionState * compositionState )

Returns a numerical ID for the composition that is unique process-wide and persists across live-coding reloads.

void vuoRemoveCompositionStateFromThreadLocalStorage ( void )

Removes the stored composition state (if any) in thread-local storage, making it no longer available to vuoCopyCompositionStateFromThreadLocalStorage().

pthread_key_t vuoCompositionStateKey

Key used to store and retrieve composition state from thread-local state.