Internal Remap API

The Internal Remap API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Functions
	coreflow::Remap::Remap (vx_context context, vx_reference scope)
	Construct a new Remap object.
	coreflow::Remap::~Remap ()
	Destroy the Remap object.
static vx_remap	coreflow::Remap::createRemap (vx_context context, vx_uint32 src_width, vx_uint32 src_height, vx_uint32 dst_width, vx_uint32 dst_height)
	Create a remap object.
static vx_bool	coreflow::Remap::isValidRemap (vx_remap remap)
	Validate remap object.
vx_status	coreflow::Remap::setCoordValue (vx_uint32 dst_x, vx_uint32 dst_y, vx_float32 src_x, vx_float32 src_y)
	Set the Coord Value object.
vx_status	coreflow::Remap::getCoordValue (vx_uint32 dst_x, vx_uint32 dst_y, vx_float32 *src_x, vx_float32 *src_y)
	Get the Coord Value object.
vx_uint32	coreflow::Remap::srcWidth () const
	Get the source width.
vx_uint32	coreflow::Remap::srcHeight () const
	Get the source height.
vx_uint32	coreflow::Remap::dstWidth () const
	Get the destination width.
vx_uint32	coreflow::Remap::dstHeight () const
	Get the destination height.
vx_status	coreflow::Remap::setRemapPoint (vx_uint32 dst_x, vx_uint32 dst_y, vx_float32 src_x, vx_float32 src_y)
	Set the Remap Point.
vx_status	coreflow::Remap::getRemapPoint (vx_uint32 dst_x, vx_uint32 dst_y, vx_float32 *src_x, vx_float32 *src_y)
	Get the Remap Point.
vx_status	coreflow::Remap::copyPatch (const vx_rectangle_t *rect, vx_size user_stride_y, void *user_ptr, vx_enum user_coordinate_type, vx_enum usage, vx_enum user_mem_type)
	Copy a patch of remap data to/from user memory.
vx_status	coreflow::Remap::mapPatch (const vx_rectangle_t *rect, vx_map_id *map_id, vx_size *stride_y, void **ptr, vx_enum coordinate_type, vx_enum usage, vx_enum mem_type)
	Map a patch of remap data for reading or writing.
vx_status	coreflow::Remap::unmapPatch (vx_uint32 map_id)
	Unmap a previously mapped patch of remap data.
void	coreflow::Remap::destruct () override final
	Function to destroy a remap object.

Detailed Description

The Internal Remap API.

Function Documentation

copyPatch()

vx_status coreflow::Remap::copyPatch	(	const vx_rectangle_t *	rect,
		vx_size	user_stride_y,
		void *	user_ptr,
		vx_enum	user_coordinate_type,
		vx_enum	usage,
		vx_enum	user_mem_type )

#include <vx_remap.h>

Copy a patch of remap data to/from user memory.

Parameters

rect	The rectangle to copy
user_stride_y	The stride in bytes for the user memory
user_ptr	The pointer to the user memory
user_coordinate_type	The type of coordinates in 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

createRemap()

static vx_remap coreflow::Remap::createRemap ( vx_context context, vx_uint32 src_width, vx_uint32 src_height, vx_uint32 dst_width, vx_uint32 dst_height )

static

#include <vx_remap.h>

Create a remap object.

Parameters

context	The context associated with this obj
src_width	The width of the source image
src_height	The height of the source image
dst_width	The width of the destination image
dst_height	The height of the destination image

Returns

vx_remap The remap object

destruct()

void coreflow::Remap::destruct ( )

finaloverridevirtual

#include <vx_remap.h>

Function to destroy a remap object.

Reimplemented from coreflow::Reference.

dstHeight()

vx_uint32 coreflow::Remap::dstHeight

(

)

const

#include <vx_remap.h>

Get the destination height.

Returns

vx_uint32 The destination height

dstWidth()

vx_uint32 coreflow::Remap::dstWidth

(

)

const

#include <vx_remap.h>

Get the destination width.

Returns

vx_uint32 The destination width

getCoordValue()

vx_status coreflow::Remap::getCoordValue	(	vx_uint32	dst_x,
		vx_uint32	dst_y,
		vx_float32 *	src_x,
		vx_float32 *	src_y )

#include <vx_remap.h>

Get the Coord Value object.

Parameters

dst_x	destination x coord
dst_y	destination y coord
src_x	source x coord
src_y	source y coord

Returns

vx_status

getRemapPoint()

vx_status coreflow::Remap::getRemapPoint	(	vx_uint32	dst_x,
		vx_uint32	dst_y,
		vx_float32 *	src_x,
		vx_float32 *	src_y )

#include <vx_remap.h>

Get the Remap Point.

Parameters

dst_x	destination x coord
dst_y	destination y coord
src_x	source x coord
src_y	source y coord

Returns

vx_status

isValidRemap()

static vx_bool coreflow::Remap::isValidRemap ( vx_remap remap )

static

#include <vx_remap.h>

Validate remap object.

Parameters

remap

Returns

vx_bool

mapPatch()

vx_status coreflow::Remap::mapPatch	(	const vx_rectangle_t *	rect,
		vx_map_id *	map_id,
		vx_size *	stride_y,
		void **	ptr,
		vx_enum	coordinate_type,
		vx_enum	usage,
		vx_enum	mem_type )

#include <vx_remap.h>

Map a patch of remap data for reading or writing.

Parameters

rect	The rectangle to map
map_id	The ID of the map
stride_y	The stride in bytes for the mapped memory
ptr	The pointer to the mapped memory
coordinate_type	The type of coordinates in the mapped memory
usage	The usage of the memory (read/write)
mem_type	The type of memory (host, opencl, etc.)

Returns

vx_status VX_SUCCESS on success, error code otherwise

Remap()

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

#include <vx_remap.h>

Construct a new Remap object.

Parameters

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

setCoordValue()

vx_status coreflow::Remap::setCoordValue	(	vx_uint32	dst_x,
		vx_uint32	dst_y,
		vx_float32	src_x,
		vx_float32	src_y )

#include <vx_remap.h>

Set the Coord Value object.

Parameters

dst_x	destination x coord
dst_y	destination y coord
src_x	source x coord
src_y	source y coord

Returns

vx_status

setRemapPoint()

vx_status coreflow::Remap::setRemapPoint	(	vx_uint32	dst_x,
		vx_uint32	dst_y,
		vx_float32	src_x,
		vx_float32	src_y )

#include <vx_remap.h>

Set the Remap Point.

Parameters

dst_x	destination x coord
dst_y	destination y coord
src_x	source x coord
src_y	source y coord

Returns

vx_status

srcHeight()

vx_uint32 coreflow::Remap::srcHeight

(

)

const

#include <vx_remap.h>

Get the source height.

Returns

vx_uint32 The source height

srcWidth()

vx_uint32 coreflow::Remap::srcWidth

(

)

const

#include <vx_remap.h>

Get the source width.

Returns

vx_uint32 The source width

unmapPatch()

vx_status coreflow::Remap::unmapPatch

(

vx_uint32

map_id

)

#include <vx_remap.h>

Unmap a previously mapped patch of remap data.

Parameters

map_id

The ID of the map to unmap

Returns

vx_status VX_SUCCESS on success, error code otherwise

~Remap()

coreflow::Remap::~Remap

(

)

#include <vx_remap.h>

Destroy the Remap object.