Internal User Data Object API

The Internal User Data Object API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Functions
	coreflow::UserDataObject::UserDataObject (vx_context context, vx_reference scope)
	Construct a new User Data Object object.
	coreflow::UserDataObject::~UserDataObject ()
	Destroy the User Data Object object.
static vx_user_data_object	coreflow::UserDataObject::createUserDataObject (vx_context context, const vx_char *type_name, vx_size size, const void *ptr)
	Create a user data object.
const vx_char *	coreflow::UserDataObject::typeName () const
	Get the type name of the user data object.
vx_size	coreflow::UserDataObject::objSize () const
	Get the size of the user data object.
vx_bool	coreflow::UserDataObject::allocateUserDataObject ()
	Allocate user data object.
vx_status	coreflow::UserDataObject::copy (vx_size offset, vx_size size, void *user_ptr, vx_enum usage, vx_enum user_mem_type)
	Copy data to/from user memory.
vx_status	coreflow::UserDataObject::map (vx_size offset, vx_size size, vx_map_id *map_id, void **ptr, vx_enum usage, vx_enum mem_type, vx_uint32 flags)
	Map the user data object for access.
vx_status	coreflow::UserDataObject::unmap (vx_map_id map_id)
	Unmap the user data object from access.

Detailed Description

The Internal User Data Object API.

Function Documentation

allocateUserDataObject()

vx_bool coreflow::UserDataObject::allocateUserDataObject

(

)

#include <vx_user_data_object.h>

Allocate user data object.

Returns

vx_bool vx_true_e if allocated | otherwise vx_false_e

copy()

vx_status coreflow::UserDataObject::copy	(	vx_size	offset,
		vx_size	size,
		void *	user_ptr,
		vx_enum	usage,
		vx_enum	user_mem_type )

#include <vx_user_data_object.h>

Copy data to/from user memory.

Parameters

offset	The offset in bytes
size	The size in bytes
user_ptr	The pointer to the user memory
usage	The usage of the memory (read/write)
user_mem_type	The type of memory (host, opencl, etc.)

Returns

vx_status VX_SUCCESS on success, error code otherwise

createUserDataObject()

static vx_user_data_object coreflow::UserDataObject::createUserDataObject ( vx_context context, const vx_char * type_name, vx_size size, const void * ptr )

static

#include <vx_user_data_object.h>

Create a user data object.

Parameters

context	The context associated with this obj
type_name	The type name of the user data object
size	The size of the user data object
ptr	The pointer to the user data object

Returns

vx_user_data_object The user data object

map()

vx_status coreflow::UserDataObject::map	(	vx_size	offset,
		vx_size	size,
		vx_map_id *	map_id,
		void **	ptr,
		vx_enum	usage,
		vx_enum	mem_type,
		vx_uint32	flags )

#include <vx_user_data_object.h>

Map the user data object for access.

Parameters

offset	The offset in bytes
size	The size in bytes
map_id	The map ID to be used
ptr	Pointer to the mapped memory
usage	Memory usage type (read/write)
mem_type	Memory type (host, opencl, etc.)
flags	Additional flags for mapping

Returns

vx_status VX_SUCCESS on success, error code otherwise

objSize()

vx_size coreflow::UserDataObject::objSize

(

)

const

#include <vx_user_data_object.h>

Get the size of the user data object.

Returns

vx_size The size in bytes

typeName()

const vx_char * coreflow::UserDataObject::typeName

(

)

const

#include <vx_user_data_object.h>

Get the type name of the user data object.

Returns

vx_char* The type name

unmap()

vx_status coreflow::UserDataObject::unmap

(

vx_map_id

map_id

)

#include <vx_user_data_object.h>

Unmap the user data object from access.

Parameters

map_id

The map ID to be used

Returns

vx_status VX_SUCCESS on success, error code otherwise

UserDataObject()

coreflow::UserDataObject::UserDataObject	(	vx_context	context,
		vx_reference	scope )

#include <vx_user_data_object.h>

Construct a new User Data Object object.

Parameters

context	The context associated with this obj
scope	The parent ref of this obj

~UserDataObject()

coreflow::UserDataObject::~UserDataObject

(

)

#include <vx_user_data_object.h>

Destroy the User Data Object object.