Header Files
VX Corporation maintains three header files per library.
Published: (VxLibPub.h)
This file contains structures and defines which are made available to the public through OpenVX, our C Language API.
Local: (VxLib.h)
This file contains structures and defines which may be used by functions belonging to other VX libraries.
Private: (VxLibPr.h)
This file contains information used only by functions within that specific library.
These header files are nested for each library. The order
of nested inclusion is as follows:
VxLibPub.h --> VxLib.h --> VxLibPr.h
All of the published header files are included in a single header file OpenVX/inc/OpenVX.h. Thus all OpenVX C files should #include "OpenVX/inc/OpenVxUser.h". This header file also includes a local header file OpenVX/inc/OpenVxUser.h. This file is the intended location for OpenVX customers to add their own global structures and defines.
VX Header files maintain a basic recommended hierarchy as follows:
Defines
Structures
Externs
Function prototypes
Macros
It is recommended that OpenVX users look through all the published header files since these contain many useful macros and structures.