Object: Remap

Detailed Description

Defines the Remap Object Interface.

Modules
	The remap object attributes.
	The remap object attributes.

Typedefs
typedef struct _vx_remap *	vx_remap
	The remap table Object. A remap table contains per-pixel mapping of output pixels to input pixels.

Functions
vx_remap VX_API_CALL	vxCreateRemap (vx_context context, vx_uint32 src_width, vx_uint32 src_height, vx_uint32 dst_width, vx_uint32 dst_height)
	Creates a remap table object [R01166]. More...
vx_status VX_API_CALL	vxGetRemapPoint (vx_remap table, vx_uint32 dst_x, vx_uint32 dst_y, vx_float32 *src_x, vx_float32 *src_y)
	Retrieves the source pixel point from a destination pixel [R01184]. More...
vx_status VX_API_CALL	vxQueryRemap (vx_remap table, vx_enum attribute, void *ptr, vx_size size)
	Queries attributes from a Remap table [R01191]. More...
vx_status VX_API_CALL	vxReleaseRemap (vx_remap *table)
	Releases a reference to a remap table object [R01173]. The object may not be garbage collected until its total reference count is zero. More...
vx_status VX_API_CALL	vxSetRemapPoint (vx_remap table, vx_uint32 dst_x, vx_uint32 dst_y, vx_float32 src_x, vx_float32 src_y)
	Assigns a destination pixel mapping to the source pixel [R01177]. More...

Function Documentation

vxCreateRemap()

vx_remap VX_API_CALL vxCreateRemap	(	vx_context	context,
		vx_uint32	src_width,
		vx_uint32	src_height,
		vx_uint32	dst_width,
		vx_uint32	dst_height
	)

Creates a remap table object [R01166].

Parameters

[in]	context	The reference to the overall context [R01167].
[in]	src_width	Width of the source image in pixel [R01168].
[in]	src_height	Height of the source image in pixels [R01169].
[in]	dst_width	Width of the destination image in pixels [R01170].
[in]	dst_height	Height of the destination image in pixels [R01171].

Returns

A remap reference vx_remap [R01172]. Any possible errors preventing a successful creation should be checked using vxGetStatus.

vxReleaseRemap()

vx_status VX_API_CALL vxReleaseRemap

(

vx_remap *

table

)

Releases a reference to a remap table object [R01173]. The object may not be garbage collected until its total reference count is zero.

Parameters

[in]

table

The pointer to the remap table to release [R01174].

Postcondition

After returning from this function the reference is zeroed [R01175].

Returns

A The vx_status Constants value.

Return values

VX_SUCCESS	No errors; any other value indicates failure [R01176].
VX_ERROR_INVALID_REFERENCE	table is not a valid vx_remap reference.

vxSetRemapPoint()

vx_status VX_API_CALL vxSetRemapPoint	(	vx_remap	table,
		vx_uint32	dst_x,
		vx_uint32	dst_y,
		vx_float32	src_x,
		vx_float32	src_y
	)

Assigns a destination pixel mapping to the source pixel [R01177].

Parameters

[in]	table	The remap table reference [R01178].
[in]	dst_x	The destination x coordinate [R01179].
[in]	dst_y	The destination y coordinate [R01180].
[in]	src_x	The source x coordinate in float representation to allow interpolation [R01181].
[in]	src_y	The source y coordinate in float representation to allow interpolation [R01182].

Returns

A The vx_status Constants value.

Return values

VX_SUCCESS	No errors; any other value indicates failure [R01183].
VX_ERROR_INVALID_REFERENCE	table is not a valid vx_remap reference.

vxGetRemapPoint()

vx_status VX_API_CALL vxGetRemapPoint	(	vx_remap	table,
		vx_uint32	dst_x,
		vx_uint32	dst_y,
		vx_float32 *	src_x,
		vx_float32 *	src_y
	)

Retrieves the source pixel point from a destination pixel [R01184].

Parameters

[in]	table	The remap table reference [R01185].
[in]	dst_x	The destination x coordinate [R01186].
[in]	dst_y	The destination y coordinate [R01187].
[out]	src_x	The pointer to the location to store the source x coordinate in float representation to allow interpolation [R01188].
[out]	src_y	The pointer to the location to store the source y coordinate in float representation to allow interpolation [R01189].

Returns

A The vx_status Constants value.

Return values

VX_SUCCESS	No errors; any other value indicates failure [R01190].
VX_ERROR_INVALID_REFERENCE	table is not a valid vx_remap reference.

vxQueryRemap()

vx_status VX_API_CALL vxQueryRemap	(	vx_remap	table,
		vx_enum	attribute,
		void *	ptr,
		vx_size	size
	)

Queries attributes from a Remap table [R01191].

Parameters

[in]	table	The remap to query [R01192].
[in]	attribute	The attribute to query [R01193]. Use a The remap object attributes. value.
[out]	ptr	The location at which to store the resulting value [R01194].
[in]	size	The size in bytes of the container to which ptr points [R01195].

Returns

A The vx_status Constants value.

Return values

VX_SUCCESS	No errors; any other value indicates failure [R01196].
VX_ERROR_INVALID_REFERENCE	table is not a valid vx_remap reference.