User Facing Basic Features API

The Public Basic Features API. More...

Classes
struct	_vx_line2d_t
	line struct More...
struct	_vx_keypoint_t
	The keypoint data structure. More...
struct	_vx_rectangle_t
	The rectangle data structure that is shared with the users. The area of the rectangle can be computed as (end_x-start_x)*(end_y-start_y). More...
struct	_vx_coordinates2d_t
	The 2D Coordinates structure. More...
struct	_vx_coordinates2df_t
	The floating-point 2D Coordinates structure. More...
struct	_vx_coordinates3d_t
	The 3D Coordinates structure. More...

Macros
#define	VX_MAX_LOG_MESSAGE_LEN   (1024)
	Defines the length of a message buffer to copy from the log, including the trailing zero.
#define	VX_VERSION_MAJOR(x)
	Defines the major version number macro.
#define	VX_VERSION_MINOR(x)
	Defines the minor version number macro.
#define	VX_VERSION_1_0   (VX_VERSION_MAJOR(1) | VX_VERSION_MINOR(0))
	Defines the predefined version number for 1.0.
#define	VX_VERSION_1_1   (VX_VERSION_MAJOR(1) | VX_VERSION_MINOR(1))
	Defines the predefined version number for 1.1.
#define	VX_VERSION_1_2   (VX_VERSION_MAJOR(1) | VX_VERSION_MINOR(2))
	Defines the predefined version number for 1.2.
#define	VX_VERSION_1_3   (VX_VERSION_MAJOR(1) | VX_VERSION_MINOR(3))
	Defines the predefined version number for 1.3.
#define	VX_VERSION   (VX_VERSION_1_3)
	Defines the OpenVX Version Number.
#define	VX_ENUM_IX_USE   0x18
	An enumeration of export uses. See vxExportObjectsToMemory and vxImportObjectsFromMemory
#define	VX_API_CALL
	Defines calling convention for OpenVX API.
#define	VX_CALLBACK
	Defines calling convention for user callbacks.
#define	VX_VENDOR_MASK   (0xFFF00000U)
	Vendor IDs are 2 nibbles in size and are located in the upper byte of the 4 bytes of an enumeration.
#define	VX_TYPE_MASK   (0x000FFF00U)
	A type mask removes the scalar/object type from the attribute. It is 3 nibbles in size and is contained between the third and second byte.
#define	VX_LIBRARY_MASK   (0x000FF000U)
	A library is a set of vision kernels with its own ID supplied by a vendor. The vendor defines the library ID. The range is \( [0,2^{8}-1] \) inclusive.
#define	VX_KERNEL_MASK   (0x00000FFFU)
	An individual kernel in a library has its own unique ID within \( [0,2^{12}-1] \) (inclusive).
#define	VX_ATTRIBUTE_ID_MASK   (0x000000FFU)
	An object's attribute ID is within the range of \( [0,2^{8}-1] \) (inclusive).
#define	VX_ENUM_TYPE_MASK   (0x000FF000U)
	A type of enumeration. The valid range is between \( [0,2^{8}-1] \) (inclusive).
#define	VX_ENUM_MASK   (0x00000FFFU)
	A generic enumeration list can have values between \( [0,2^{12}-1] \) (inclusive).
#define	VX_VENDOR(e)
	A macro to extract the vendor ID from the enumerated value.
#define	VX_TYPE(e)
	A macro to extract the type from an enumerated attribute value.
#define	VX_ENUM_TYPE(e)
	A macro to extract the enum type from an enumerated value.
#define	VX_LIBRARY(e)
	A macro to extract the kernel library enumeration from a enumerated kernel value.
#define	VX_DF_IMAGE(a, b, c, d)
	Converts a set of four chars into a uint32_t container of a VX_DF_IMAGE code.
#define	VX_ATTRIBUTE_BASE(vendor, object)
	Defines the manner in which to combine the Vendor and Object IDs to get the base value of the enumeration.
#define	VX_KERNEL_BASE(vendor, lib)
	Defines the manner in which to combine the Vendor and Library IDs to get the base value of the enumeration.
#define	VX_ENUM_BASE(vendor, id)
	Defines the manner in which to combine the Vendor and Object IDs to get the base value of the enumeration.
#define	VX_FMT_REF   "%p"
	Use to aid in debugging values in OpenVX.
#define	VX_FMT_SIZE   "%zu"
	Use to aid in debugging values in OpenVX.
#define	VX_SCALE_UNITY   (1024u)
	Use to indicate the 1:1 ratio in Q22.10 format.

Typedefs
typedef char	vx_char
	An 8 bit ASCII character.
typedef uint8_t	vx_uint8
	An 8-bit unsigned value.
typedef uint16_t	vx_uint16
	A 16-bit unsigned value.
typedef uint32_t	vx_uint32
	A 32-bit unsigned value.
typedef uint64_t	vx_uint64
	A 64-bit unsigned value.
typedef int8_t	vx_int8
	An 8-bit signed value.
typedef int16_t	vx_int16
	A 16-bit signed value.
typedef int32_t	vx_int32
	A 32-bit signed value.
typedef int64_t	vx_int64
	A 64-bit signed value.
typedef _Float16	vx_float16
	A 16-bit float value.
typedef float	vx_float32
	A 32-bit float value.
typedef double	vx_float64
	A 64-bit float value (aka double).
typedef int32_t	vx_enum
	Sets the standard enumeration type size to be a fixed quantity.
typedef size_t	vx_size
	A wrapper of size_t to keep the naming convention uniform.
typedef uint32_t	vx_df_image
	Used to hold a VX_DF_IMAGE code to describe the pixel format and color space.
typedef vx_enum	vx_bool
	A formal boolean type with known fixed size.
typedef vx_enum	vx_status
	A formal status type with known fixed size.
typedef struct _vx_line2d_t	vx_line2d_t
	line struct
typedef struct _vx_keypoint_t	vx_keypoint_t
	The keypoint data structure.
typedef struct _vx_rectangle_t	vx_rectangle_t
	The rectangle data structure that is shared with the users. The area of the rectangle can be computed as (end_x-start_x)*(end_y-start_y).
typedef struct _vx_coordinates2d_t	vx_coordinates2d_t
	The 2D Coordinates structure.
