User Facing Borders API

The Public Borders API. More...

Classes
struct	_vx_border_t
	Use with the enumeration VX_NODE_BORDER to set the border mode behavior of a node that supports borders. More...

Typedefs
typedef struct _vx_border_t	vx_border_t
	Use with the enumeration VX_NODE_BORDER to set the border mode behavior of a node that supports borders.

Enumerations
enum	vx_border_e {   VX_BORDER_UNDEFINED = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_BORDER) + 0x0 ,   VX_BORDER_CONSTANT = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_BORDER) + 0x1 ,   VX_BORDER_REPLICATE = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_BORDER) + 0x2 }
	The border mode list. More...
enum	vx_border_policy_e {   VX_BORDER_POLICY_DEFAULT_TO_UNDEFINED = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_BORDER_POLICY) + 0x0 ,   VX_BORDER_POLICY_RETURN_ERROR = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_BORDER_POLICY) + 0x1 }
	The unsupported border mode policy list. More...

Detailed Description

The Public Borders API.

Typedef Documentation

vx_border_t

typedef struct _vx_border_t vx_border_t

#include <vx_types.h>

Use with the enumeration VX_NODE_BORDER to set the border mode behavior of a node that supports borders.

If the indicated border mode is not supported, an error VX_ERROR_NOT_SUPPORTED will be reported either at the time the VX_NODE_BORDER is set or at the time of graph verification.

Enumeration Type Documentation

vx_border_e

enum vx_border_e

#include <vx_types.h>

The border mode list.

Enumerator
VX_BORDER_UNDEFINED	No defined border mode behavior is given.
VX_BORDER_CONSTANT	For nodes that support this behavior, a constant value is filled-in when accessing out-of-bounds pixels.
VX_BORDER_REPLICATE	For nodes that support this behavior, a replication of the nearest edge pixels value is given for out-of-bounds pixels.

vx_border_policy_e

enum vx_border_policy_e

#include <vx_types.h>

The unsupported border mode policy list.

Enumerator
VX_BORDER_POLICY_DEFAULT_TO_UNDEFINED	Use VX_BORDER_UNDEFINED instead of unsupported border modes.
VX_BORDER_POLICY_RETURN_ERROR	Return VX_ERROR_NOT_SUPPORTED for unsupported border modes.