vx_khr_user_data_object.h File Reference

The OpenVX User Data Object extension API. More...

#include <VX/vx.h>

Go to the source code of this file.

Macros
#define	VX_TYPE_USER_DATA_OBJECT   0x816
	The object type enumeration for user data object. More...

Typedefs
typedef struct _vx_user_data_object *	vx_user_data_object
	The User Data Object. User Data Object is a strongly-typed container for other data structures.

Enumerations
enum	vx_user_data_object_attribute_e {   VX_USER_DATA_OBJECT_NAME = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_USER_DATA_OBJECT) + 0x0,   VX_USER_DATA_OBJECT_SIZE = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_USER_DATA_OBJECT) + 0x1,   VX_USER_DATA_OBJECT_VALID_SIZE = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_USER_DATA_OBJECT) + 0x2 }
	The user data object attributes. More...

Functions
VX_API_ENTRY vx_user_data_object VX_API_CALL	vxCreateUserDataObject (vx_context context, const vx_char *type_name, vx_size size, const void *ptr)
	Creates a reference to a User Data Object. More...
VX_API_ENTRY vx_user_data_object VX_API_CALL	vxCreateVirtualUserDataObject (vx_graph graph, const vx_char *type_name, vx_size size)
	Creates an opaque reference to a virtual User Data Object with no direct user access. More...
VX_API_ENTRY vx_status VX_API_CALL	vxReleaseUserDataObject (vx_user_data_object *user_data_object)
	Releases a reference of a User data object. The object may not be garbage collected until its total reference count is zero. After returning from this function the reference is zeroed. More...
VX_API_ENTRY vx_status VX_API_CALL	vxQueryUserDataObject (vx_user_data_object user_data_object, vx_enum attribute, void *ptr, vx_size size)
	Queries the User data object for some specific information. More...
VX_API_ENTRY vx_status VX_API_CALL	vxSetUserDataObjectAttribute (vx_user_data_object user_data_object, vx_enum attribute, const void *ptr, vx_size size)
	Sets an attribute in the User data object. More...
VX_API_ENTRY vx_status VX_API_CALL	vxCopyUserDataObject (vx_user_data_object user_data_object, vx_size offset, vx_size size, void *user_ptr, vx_enum usage, vx_enum user_mem_type)
	Allows the application to copy a subset from/into a user data object. More...
VX_API_ENTRY vx_status VX_API_CALL	vxMapUserDataObject (vx_user_data_object user_data_object, vx_size offset, vx_size size, vx_map_id *map_id, void **ptr, vx_enum usage, vx_enum mem_type, vx_uint32 flags)
	Allows the application to get direct access to a subset of the user data object. More...
VX_API_ENTRY vx_status VX_API_CALL	vxUnmapUserDataObject (vx_user_data_object user_data_object, vx_map_id map_id)
	Unmap and commit potential changes to a user data object subset that was previously mapped. Unmapping a user data object subset invalidates the memory location from which the subset could be accessed by the application. Accessing this memory location after the unmap function completes is implementation specific. More...

Detailed Description

The OpenVX User Data Object extension API.

Definition in file vx_khr_user_data_object.h.