typedef struct _vx_coordinates2df_t	vx_coordinates2df_t
	The floating-point 2D Coordinates structure.
typedef struct _vx_coordinates3d_t	vx_coordinates3d_t
	The 3D Coordinates structure.

Enumerations
enum	vx_type_ext_e { VX_TYPE_STRING = 0x818 }
	The type enumeration lists additional types to extend the known types in OpenVX. More...
enum	vx_vendor_id_ext_e { VX_ID_EDGE_AI = 0x80D }
	Define Edge AI Vendor ID. More...
enum	vx_bool_e {   vx_false_e = 0 ,   vx_true_e }
	A Boolean value. This allows 0 to be FALSE, as it is in C, and any non-zero to be TRUE. More...
enum	vx_type_e {   VX_TYPE_INVALID = 0x000 ,   VX_TYPE_CHAR = 0x001 ,   VX_TYPE_INT8 = 0x002 ,   VX_TYPE_UINT8 = 0x003 ,   VX_TYPE_INT16 = 0x004 ,   VX_TYPE_UINT16 = 0x005 ,   VX_TYPE_INT32 = 0x006 ,   VX_TYPE_UINT32 = 0x007 ,   VX_TYPE_INT64 = 0x008 ,   VX_TYPE_UINT64 = 0x009 ,   VX_TYPE_FLOAT32 = 0x00A ,   VX_TYPE_FLOAT64 = 0x00B ,   VX_TYPE_ENUM = 0x00C ,   VX_TYPE_SIZE = 0x00D ,   VX_TYPE_DF_IMAGE = 0x00E ,   VX_TYPE_FLOAT16 = 0x00F ,   VX_TYPE_BOOL = 0x010 ,   VX_TYPE_RECTANGLE = 0x020 ,   VX_TYPE_KEYPOINT = 0x021 ,   VX_TYPE_COORDINATES2D = 0x022 ,   VX_TYPE_COORDINATES3D = 0x023 ,   VX_TYPE_COORDINATES2DF = 0x024 ,   VX_TYPE_HOG_PARAMS = 0x028 ,   VX_TYPE_HOUGH_LINES_PARAMS = 0x029 ,   VX_TYPE_LINE_2D = 0x02A ,   VX_TYPE_TENSOR_MATRIX_MULTIPLY_PARAMS = 0x02B ,   VX_TYPE_USER_STRUCT_START = 0x100 ,   VX_TYPE_VENDOR_STRUCT_START = 0x400 ,   VX_TYPE_KHRONOS_OBJECT_START = 0x800 ,   VX_TYPE_VENDOR_OBJECT_START = 0xC00 ,   VX_TYPE_KHRONOS_STRUCT_MAX = (vx_enum)VX_TYPE_USER_STRUCT_START - 1 ,   VX_TYPE_USER_STRUCT_END = (vx_enum)VX_TYPE_VENDOR_STRUCT_START - 1 ,   VX_TYPE_VENDOR_STRUCT_END = (vx_enum)VX_TYPE_KHRONOS_OBJECT_START - 1 ,   VX_TYPE_KHRONOS_OBJECT_END = (vx_enum)VX_TYPE_VENDOR_OBJECT_START - 1 ,   VX_TYPE_VENDOR_OBJECT_END = 0xFFF ,   VX_TYPE_REFERENCE = 0x800 ,   VX_TYPE_CONTEXT = 0x801 ,   VX_TYPE_GRAPH = 0x802 ,   VX_TYPE_NODE = 0x803 ,   VX_TYPE_KERNEL = 0x804 ,   VX_TYPE_PARAMETER = 0x805 ,   VX_TYPE_DELAY = 0x806 ,   VX_TYPE_LUT = 0x807 ,   VX_TYPE_DISTRIBUTION = 0x808 ,   VX_TYPE_PYRAMID = 0x809 ,   VX_TYPE_THRESHOLD = 0x80A ,   VX_TYPE_MATRIX = 0x80B ,   VX_TYPE_CONVOLUTION = 0x80C ,   VX_TYPE_SCALAR = 0x80D ,   VX_TYPE_ARRAY = 0x80E ,   VX_TYPE_IMAGE = 0x80F ,   VX_TYPE_REMAP = 0x810 ,   VX_TYPE_ERROR = 0x811 ,   VX_TYPE_META_FORMAT = 0x812 ,   VX_TYPE_OBJECT_ARRAY = 0x813 ,   VX_TYPE_TENSOR = 0x815 }
	The type enumeration lists all the known types in OpenVX. More...
enum	vx_status_e {   VX_STATUS_MIN = -(vx_int32)25 ,   VX_ERROR_REFERENCE_NONZERO = -(vx_int32)24 ,   VX_ERROR_MULTIPLE_WRITERS = -(vx_int32)23 ,   VX_ERROR_GRAPH_ABANDONED = -(vx_int32)22 ,   VX_ERROR_GRAPH_SCHEDULED = -(vx_int32)21 ,   VX_ERROR_INVALID_SCOPE = -(vx_int32)20 ,   VX_ERROR_INVALID_NODE = -(vx_int32)19 ,   VX_ERROR_INVALID_GRAPH = -(vx_int32)18 ,   VX_ERROR_INVALID_TYPE = -(vx_int32)17 ,   VX_ERROR_INVALID_VALUE = -(vx_int32)16 ,   VX_ERROR_INVALID_DIMENSION = -(vx_int32)15 ,   VX_ERROR_INVALID_FORMAT = -(vx_int32)14 ,   VX_ERROR_INVALID_LINK = -(vx_int32)13 ,   VX_ERROR_INVALID_REFERENCE = -(vx_int32)12 ,   VX_ERROR_INVALID_MODULE = -(vx_int32)11 ,   VX_ERROR_INVALID_PARAMETERS = -(vx_int32)10 ,   VX_ERROR_OPTIMIZED_AWAY = -(vx_int32)9 ,   VX_ERROR_NO_MEMORY = -(vx_int32)8 ,   VX_ERROR_NO_RESOURCES = -(vx_int32)7 ,   VX_ERROR_NOT_COMPATIBLE = -(vx_int32)6 ,   VX_ERROR_NOT_ALLOCATED = -(vx_int32)5 ,   VX_ERROR_NOT_SUFFICIENT = -(vx_int32)4 ,   VX_ERROR_NOT_SUPPORTED = -(vx_int32)3 ,   VX_ERROR_NOT_IMPLEMENTED = -(vx_int32)2 ,   VX_FAILURE = -(vx_int32)1 ,   VX_SUCCESS = 0 }
	The enumeration of all status codes. More...
