Description

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

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

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

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

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

static void	__attribute__ ((constructor))
	Initializes `vuoCompositionStateKey`. More...

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

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

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

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

Function Documentation

◆ attribute()

static void __attribute__ ( (constructor) )

static

Initializes vuoCompositionStateKey.

◆ vuoAddCompositionStateToThreadLocalStorage()

void vuoAddCompositionStateToThreadLocalStorage ( const struct VuoCompositionState * compositionState )

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

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

The returned VuoCompositionState's compositionIdentifier field is null.

◆ vuoCreateCompositionState()

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

Creates a composition state.

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

◆ vuoFreeCompositionState()

void vuoFreeCompositionState ( struct VuoCompositionState * compositionState )

Frees the composition state (but not its fields).

◆ vuoGetCompositionStateCompositionIdentifier()

const char* vuoGetCompositionStateCompositionIdentifier ( struct VuoCompositionState * compositionState )

Gets the composition state's compositionIdentifier field.

◆ vuoGetCompositionStateRuntimeState()

void* vuoGetCompositionStateRuntimeState ( struct VuoCompositionState * compositionState )

Gets the composition state's runtimeState field.

◆ vuoRemoveCompositionStateFromThreadLocalStorage()

void vuoRemoveCompositionStateFromThreadLocalStorage ( void )

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

Variable Documentation

◆ vuoCompositionStateKey

pthread_key_t vuoCompositionStateKey

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