Vuo
1.2.5
|
VuoCompositionState interface.
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 vuoGetCompositionStateFromThreadLocalStorage() on the same thread. | |
void | vuoRemoveCompositionStateFromThreadLocalStorage (void) |
Removes the stored composition state (if any) in thread-local storage, making it no longer available to vuoGetCompositionStateFromThreadLocalStorage(). | |
const void * | vuoGetCompositionStateFromThreadLocalStorage (void) |
Retrieves a composition state previously stored by vuoAddCompositionStateToThreadLocalStorage() on the current thread. | |
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. | |
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 vuoGetCompositionStateFromThreadLocalStorage() on the same thread.
|
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.
const void* vuoGetCompositionStateFromThreadLocalStorage | ( | void | ) |
Retrieves a composition state previously stored by vuoAddCompositionStateToThreadLocalStorage() on the current thread.
The caller should not save the returned VuoCompositionState
for later, since it may be destroyed by the function that originally added it to thread-local storage. Nor should the caller save any of the fields of the returned VuoCompositionState
, since they may be destroyed by another function or a live-coding reload.
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 vuoGetCompositionStateFromThreadLocalStorage().
pthread_key_t vuoCompositionStateKey |
Key used to store and retrieve composition state from thread-local state.