enum	vx_enum_e {   VX_ENUM_DIRECTION = 0x00 ,   VX_ENUM_ACTION = 0x01 ,   VX_ENUM_HINT = 0x02 ,   VX_ENUM_DIRECTIVE = 0x03 ,   VX_ENUM_INTERPOLATION = 0x04 ,   VX_ENUM_OVERFLOW = 0x05 ,   VX_ENUM_COLOR_SPACE = 0x06 ,   VX_ENUM_COLOR_RANGE = 0x07 ,   VX_ENUM_PARAMETER_STATE = 0x08 ,   VX_ENUM_CHANNEL = 0x09 ,   VX_ENUM_CONVERT_POLICY = 0x0A ,   VX_ENUM_THRESHOLD_TYPE = 0x0B ,   VX_ENUM_BORDER = 0x0C ,   VX_ENUM_COMPARISON = 0x0D ,   VX_ENUM_MEMORY_TYPE = 0x0E ,   VX_ENUM_TERM_CRITERIA = 0x0F ,   VX_ENUM_NORM_TYPE = 0x10 ,   VX_ENUM_ACCESSOR = 0x11 ,   VX_ENUM_ROUND_POLICY = 0x12 ,   VX_ENUM_TARGET = 0x13 ,   VX_ENUM_BORDER_POLICY = 0x14 ,   VX_ENUM_GRAPH_STATE = 0x15 ,   VX_ENUM_NONLINEAR = 0x16 ,   VX_ENUM_PATTERN = 0x17 ,   VX_ENUM_LBP_FORMAT = 0x18 ,   VX_ENUM_COMP_METRIC = 0x19 ,   VX_ENUM_SCALAR_OPERATION = 0X20 }
	The set of supported enumerations in OpenVX. More...
enum	vx_convert_policy_e {   VX_CONVERT_POLICY_WRAP = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CONVERT_POLICY) + 0x0 ,   VX_CONVERT_POLICY_SATURATE = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CONVERT_POLICY) + 0x1 }
	The Conversion Policy Enumeration. More...
enum	vx_df_image_e {   VX_DF_IMAGE_VIRT = VX_DF_IMAGE('V','I','R','T') ,   VX_DF_IMAGE_RGB = VX_DF_IMAGE('R','G','B','2') ,   VX_DF_IMAGE_RGBX = VX_DF_IMAGE('R','G','B','A') ,   VX_DF_IMAGE_NV12 = VX_DF_IMAGE('N','V','1','2') ,   VX_DF_IMAGE_NV21 = VX_DF_IMAGE('N','V','2','1') ,   VX_DF_IMAGE_UYVY = VX_DF_IMAGE('U','Y','V','Y') ,   VX_DF_IMAGE_YUYV = VX_DF_IMAGE('Y','U','Y','V') ,   VX_DF_IMAGE_IYUV = VX_DF_IMAGE('I','Y','U','V') ,   VX_DF_IMAGE_YUV4 = VX_DF_IMAGE('Y','U','V','4') ,   VX_DF_IMAGE_U1 = VX_DF_IMAGE('U','0','0','1') ,   VX_DF_IMAGE_U8 = VX_DF_IMAGE('U','0','0','8') ,   VX_DF_IMAGE_U16 = VX_DF_IMAGE('U','0','1','6') ,   VX_DF_IMAGE_S16 = VX_DF_IMAGE('S','0','1','6') ,   VX_DF_IMAGE_U32 = VX_DF_IMAGE('U','0','3','2') ,   VX_DF_IMAGE_S32 = VX_DF_IMAGE('S','0','3','2') }
	Based on the VX_DF_IMAGE definition. More...
enum	vx_target_e {   VX_TARGET_ANY = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_TARGET) + 0x0000 ,   VX_TARGET_STRING = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_TARGET) + 0x0001 ,   VX_TARGET_VENDOR_BEGIN = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_TARGET) + 0x1000 }
	The Target Enumeration. More...
enum	vx_channel_e {   VX_CHANNEL_0 = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x0 ,   VX_CHANNEL_1 = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x1 ,   VX_CHANNEL_2 = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x2 ,   VX_CHANNEL_3 = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x3 ,   VX_CHANNEL_R = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x10 ,   VX_CHANNEL_G = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x11 ,   VX_CHANNEL_B = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x12 ,   VX_CHANNEL_A = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x13 ,   VX_CHANNEL_Y = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x14 ,   VX_CHANNEL_U = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x15 ,   VX_CHANNEL_V = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_CHANNEL) + 0x16 }
	The channel enumerations for channel extractions. More...
enum	vx_interpolation_type_e {   VX_INTERPOLATION_NEAREST_NEIGHBOR = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_INTERPOLATION) + 0x0 ,   VX_INTERPOLATION_BILINEAR = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_INTERPOLATION) + 0x1 ,   VX_INTERPOLATION_AREA = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_INTERPOLATION) + 0x2 }
	The image reconstruction filters supported by image resampling operations. More...
enum	vx_non_linear_filter_e {   VX_NONLINEAR_FILTER_MEDIAN = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_NONLINEAR) + 0x0 ,   VX_NONLINEAR_FILTER_MIN = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_NONLINEAR) + 0x1 ,   VX_NONLINEAR_FILTER_MAX = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_NONLINEAR) + 0x2 }
	An enumeration of non-linear filter functions. More...
enum	vx_pattern_e {   VX_PATTERN_BOX = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_PATTERN) + 0x0 ,   VX_PATTERN_CROSS = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_PATTERN) + 0x1 ,   VX_PATTERN_DISK = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_PATTERN) + 0x2 ,   VX_PATTERN_OTHER = VX_ENUM_BASE(VX_ID_KHRONOS, VX_ENUM_PATTERN) + 0x3 }
	An enumeration of matrix patterns. See vxCreateMatrixFromPattern and vxCreateMatrixFromPatternAndOrigin More...
