VPI - Vision Programming Interface

0.1.0 Release

Array.h File Reference
#include <stdint.h>
#include "Export.h"
#include "Status.h"
#include "Types.h"
+ Include dependency graph for Array.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  VPIArrayData
 Stores information about array characteristics and content. More...
 

Macros

Array flags
#define VPI_ARRAY_NO_PVA   0x01
 Array can't be used by PVA backend.
 
#define VPI_ARRAY_NO_CPU   0x02
 Array can't be used by CPU backend.
 
#define VPI_ARRAY_NO_CUDA   0x04
 Array can't be used by CUDA backend.
 
Array helper flags
#define VPI_ARRAY_ONLY_CUDA   (VPI_ARRAY_NO_PVA | VPI_ARRAY_NO_CPU)
 Array can only be used by CUDA backend.
 
#define VPI_ARRAY_ONLY_CPU   (VPI_ARRAY_NO_PVA | VPI_ARRAY_NO_CUDA)
 Array can only be used by CPU backend.
 
#define VPI_ARRAY_ONLY_PVA   (VPI_ARRAY_NO_CUDA | VPI_ARRAY_NO_CPU)
 Array can only be used by PVA backend.
 

Functions

VPIStatus vpiArrayCreate (uint32_t capacity, VPIArrayType fmt, uint32_t flags, VPIArray *array)
 Create an empty array instance with the specified flags. More...
 
void vpiArrayDestroy (VPIArray array)
 Destroy an array instance as well as all resources it owns. More...
 
VPIStatus vpiArrayWrapHostMem (const VPIArrayData *arrayData, uint32_t flags, VPIArray *array)
 Create an array object by wrapping around an existing host-memory block. More...
 
VPIStatus vpiArrayWrapCudaDeviceMem (const VPIArrayData *arrayData, uint32_t flags, VPIArray *array)
 Create an array object by wrapping around an existing device-memory (CUDA) block. More...
 
VPIStatus vpiArrayInvalidate (VPIArray array)
 This method is useful for unmanaged arrays only (created with 'vpiArrayWrap*`). More...
 
VPIStatus vpiArrayGetSize (VPIArray array, uint32_t *size)
 Get the array size in elements. More...
 
VPIStatus vpiArraySetSize (VPIArray array, uint32_t size)
 Set the array size in elements. More...
 
VPIStatus vpiArrayGetCapacity (VPIArray array, uint32_t *capacity)
 Get the array capacity in elements. More...
 
VPIStatus vpiArrayGetStride (VPIArray array, uint32_t *stride)
 Get the array stride (distance between two consecutive elements) in bytes. More...
 
VPIStatus vpiArrayGetFlags (VPIArray array, uint32_t *flags)
 Get the array flags. More...
 
VPIStatus vpiArrayGetType (VPIArray array, VPIArrayType *type)
 Get the array type. More...
 
VPIStatus vpiArrayLock (VPIArray array, VPILockMode mode, VPIArrayData *arrayData)
 Acquires the lock on array object and returns a pointer to array data. More...
 
VPIStatus vpiArrayUnlock (VPIArray array)
 Releases the lock on array object. More...
 

Detailed Description

Functions and structures for dealing with VPI arrays.

Definition in file Array.h.