User Facing Graph Parameters API

The Public Graph Parameters API. More...

Functions
VX_API_ENTRY vx_status VX_API_CALL	vxAddParameterToGraph (vx_graph graph, vx_parameter parameter)
	Adds the given parameter extracted from a vx_node to the graph.
VX_API_ENTRY vx_status VX_API_CALL	vxSetGraphParameterByIndex (vx_graph graph, vx_uint32 index, vx_reference value)
	Sets a reference to the parameter on the graph. The implementation must set this parameter on the originating node as well.
VX_API_ENTRY vx_parameter VX_API_CALL	vxGetGraphParameterByIndex (vx_graph graph, vx_uint32 index)
	Retrieves a vx_parameter from a vx_graph.

Detailed Description

The Public Graph Parameters API.

Function Documentation

vxAddParameterToGraph()

VX_API_ENTRY vx_status VX_API_CALL vxAddParameterToGraph	(	vx_graph	graph,
		vx_parameter	parameter )

#include <vx_api.h>

Adds the given parameter extracted from a vx_node to the graph.

Parameters

[in]	graph	The graph reference that contains the node.
[in]	parameter	The parameter reference to add to the graph from the node.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	Parameter added to Graph; any other value indicates failure.
VX_ERROR_INVALID_REFERENCE	graph is not a valid vx_graph reference or parameter is not a valid vx_parameter reference.
VX_ERROR_INVALID_PARAMETERS	The parameter is of a node not in this graph.

vxGetGraphParameterByIndex()

VX_API_ENTRY vx_parameter VX_API_CALL vxGetGraphParameterByIndex	(	vx_graph	graph,
		vx_uint32	index )

#include <vx_api.h>

Retrieves a vx_parameter from a vx_graph.

Parameters

[in]	graph	The graph.
[in]	index	The index of the parameter.

Returns

vx_parameter reference. Any possible errors preventing a successful function completion should be checked using vxGetStatus.

vxSetGraphParameterByIndex()

VX_API_ENTRY vx_status VX_API_CALL vxSetGraphParameterByIndex	(	vx_graph	graph,
		vx_uint32	index,
		vx_reference	value )

#include <vx_api.h>

Sets a reference to the parameter on the graph. The implementation must set this parameter on the originating node as well.

Parameters

[in]	graph	The graph reference.
[in]	index	The parameter index.
[in]	value	The reference to set to the parameter.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	Parameter set to Graph; any other value indicates failure.
VX_ERROR_INVALID_REFERENCE	graph is not a valid vx_graph reference or value is not a valid vx_reference.
VX_ERROR_INVALID_PARAMETERS	The parameter index is out of bounds or the dir parameter is incorrect.