enum	vx_vendor_id_e {   VX_ID_KHRONOS = 0x000 ,   VX_ID_TI = 0x001 ,   VX_ID_QUALCOMM = 0x002 ,   VX_ID_NVIDIA = 0x003 ,   VX_ID_ARM = 0x004 ,   VX_ID_BDTI = 0x005 ,   VX_ID_RENESAS = 0x006 ,   VX_ID_VIVANTE = 0x007 ,   VX_ID_XILINX = 0x008 ,   VX_ID_AXIS = 0x009 ,   VX_ID_MOVIDIUS = 0x00A ,   VX_ID_SAMSUNG = 0x00B ,   VX_ID_FREESCALE = 0x00C ,   VX_ID_AMD = 0x00D ,   VX_ID_BROADCOM = 0x00E ,   VX_ID_INTEL = 0x00F ,   VX_ID_MARVELL = 0x010 ,   VX_ID_MEDIATEK = 0x011 ,   VX_ID_ST = 0x012 ,   VX_ID_CEVA = 0x013 ,   VX_ID_ITSEEZ = 0x014 ,   VX_ID_IMAGINATION =0x015 ,   VX_ID_NXP = 0x016 ,   VX_ID_VIDEANTIS = 0x017 ,   VX_ID_SYNOPSYS = 0x018 ,   VX_ID_CADENCE = 0x019 ,   VX_ID_HUAWEI = 0x01A ,   VX_ID_SOCIONEXT = 0x01B ,   VX_ID_USER = 0xFFE ,   VX_ID_MAX = 0xFFF ,   VX_ID_DEFAULT = VX_ID_MAX }
	The Vendor ID of the Implementation. As new vendors submit their implementations, this enumeration will grow. More...

Functions
VX_API_ENTRY vx_status VX_API_CALL	vxGetStatus (vx_reference reference)
	Provides a generic API to return status values from Object constructors if they fail.

Detailed Description

The Public Basic Features API.

Macro Definition Documentation

VX_API_CALL

#define VX_API_CALL

#include <vx_types.h>

Defines calling convention for OpenVX API.

VX_ATTRIBUTE_BASE

#define VX_ATTRIBUTE_BASE	(		vendor,
			object )

#include <vx_types.h>

Value:

((vx_int32)(((vx_uint32)(vendor) << 20) | ((vx_uint32)(object) << 8)))

Defines the manner in which to combine the Vendor and Object IDs to get the base value of the enumeration.

VX_ATTRIBUTE_ID_MASK

#define VX_ATTRIBUTE_ID_MASK   (0x000000FFU)

#include <vx_types.h>

An object's attribute ID is within the range of \( [0,2^{8}-1] \) (inclusive).

VX_CALLBACK

#define VX_CALLBACK

#include <vx_types.h>

Defines calling convention for user callbacks.

VX_DF_IMAGE

#define VX_DF_IMAGE	(		a,
			b,
			c,
			d )

#include <vx_types.h>

Value:

((vx_uint32)(vx_uint8)(a) | ((vx_uint32)(vx_uint8)(b) << 8U) | ((vx_uint32)(vx_uint8)(c) << 16U) | ((vx_uint32)(vx_uint8)(d) << 24U))

Converts a set of four chars into a uint32_t container of a VX_DF_IMAGE code.

Note

Use a vx_df_image variable to hold the value.

VX_ENUM_BASE

#define VX_ENUM_BASE	(		vendor,
			id )

#include <vx_types.h>

Value:

((vx_int32)(((vx_uint32)(vendor) << 20) | ((vx_uint32)(id) << 12)))

Defines the manner in which to combine the Vendor and Object IDs to get the base value of the enumeration.

From any enumerated value (with exceptions), the vendor, and enumeration type should be extractable. Those types that are exceptions are vx_vendor_id_e, vx_type_e, vx_enum_e, vx_df_image_e, and vx_bool.

VX_ENUM_IX_USE

#define VX_ENUM_IX_USE   0x18

#include <vx_import.h>

An enumeration of export uses. See vxExportObjectsToMemory and vxImportObjectsFromMemory

VX_ENUM_MASK

#define VX_ENUM_MASK   (0x00000FFFU)

#include <vx_types.h>

A generic enumeration list can have values between \( [0,2^{12}-1] \) (inclusive).

VX_ENUM_TYPE

#define VX_ENUM_TYPE

(

e

)

#include <vx_types.h>

Value:

(((vx_uint32)(e) & VX_ENUM_TYPE_MASK) >> 12)

A macro to extract the enum type from an enumerated value.

VX_ENUM_TYPE_MASK

#define VX_ENUM_TYPE_MASK   (0x000FF000U)

#include <vx_types.h>

A type of enumeration. The valid range is between \( [0,2^{8}-1] \) (inclusive).

VX_FMT_REF

#define VX_FMT_REF   "%p"

#include <vx_types.h>

Use to aid in debugging values in OpenVX.

VX_FMT_SIZE

#define VX_FMT_SIZE   "%zu"

#include <vx_types.h>

Use to aid in debugging values in OpenVX.

VX_KERNEL_BASE

#define VX_KERNEL_BASE	(		vendor,
			lib )

#include <vx_types.h>

Value:

((vx_int32)(((vx_uint32)(vendor) << 20) | ((vx_uint32)(lib) << 12)))

Defines the manner in which to combine the Vendor and Library IDs to get the base value of the enumeration.

VX_KERNEL_MASK

#define VX_KERNEL_MASK   (0x00000FFFU)

#include <vx_types.h>

An individual kernel in a library has its own unique ID within \( [0,2^{12}-1] \) (inclusive).

VX_LIBRARY

#define VX_LIBRARY

(

e

)

#include <vx_types.h>

Value:

(((vx_uint32)(e) & VX_LIBRARY_MASK) >> 12)

A macro to extract the kernel library enumeration from a enumerated kernel value.

VX_LIBRARY_MASK

#define VX_LIBRARY_MASK   (0x000FF000U)

#include <vx_types.h>

A library is a set of vision kernels with its own ID supplied by a vendor. The vendor defines the library ID. The range is \( [0,2^{8}-1] \) inclusive.

VX_MAX_LOG_MESSAGE_LEN

#define VX_MAX_LOG_MESSAGE_LEN   (1024)

#include <vx.h>

Defines the length of a message buffer to copy from the log, including the trailing zero.

VX_SCALE_UNITY

#define VX_SCALE_UNITY   (1024u)

