Vuo  0.3
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions
Node Methods: Stateful

Description

Setup, event handler, and teardown methods to be implemented by stateful node classes.

Functions

struct nodeInstanceDatanodeInstanceInit (...)
 Called when a new instance of the node class is created.
 
void nodeInstanceEvent (...)
 Called for every push this node instance receives.
 
void nodeInstanceFini (struct nodeInstanceData *const context)
 Called when the specified node instance is no longer needed.
 

Function Documentation

void nodeInstanceEvent (   ...)

Called for every push this node instance receives.

Parameter decorations should include at least:

Parameter decorations may include:

void nodeInstanceFini ( struct nodeInstanceData *const  context)

Called when the specified node instance is no longer needed.

The implementation should free() whatever instance data was allocated in nodeInstanceInit().

struct nodeInstanceData* nodeInstanceInit (   ...)
read

Called when a new instance of the node class is created.

The implementation should malloc(), initialize, and return whatever instance data is required.

Parameter decorations may include:

  • VuoOutputGenerator — Stateful nodes may store references to generator functions in their instance data, in order to generate events at any time.