vx_khr_pipelining.h File Reference

The OpenVX Pipelining, Streaming and Batch Processing extension API. More...

#include <VX/vx.h>

Classes
struct	vx_graph_parameter_queue_params_t
	Queueing parameters for a specific graph parameter. More...
struct	_vx_event_graph_parameter_consumed
	Parameter structure returned with event of type VX_EVENT_GRAPH_PARAMETER_CONSUMED. More...
struct	_vx_event_graph_completed
	Parameter structure returned with event of type VX_EVENT_GRAPH_COMPLETED. More...
struct	_vx_event_node_completed
	Parameter structure returned with event of type VX_EVENT_NODE_COMPLETED. More...
struct	_vx_event_node_error
	Parameter structure returned with event of type VX_EVENT_NODE_ERROR. More...
struct	_vx_event_user_event
	Parameter structure returned with event of type VX_EVENT_USER_EVENT. More...
union	_vx_event_info_t
	Parameter structure associated with an event. Depends on type of the event. More...
struct	_vx_event
	Data structure which holds event information. More...

Macros
#define	OPENVX_KHR_PIPELINING   "vx_khr_pipelining"
#define	VX_LIBRARY_KHR_PIPELINING_EXTENSION   (0x1)
	The Pipelining, Streaming and Batch Processing Extension Library Set.

Typedefs
typedef struct _vx_event_graph_parameter_consumed	vx_event_graph_parameter_consumed
	Parameter structure returned with event of type VX_EVENT_GRAPH_PARAMETER_CONSUMED.
typedef struct _vx_event_graph_completed	vx_event_graph_completed
	Parameter structure returned with event of type VX_EVENT_GRAPH_COMPLETED.
typedef struct _vx_event_node_completed	vx_event_node_completed
	Parameter structure returned with event of type VX_EVENT_NODE_COMPLETED.
typedef struct _vx_event_node_error	vx_event_node_error
	Parameter structure returned with event of type VX_EVENT_NODE_ERROR.
typedef struct _vx_event_user_event	vx_event_user_event
	Parameter structure returned with event of type VX_EVENT_USER_EVENT.
typedef union _vx_event_info_t	vx_event_info_t
	Parameter structure associated with an event. Depends on type of the event.
typedef struct _vx_event	vx_event_t
	Data structure which holds event information.

Enumerations
enum	vx_graph_schedule_mode_enum_e { VX_ENUM_GRAPH_SCHEDULE_MODE_TYPE = 0x21 }
	Extra enums. More...
enum	vx_graph_schedule_mode_type_e {   VX_GRAPH_SCHEDULE_MODE_NORMAL = ((( VX_ID_KHRONOS ) << 20) | ( VX_ENUM_GRAPH_SCHEDULE_MODE_TYPE << 12)) + 0x0 ,   VX_GRAPH_SCHEDULE_MODE_QUEUE_AUTO = ((( VX_ID_KHRONOS ) << 20) | ( VX_ENUM_GRAPH_SCHEDULE_MODE_TYPE << 12)) + 0x1 ,   VX_GRAPH_SCHEDULE_MODE_QUEUE_MANUAL = ((( VX_ID_KHRONOS ) << 20) | ( VX_ENUM_GRAPH_SCHEDULE_MODE_TYPE << 12)) + 0x2 }
	Type of graph scheduling mode. More...
enum	vx_graph_attribute_pipelining_e { VX_GRAPH_SCHEDULE_MODE = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_GRAPH) + 0x5 }
	The graph attributes added by this extension. More...
enum	vx_event_enum_e { VX_ENUM_EVENT_TYPE = 0x22 }
	Extra enums. More...