#include <vx_types.h>

Use to indicate the 1:1 ratio in Q22.10 format.

VX_TYPE

#define VX_TYPE

(

e

)

#include <vx_types.h>

Value:

(((vx_uint32)(e) & VX_TYPE_MASK) >> 8)

A macro to extract the type from an enumerated attribute value.

VX_TYPE_MASK

#define VX_TYPE_MASK   (0x000FFF00U)

#include <vx_types.h>

A type mask removes the scalar/object type from the attribute. It is 3 nibbles in size and is contained between the third and second byte.

See also

vx_type_e

VX_VENDOR

#define VX_VENDOR

(

e

)

#include <vx_types.h>

Value:

(((vx_uint32)(e) & VX_VENDOR_MASK) >> 20)

A macro to extract the vendor ID from the enumerated value.

VX_VENDOR_MASK

#define VX_VENDOR_MASK   (0xFFF00000U)

#include <vx_types.h>

Vendor IDs are 2 nibbles in size and are located in the upper byte of the 4 bytes of an enumeration.

VX_VERSION

#define VX_VERSION   (VX_VERSION_1_3)

#include <vx.h>

Defines the OpenVX Version Number.

VX_VERSION_1_0

#define VX_VERSION_1_0   (VX_VERSION_MAJOR(1) | VX_VERSION_MINOR(0))

#include <vx.h>

Defines the predefined version number for 1.0.

VX_VERSION_1_1

#define VX_VERSION_1_1   (VX_VERSION_MAJOR(1) | VX_VERSION_MINOR(1))

#include <vx.h>

Defines the predefined version number for 1.1.

VX_VERSION_1_2

#define VX_VERSION_1_2   (VX_VERSION_MAJOR(1) | VX_VERSION_MINOR(2))

#include <vx.h>

Defines the predefined version number for 1.2.

VX_VERSION_1_3

#define VX_VERSION_1_3   (VX_VERSION_MAJOR(1) | VX_VERSION_MINOR(3))

#include <vx.h>

Defines the predefined version number for 1.3.

VX_VERSION_MAJOR

#define VX_VERSION_MAJOR

(

x

)

#include <vx.h>

Value:

((vx_uint32)((vx_uint32)(x) & 0xFFU) << 8)

Defines the major version number macro.

VX_VERSION_MINOR

#define VX_VERSION_MINOR

(

x

)

#include <vx.h>

Value:

((vx_uint32)((vx_uint32)(x) & 0xFFU) << 0)

Defines the minor version number macro.

Typedef Documentation

vx_bool

typedef vx_enum vx_bool

#include <vx_types.h>

A formal boolean type with known fixed size.

See also

vx_bool_e

vx_char

typedef char vx_char

#include <vx_types.h>

An 8 bit ASCII character.

vx_coordinates2d_t

typedef struct _vx_coordinates2d_t vx_coordinates2d_t

#include <vx_types.h>

The 2D Coordinates structure.

vx_coordinates2df_t

typedef struct _vx_coordinates2df_t vx_coordinates2df_t

#include <vx_types.h>

The floating-point 2D Coordinates structure.

vx_coordinates3d_t

typedef struct _vx_coordinates3d_t vx_coordinates3d_t

#include <vx_types.h>

The 3D Coordinates structure.

vx_df_image

typedef uint32_t vx_df_image

#include <vx_types.h>

Used to hold a VX_DF_IMAGE code to describe the pixel format and color space.

vx_enum

typedef int32_t vx_enum

#include <vx_types.h>

Sets the standard enumeration type size to be a fixed quantity.

All enumerable fields must use this type as the container to enforce enumeration ranges and sizeof() operations.

vx_float16

typedef _Float16 vx_float16

#include <vx_types.h>

A 16-bit float value.

vx_float32

typedef float vx_float32

#include <vx_types.h>

A 32-bit float value.

vx_float64

typedef double vx_float64

#include <vx_types.h>

A 64-bit float value (aka double).

vx_int16

typedef int16_t vx_int16

#include <vx_types.h>

A 16-bit signed value.

vx_int32

typedef int32_t vx_int32

#include <vx_types.h>

A 32-bit signed value.

vx_int64

typedef int64_t vx_int64

#include <vx_types.h>

A 64-bit signed value.

vx_int8

typedef int8_t vx_int8

#include <vx_types.h>

An 8-bit signed value.

vx_keypoint_t

typedef struct _vx_keypoint_t vx_keypoint_t

#include <vx_types.h>

The keypoint data structure.

vx_line2d_t

typedef struct _vx_line2d_t vx_line2d_t

#include <vx_types.h>

line struct

vx_rectangle_t

typedef struct _vx_rectangle_t vx_rectangle_t

#include <vx_types.h>

The rectangle data structure that is shared with the users. The area of the rectangle can be computed as (end_x-start_x)*(end_y-start_y).

vx_size

typedef size_t vx_size

#include <vx_types.h>

A wrapper of size_t to keep the naming convention uniform.

vx_status

typedef vx_enum vx_status

#include <vx_types.h>

A formal status type with known fixed size.

See also

vx_status_e

vx_uint16

typedef uint16_t vx_uint16

#include <vx_types.h>

A 16-bit unsigned value.

vx_uint32

typedef uint32_t vx_uint32

#include <vx_types.h>

A 32-bit unsigned value.

vx_uint64

typedef uint64_t vx_uint64

#include <vx_types.h>

A 64-bit unsigned value.

vx_uint8

typedef uint8_t vx_uint8

#include <vx_types.h>

An 8-bit unsigned value.

Enumeration Type Documentation

vx_bool_e

enum vx_bool_e

#include <vx_types.h>

A Boolean value. This allows 0 to be FALSE, as it is in C, and any non-zero to be TRUE.

vx_bool ret = vx_true_e;
if (ret) printf("true!\n");
ret = vx_false_e;
if (!ret) printf("false!\n");

This would print both strings.

See also

vx_bool

Enumerator
vx_false_e	The "false" value.
vx_true_e	The "true" value.

vx_channel_e

enum vx_channel_e

#include <vx_types.h>

The channel enumerations for channel extractions.

See also

vxChannelExtractNode

vxuChannelExtract

VX_KERNEL_CHANNEL_EXTRACT

