VisionWorks Toolkit Reference

December 18, 2015 | 1.2 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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. More...
 

Enumerations

enum  vx_remap_attribute_e {
  VX_REMAP_ATTRIBUTE_SOURCE_WIDTH = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_REMAP) + 0x0,
  VX_REMAP_ATTRIBUTE_SOURCE_HEIGHT = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_REMAP) + 0x1,
  VX_REMAP_ATTRIBUTE_DESTINATION_WIDTH = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_REMAP) + 0x2,
  VX_REMAP_ATTRIBUTE_DESTINATION_HEIGHT = VX_ATTRIBUTE_BASE(VX_ID_KHRONOS, VX_TYPE_REMAP) + 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...
 

Typedef Documentation

typedef struct _vx_remap* vx_remap

The remap table Object. A remap table contains per-pixel mapping of output pixels to input pixels.

Definition at line 274 of file vx_types.h.

Enumeration Type Documentation

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 970 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]contextThe reference to the overall context.
[in]src_widthWidth of the source image in pixel.
[in]src_heightHeight of the source image in pixels.
[in]dst_widthWidth of the destination image in pixels.
[in]dst_heightHeight 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]tableThe 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_SUCCESSNo errors.
VX_ERROR_INVALID_REFERENCEIf 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]tableThe remap table reference.
[in]dst_xThe destination x coordinate.
[in]dst_yThe destination y coordinate.
[in]src_xThe source x coordinate in float representation to allow interpolation.
[in]src_yThe 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]tableThe remap table reference.
[in]dst_xThe destination x coordinate.
[in]dst_yThe destination y coordinate.
[out]src_xThe pointer to the location to store the source x coordinate in float representation to allow interpolation.
[out]src_yThe 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]rThe remap to query.
[in]attributeThe attribute to query. Use a vx_remap_attribute_e enumeration.
[out]ptrThe location at which to store the resulting value.
[in]sizeThe size in bytes of the container to which ptr points.
Returns
A vx_status_e enumeration.