enum	vx_event_type_e {   VX_EVENT_GRAPH_PARAMETER_CONSUMED = ((( VX_ID_KHRONOS ) << 20) | ( VX_ENUM_EVENT_TYPE << 12)) + 0x0 ,   VX_EVENT_GRAPH_COMPLETED = ((( VX_ID_KHRONOS ) << 20) | ( VX_ENUM_EVENT_TYPE << 12)) + 0x1 ,   VX_EVENT_NODE_COMPLETED = ((( VX_ID_KHRONOS ) << 20) | ( VX_ENUM_EVENT_TYPE << 12)) + 0x2 ,   VX_EVENT_NODE_ERROR = ((( VX_ID_KHRONOS ) << 20) | ( VX_ENUM_EVENT_TYPE << 12)) + 0x3 ,   VX_EVENT_USER = ((( VX_ID_KHRONOS ) << 20) | ( VX_ENUM_EVENT_TYPE << 12)) + 0x4 }
	Type of event that can be generated during system execution. More...
enum	vx_node_state_enum_e { VX_ENUM_NODE_STATE_TYPE = 0x23 }
	Extra enums. More...
enum	vx_node_state_e {   VX_NODE_STATE_STEADY = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_NODE_STATE_TYPE) + 0x0 ,   VX_NODE_STATE_PIPEUP = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_NODE_STATE_TYPE) + 0x1 }
	Node state. More...
enum	vx_node_attribute_streaming_e { VX_NODE_STATE = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_NODE) + 0xA }
	The node attributes added by this extension. More...
enum	vx_kernel_attribute_streaming_e {   VX_KERNEL_PIPEUP_OUTPUT_DEPTH = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_KERNEL) + 0x5 ,   VX_KERNEL_PIPEUP_INPUT_DEPTH = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_KERNEL) + 0x6 }
	The kernel attributes added by this extension. More...

Functions
VX_API_ENTRY vx_status VX_API_CALL	vxSetGraphScheduleConfig (vx_graph graph, vx_enum graph_schedule_mode, vx_uint32 graph_parameters_list_size, const vx_graph_parameter_queue_params_t graph_parameters_queue_params_list[])
	Sets the graph scheduler config.
VX_API_ENTRY vx_status VX_API_CALL	vxGraphParameterEnqueueReadyRef (vx_graph graph, vx_uint32 graph_parameter_index, vx_reference *refs, vx_uint32 num_refs)
	Enqueues new references into a graph parameter for processing.
VX_API_ENTRY vx_status VX_API_CALL	vxGraphParameterDequeueDoneRef (vx_graph graph, vx_uint32 graph_parameter_index, vx_reference *refs, vx_uint32 max_refs, vx_uint32 *num_refs)
	Dequeues 'consumed' references from a graph parameter.
VX_API_ENTRY vx_status VX_API_CALL	vxGraphParameterCheckDoneRef (vx_graph graph, vx_uint32 graph_parameter_index, vx_uint32 *num_refs)
	Checks and returns the number of references that are ready for dequeue.
VX_API_ENTRY vx_status VX_API_CALL	vxWaitEvent (vx_context context, vx_event_t *event, vx_bool do_not_block)
	Wait for a single event.
VX_API_ENTRY vx_status VX_API_CALL	vxEnableEvents (vx_context context)
	Enable event generation.
VX_API_ENTRY vx_status VX_API_CALL	vxDisableEvents (vx_context context)
	Disable event generation.
VX_API_ENTRY vx_status VX_API_CALL	vxSendUserEvent (vx_context context, vx_uint32 app_value, void *parameter)
	Generate user defined event.
VX_API_ENTRY vx_status VX_API_CALL	vxRegisterEvent (vx_reference ref, enum vx_event_type_e type, vx_uint32 param, vx_uint32 app_value)
	Register an event to be generated.
VX_API_ENTRY vx_status VX_API_CALL	vxEnableGraphStreaming (vx_graph graph, vx_node trigger_node)
	Enable streaming mode of graph execution.
VX_API_ENTRY vx_status VX_API_CALL	vxStartGraphStreaming (vx_graph graph)
	Start streaming mode of graph execution.
VX_API_ENTRY vx_status VX_API_CALL	vxStopGraphStreaming (vx_graph graph)
	Stop streaming mode of graph execution.

Detailed Description

The OpenVX Pipelining, Streaming and Batch Processing extension API.

Macro Definition Documentation

OPENVX_KHR_PIPELINING

#define OPENVX_KHR_PIPELINING   "vx_khr_pipelining"