Enumerator
VX_CHANNEL_0	Used by formats with unknown channel types.
VX_CHANNEL_1	Used by formats with unknown channel types.
VX_CHANNEL_2	Used by formats with unknown channel types.
VX_CHANNEL_3	Used by formats with unknown channel types.
VX_CHANNEL_R	Use to extract the RED channel, no matter the byte or packing order.
VX_CHANNEL_G	Use to extract the GREEN channel, no matter the byte or packing order.
VX_CHANNEL_B	Use to extract the BLUE channel, no matter the byte or packing order.
VX_CHANNEL_A	Use to extract the ALPHA channel, no matter the byte or packing order.
VX_CHANNEL_Y	Use to extract the LUMA channel, no matter the byte or packing order.
VX_CHANNEL_U	Use to extract the Cb/U channel, no matter the byte or packing order.
VX_CHANNEL_V	Use to extract the Cr/V/Value channel, no matter the byte or packing order.

vx_convert_policy_e

enum vx_convert_policy_e

#include <vx_types.h>

The Conversion Policy Enumeration.

Enumerator
VX_CONVERT_POLICY_WRAP	Results are the least significant bits of the output operand, as if stored in two's complement binary format in the size of its bit-depth.
VX_CONVERT_POLICY_SATURATE	Results are saturated to the bit depth of the output operand.

vx_df_image_e

enum vx_df_image_e

#include <vx_types.h>

Based on the VX_DF_IMAGE definition.

Note

Use vx_df_image to contain these values.

Enumerator
VX_DF_IMAGE_VIRT	A virtual image of no defined type.
VX_DF_IMAGE_RGB	A single plane of 24-bit pixel as 3 interleaved 8-bit units of R then G then B data. This uses the BT709 full range by default.
VX_DF_IMAGE_RGBX	A single plane of 32-bit pixel as 4 interleaved 8-bit units of R then G then B data, then a don't care byte. This uses the BT709 full range by default.
VX_DF_IMAGE_NV12	A 2-plane YUV format of Luma (Y) and interleaved UV data at 4:2:0 sampling. This uses the BT709 full range by default.
VX_DF_IMAGE_NV21	A 2-plane YUV format of Luma (Y) and interleaved VU data at 4:2:0 sampling. This uses the BT709 full range by default.
VX_DF_IMAGE_UYVY	A single plane of 32-bit macro pixel of U0, Y0, V0, Y1 bytes. This uses the BT709 full range by default.
VX_DF_IMAGE_YUYV	A single plane of 32-bit macro pixel of Y0, U0, Y1, V0 bytes. This uses the BT709 full range by default.
VX_DF_IMAGE_IYUV	A 3 plane of 8-bit 4:2:0 sampled Y, U, V planes. This uses the BT709 full range by default.
VX_DF_IMAGE_YUV4	A 3 plane of 8 bit 4:4:4 sampled Y, U, V planes. This uses the BT709 full range by default.
VX_DF_IMAGE_U1	A single plane of unsigned 1-bit data packed eight pixels per byte. The least significant bit is the first pixel in each byte. See vx_imagepatch_addressing_t for more details.
VX_DF_IMAGE_U8	A single plane of unsigned 8-bit data. The range of data is not specified, as it may be extracted from a YUV or generated.
VX_DF_IMAGE_U16	A single plane of unsigned 16-bit data. The range of data is not specified, as it may be extracted from a YUV or generated.
VX_DF_IMAGE_S16	A single plane of signed 16-bit data. The range of data is not specified, as it may be extracted from a YUV or generated.
VX_DF_IMAGE_U32	A single plane of unsigned 32-bit data. The range of data is not specified, as it may be extracted from a YUV or generated.
VX_DF_IMAGE_S32	A single plane of unsigned 32-bit data. The range of data is not specified, as it may be extracted from a YUV or generated.

vx_enum_e

enum vx_enum_e

#include <vx_types.h>

The set of supported enumerations in OpenVX.

These can be extracted from enumerated values using VX_ENUM_TYPE.

Enumerator
VX_ENUM_DIRECTION	Parameter Direction.
VX_ENUM_ACTION	Action Codes.
VX_ENUM_HINT	Hint Values.
VX_ENUM_DIRECTIVE	Directive Values.
VX_ENUM_INTERPOLATION	Interpolation Types.
VX_ENUM_OVERFLOW	Overflow Policies.
VX_ENUM_COLOR_SPACE	Color Space.
VX_ENUM_COLOR_RANGE	Color Space Range.
VX_ENUM_PARAMETER_STATE	Parameter State.
VX_ENUM_CHANNEL	Channel Name.
VX_ENUM_CONVERT_POLICY	Convert Policy.
VX_ENUM_THRESHOLD_TYPE	Threshold Type List.
VX_ENUM_BORDER	Border Mode List.
VX_ENUM_COMPARISON	Comparison Values.
VX_ENUM_MEMORY_TYPE	The memory type enumeration.
VX_ENUM_TERM_CRITERIA	A termination criteria.
VX_ENUM_NORM_TYPE	A norm type.
VX_ENUM_ACCESSOR	An accessor flag type.
VX_ENUM_ROUND_POLICY	Rounding Policy.
VX_ENUM_TARGET	Target.
VX_ENUM_BORDER_POLICY	Unsupported Border Mode Policy List.
VX_ENUM_GRAPH_STATE	Graph attribute states.
VX_ENUM_NONLINEAR	Non-linear function list.
VX_ENUM_PATTERN	Matrix pattern enumeration.
VX_ENUM_LBP_FORMAT	Lbp format.
VX_ENUM_COMP_METRIC	Compare metric.
VX_ENUM_SCALAR_OPERATION	Scalar operation list.

vx_interpolation_type_e

enum vx_interpolation_type_e

#include <vx_types.h>

The image reconstruction filters supported by image resampling operations.

The edge of a pixel is interpreted as being aligned to the edge of the image. The value for an output pixel is evaluated at the center of that pixel.

This means, for example, that an even enlargement of a factor of two in nearest-neighbor interpolation will replicate every source pixel into a 2x2 quad in the destination, and that an even shrink by a factor of two in bilinear interpolation will create each destination pixel by average a 2x2 quad of source pixels.

Samples that cross the boundary of the source image have values determined by the border mode - see vx_border_e and VX_NODE_BORDER.

See also

