Object: Remap

Detailed Description

Defines the Remap Object Interface.

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

Enumerations
enum	vx_remap_attribute_e {   VX_REMAP_ATTRIBUTE_SOURCE_WIDTH = ((( VX_ID_KHRONOS ) << 20) | ( VX_TYPE_REMAP << 8)) + 0x0,   VX_REMAP_ATTRIBUTE_SOURCE_HEIGHT = ((( VX_ID_KHRONOS ) << 20) | ( VX_TYPE_REMAP << 8)) + 0x1,   VX_REMAP_ATTRIBUTE_DESTINATION_WIDTH = ((( VX_ID_KHRONOS ) << 20) | ( VX_TYPE_REMAP << 8)) + 0x2,   VX_REMAP_ATTRIBUTE_DESTINATION_HEIGHT = ((( VX_ID_KHRONOS ) << 20) | ( VX_TYPE_REMAP << 8)) + 0x3 }
	The remap object attributes. More...

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. 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. More...
vx_status VX_API_CALL	vxQueryRemap (vx_remap r, vx_enum attribute, void *ptr, vx_size size)
	Queries attributes from a Remap table. More...
vx_status VX_API_CALL	vxReleaseRemap (vx_remap *table)
	Releases a reference to a remap table object. 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. More...

Enumeration Type Documentation

enum vx_remap_attribute_e

The remap object attributes.

Enumerator
VX_REMAP_ATTRIBUTE_SOURCE_WIDTH	The source width. Use a vx_uint32 parameter.
VX_REMAP_ATTRIBUTE_SOURCE_HEIGHT	The source height. Use a vx_uint32 parameter.
VX_REMAP_ATTRIBUTE_DESTINATION_WIDTH	The destination width. Use a vx_uint32 parameter.
VX_REMAP_ATTRIBUTE_DESTINATION_HEIGHT	The destination height. Use a vx_uint32 parameter.

Definition at line 950 of file vx_types.h.

Function Documentation

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.

Parameters

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

Returns

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

vx_status VX_API_CALL vxReleaseRemap

(

vx_remap *

table

)

Releases a reference to a remap table object. 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.

Postcondition

After returning from this function the reference is zeroed.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	No errors.
VX_ERROR_INVALID_REFERENCE	If table is not a vx_remap.

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.

Parameters

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

Returns

A vx_status_e enumeration.

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.

Parameters

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

Returns

A vx_status_e enumeration.

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

Queries attributes from a Remap table.

Parameters

[in]	r	The remap to query.
[in]	attribute	The attribute to query. Use a vx_remap_attribute_e enumeration.
[out]	ptr	The location at which to store the resulting value.
[in]	size	The size in bytes of the container to which ptr points.

Returns

A vx_status_e enumeration.