User Facing Node Callback API

The Public Node Callback API. More...

Typedefs
typedef vx_enum	vx_action
	The formal typedef of the response from the callback.
typedef vx_action(VX_CALLBACK *	vx_nodecomplete_f) (vx_node node)
	A callback to the client after a particular node has completed.

Enumerations
enum	vx_action_e {   VX_ACTION_CONTINUE = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_ACTION) + 0x0 ,   VX_ACTION_ABANDON = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_ACTION) + 0x1 }
	A return code enumeration from a vx_nodecomplete_f during execution. More...

Functions
VX_API_ENTRY vx_status VX_API_CALL	vxAssignNodeCallback (vx_node node, vx_nodecomplete_f callback)
	Assigns a callback to a node. If a callback already exists in this node, this function must return an error and the user may clear the callback by passing a NULL pointer as the callback.
VX_API_ENTRY vx_nodecomplete_f VX_API_CALL	vxRetrieveNodeCallback (vx_node node)
	Retrieves the current node callback function pointer set on the node.

Detailed Description

The Public Node Callback API.

Typedef Documentation

vx_action

typedef vx_enum vx_action

#include <vx_types.h>

The formal typedef of the response from the callback.

See also

vx_action_e

vx_nodecomplete_f

typedef vx_action(VX_CALLBACK * vx_nodecomplete_f) (vx_node node)

#include <vx_types.h>

A callback to the client after a particular node has completed.

See also

vx_action

vxAssignNodeCallback

Parameters

[in]

node

The node to which the callback was attached.

Returns

An action code from vx_action_e.

Enumeration Type Documentation

vx_action_e

enum vx_action_e

#include <vx_types.h>

A return code enumeration from a vx_nodecomplete_f during execution.

See also

vxAssignNodeCallback

Enumerator
VX_ACTION_CONTINUE	Continue executing the graph with no changes.
VX_ACTION_ABANDON	Stop executing the graph.

Function Documentation

vxAssignNodeCallback()

VX_API_ENTRY vx_status VX_API_CALL vxAssignNodeCallback	(	vx_node	node,
		vx_nodecomplete_f	callback )

#include <vx_api.h>

Assigns a callback to a node. If a callback already exists in this node, this function must return an error and the user may clear the callback by passing a NULL pointer as the callback.

Parameters

[in]	node	The reference to the node.
[in]	callback	The callback to associate with completion of this specific node.

Warning

This must be used with extreme caution as it can ruin optimizations in the power/performance efficiency of a graph.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	Callback assigned; any other value indicates failure.
VX_ERROR_INVALID_REFERENCE	node is not a valid vx_node reference.

vxRetrieveNodeCallback()

VX_API_ENTRY vx_nodecomplete_f VX_API_CALL vxRetrieveNodeCallback

(

vx_node

node

)

#include <vx_api.h>

Retrieves the current node callback function pointer set on the node.

Parameters

[in]

node

The reference to the vx_node object.

Returns

vx_nodecomplete_f The pointer to the callback function.

Return values

NULL	No callback is set.
*	The node callback function.