vxuScaleImage

vxScaleImageNode

VX_KERNEL_SCALE_IMAGE

vxuWarpAffine

vxWarpAffineNode

VX_KERNEL_WARP_AFFINE

vxuWarpPerspective

vxWarpPerspectiveNode

VX_KERNEL_WARP_PERSPECTIVE

Enumerator
VX_INTERPOLATION_NEAREST_NEIGHBOR	Output values are defined to match the source pixel whose center is nearest to the sample position.
VX_INTERPOLATION_BILINEAR	Output values are defined by bilinear interpolation between the pixels whose centers are closest to the sample position, weighted linearly by the distance of the sample from the pixel centers.
VX_INTERPOLATION_AREA	Output values are determined by averaging the source pixels whose areas fall under the area of the destination pixel, projected onto the source image.

vx_non_linear_filter_e

enum vx_non_linear_filter_e

#include <vx_types.h>

An enumeration of non-linear filter functions.

Enumerator
VX_NONLINEAR_FILTER_MEDIAN	Nonlinear median filter.
VX_NONLINEAR_FILTER_MIN	Nonlinear Erode.
VX_NONLINEAR_FILTER_MAX	Nonlinear Dilate.

vx_pattern_e

enum vx_pattern_e

#include <vx_types.h>

An enumeration of matrix patterns. See vxCreateMatrixFromPattern and vxCreateMatrixFromPatternAndOrigin

Enumerator
VX_PATTERN_BOX	Box pattern matrix.
VX_PATTERN_CROSS	Cross pattern matrix.
VX_PATTERN_DISK	A square matrix (rows = columns = size)
VX_PATTERN_OTHER	Matrix with any pattern other than above.

vx_status_e

enum vx_status_e

#include <vx_types.h>

The enumeration of all status codes.

See also

vx_status.

Enumerator
VX_STATUS_MIN	Indicates the lower bound of status codes in VX. Used for bounds checks only.
VX_ERROR_REFERENCE_NONZERO	Indicates that an operation did not complete due to a reference count being non-zero.
VX_ERROR_MULTIPLE_WRITERS	Indicates that the graph has more than one node outputting to the same data object. This is an invalid graph structure.
VX_ERROR_GRAPH_ABANDONED	Indicates that the graph is stopped due to an error or a callback that abandoned execution.
VX_ERROR_GRAPH_SCHEDULED	Indicates that the supplied graph already has been scheduled and may be currently executing.
VX_ERROR_INVALID_SCOPE	Indicates that the supplied parameter is from another scope and cannot be used in the current scope.
VX_ERROR_INVALID_NODE	Indicates that the supplied node could not be created.
VX_ERROR_INVALID_GRAPH	Indicates that the supplied graph has invalid connections (cycles).
VX_ERROR_INVALID_TYPE	Indicates that the supplied type parameter is incorrect.
VX_ERROR_INVALID_VALUE	Indicates that the supplied parameter has an incorrect value.
VX_ERROR_INVALID_DIMENSION	Indicates that the supplied parameter is too big or too small in dimension.
VX_ERROR_INVALID_FORMAT	Indicates that the supplied parameter is in an invalid format.
VX_ERROR_INVALID_LINK	Indicates that the link is not possible as specified. The parameters are incompatible.
VX_ERROR_INVALID_REFERENCE	Indicates that the reference provided is not valid.
VX_ERROR_INVALID_MODULE	This is returned from vxLoadKernels when the module does not contain the entry point.
VX_ERROR_INVALID_PARAMETERS	Indicates that the supplied parameter information does not match the kernel contract.
VX_ERROR_OPTIMIZED_AWAY	Indicates that the object refered to has been optimized out of existence.
VX_ERROR_NO_MEMORY	Indicates that an internal or implicit allocation failed. Typically catastrophic. After detection, deconstruct the context. See also vxVerifyGraph.
VX_ERROR_NO_RESOURCES	Indicates that an internal or implicit resource can not be acquired (not memory). This is typically catastrophic. After detection, deconstruct the context. See also vxVerifyGraph.
VX_ERROR_NOT_COMPATIBLE	Indicates that the attempt to link two parameters together failed due to type incompatibilty.
VX_ERROR_NOT_ALLOCATED	Indicates to the system that the parameter must be allocated by the system.
VX_ERROR_NOT_SUFFICIENT	Indicates that the given graph has failed verification due to an insufficient number of required parameters, which cannot be automatically created. Typically this indicates required atomic parameters. See also vxVerifyGraph.
VX_ERROR_NOT_SUPPORTED	Indicates that the requested set of parameters produce a configuration that cannot be supported. Refer to the supplied documentation on the configured kernels. See also vx_kernel_e. This is also returned if a function to set an attribute is called on a Read-only attribute.
VX_ERROR_NOT_IMPLEMENTED	Indicates that the requested kernel is missing. See also vx_kernel_e vxGetKernelByName.
VX_FAILURE	Indicates a generic error code, used when no other describes the error.
VX_SUCCESS	No error.

vx_target_e

enum vx_target_e

#include <vx_types.h>

The Target Enumeration.

Enumerator
VX_TARGET_ANY	Any available target. An OpenVX implementation must support at least one target associated with this value.
VX_TARGET_STRING	Target, explicitly specified by its (case-insensitive) name string.
VX_TARGET_VENDOR_BEGIN	Start of Vendor specific target enumerates.

vx_type_e

enum vx_type_e

#include <vx_types.h>

The type enumeration lists all the known types in OpenVX.

Enumerator
VX_TYPE_INVALID	An invalid type value. When passed an error must be returned.
VX_TYPE_CHAR	A vx_char.
VX_TYPE_INT8	A vx_int8.
VX_TYPE_UINT8	A vx_uint8.
VX_TYPE_INT16	A vx_int16.
VX_TYPE_UINT16	A vx_uint16.
VX_TYPE_INT32	A vx_int32.
VX_TYPE_UINT32	A vx_uint32.
VX_TYPE_INT64	A vx_int64.
VX_TYPE_UINT64	A vx_uint64.
VX_TYPE_FLOAT32	A vx_float32.
VX_TYPE_FLOAT64	A vx_float64.
VX_TYPE_ENUM	A vx_enum. Equivalent in size to a vx_int32.
VX_TYPE_SIZE	A vx_size.
VX_TYPE_DF_IMAGE	A vx_df_image.
VX_TYPE_FLOAT16	A vx_float16.
VX_TYPE_BOOL	A vx_bool.
VX_TYPE_RECTANGLE	A vx_rectangle_t.
VX_TYPE_KEYPOINT	A vx_keypoint_t.
VX_TYPE_COORDINATES2D	A vx_coordinates2d_t.
VX_TYPE_COORDINATES3D	A vx_coordinates3d_t.
VX_TYPE_COORDINATES2DF	A vx_coordinates2df_t.
VX_TYPE_HOG_PARAMS	A vx_hog_t.
VX_TYPE_HOUGH_LINES_PARAMS	A vx_hough_lines_p_t.
VX_TYPE_LINE_2D	A vx_line2d_t.
VX_TYPE_TENSOR_MATRIX_MULTIPLY_PARAMS	A vx_tensor_matrix_multiply_params_t.
VX_TYPE_USER_STRUCT_START	A user-defined struct base index.
VX_TYPE_VENDOR_STRUCT_START	A vendor-defined struct base index.
VX_TYPE_KHRONOS_OBJECT_START	A Khronos defined object base index.
VX_TYPE_VENDOR_OBJECT_START	A vendor defined object base index.
VX_TYPE_KHRONOS_STRUCT_MAX	A value for comparison between Khronos defined structs and user structs.
VX_TYPE_USER_STRUCT_END	A value for comparison between user structs and vendor structs.
VX_TYPE_VENDOR_STRUCT_END	A value for comparison between vendor structs and Khronos defined objects.
VX_TYPE_KHRONOS_OBJECT_END	A value for comparison between Khronos defined objects and vendor structs.
VX_TYPE_VENDOR_OBJECT_END	A value used for bound checking of vendor objects.
VX_TYPE_REFERENCE	A vx_reference.
VX_TYPE_CONTEXT	A vx_context.
VX_TYPE_GRAPH	A vx_graph.
VX_TYPE_NODE	A vx_node.
VX_TYPE_KERNEL	A vx_kernel.
VX_TYPE_PARAMETER	A vx_parameter.
VX_TYPE_DELAY	A vx_delay.
VX_TYPE_LUT	A vx_lut.
VX_TYPE_DISTRIBUTION	A vx_distribution.
VX_TYPE_PYRAMID	A vx_pyramid.
VX_TYPE_THRESHOLD	A vx_threshold.
VX_TYPE_MATRIX	A vx_matrix.
VX_TYPE_CONVOLUTION	A vx_convolution.
VX_TYPE_SCALAR	A vx_scalar. when needed to be completely generic for kernel validation.
VX_TYPE_ARRAY	A vx_array.
VX_TYPE_IMAGE	A vx_image.
VX_TYPE_REMAP	A vx_remap.
VX_TYPE_ERROR	An error object which has no type.
VX_TYPE_META_FORMAT	A vx_meta_format.
VX_TYPE_OBJECT_ARRAY	A vx_object_array.
VX_TYPE_TENSOR	A vx_tensor.

vx_type_ext_e

enum vx_type_ext_e

#include <vx_corevx_ext.h>

The type enumeration lists additional types to extend the known types in OpenVX.

Enumerator
VX_TYPE_STRING	A vx_string.

vx_vendor_id_e

enum vx_vendor_id_e

#include <vx_vendors.h>

The Vendor ID of the Implementation. As new vendors submit their implementations, this enumeration will grow.

Enumerator
VX_ID_KHRONOS	The Khronos Group.
VX_ID_TI	Texas Instruments, Inc.
VX_ID_QUALCOMM	Qualcomm, Inc.
VX_ID_NVIDIA	NVIDIA Corporation.
VX_ID_ARM	ARM Ltd.
VX_ID_BDTI	Berkley Design Technology, Inc.
VX_ID_RENESAS	Renasas Electronics.
VX_ID_VIVANTE	Vivante Corporation.
VX_ID_XILINX	Xilinx Inc.
VX_ID_AXIS	Axis Communications.
VX_ID_MOVIDIUS	Movidius Ltd.
VX_ID_SAMSUNG	Samsung Electronics.
VX_ID_FREESCALE	Freescale Semiconductor.
VX_ID_AMD	Advanced Micro Devices.
VX_ID_BROADCOM	Broadcom Corporation.
VX_ID_INTEL	Intel Corporation.
VX_ID_MARVELL	Marvell Technology Group Ltd.
VX_ID_MEDIATEK	MediaTek, Inc.
VX_ID_ST	STMicroelectronics.
VX_ID_CEVA	CEVA DSP.
VX_ID_ITSEEZ	Itseez, Inc.
VX_ID_IMAGINATION	Imagination Technologies.
VX_ID_NXP	NXP Semiconductors.
VX_ID_VIDEANTIS	Videantis.
VX_ID_SYNOPSYS	Synopsys.
VX_ID_CADENCE	Cadence.
VX_ID_HUAWEI	Huawei.
VX_ID_SOCIONEXT	Socionext.
VX_ID_USER	For use by vxAllocateUserKernelId and vxAllocateUserKernelLibraryId.
VX_ID_MAX
VX_ID_DEFAULT	For use by all Kernel authors until they can obtain an assigned ID.

vx_vendor_id_ext_e

enum vx_vendor_id_ext_e

#include <vx_corevx_ext.h>

Define Edge AI Vendor ID.

Enumerator
VX_ID_EDGE_AI

Function Documentation

vxGetStatus()

VX_API_ENTRY vx_status VX_API_CALL vxGetStatus

(

vx_reference

reference

)

#include <vx_api.h>

Provides a generic API to return status values from Object constructors if they fail.

Note

Users do not need to strictly check every object creator as the errors should properly propagate and be detected during verification time or run-time.

vx_image img = vxCreateImage(context, 639, 480, VX_DF_IMAGE_UYVY);
vx_status status = vxGetStatus((vx_reference)img);
// status == VX_ERROR_INVALID_DIMENSIONS
vxReleaseImage(&img);

Precondition

Appropriate Object Creator function.

Postcondition

Appropriate Object Release function.

Parameters

[in]

reference

The reference to check for construction errors.

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS	No errors; any other value indicates failure.
*	Some error occurred, please check enumeration list and constructor.