VPI - Vision Programming Interface

1.2 Release

Array.h File Reference

Functions and structures for dealing with VPI arrays. More...

#include "Export.h"
#include "Status.h"
#include "Types.h"
#include <stdint.h>
#include "ArrayType.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...
 

Functions

VPIStatus vpiArrayCreate (int32_t capacity, VPIArrayType type, uint32_t flags, VPIArray *array)
 Create an empty array instance. More...
 
VPIStatus vpiArrayCreateHostMemWrapper (const VPIArrayData *arrayData, uint32_t flags, VPIArray *array)
 Create an array object by wrapping an existing host memory block. More...
 
VPIStatus vpiArraySetWrappedHostMem (VPIArray array, const VPIArrayData *arrayData)
 Redefines the wrapped host memory in an existing VPIArray wrapper. More...
 
void vpiArrayDestroy (VPIArray array)
 Destroy an array instance. More...
 
VPIStatus vpiArrayInvalidate (VPIArray array)
 Informs that the array's wrapped memory was updated outside VPI. More...
 
VPIStatus vpiArrayGetSize (VPIArray array, int32_t *size)
 Returns the array size in elements. More...
 
VPIStatus vpiArraySetSize (VPIArray array, int32_t size)
 Set the array size in elements. More...
 
VPIStatus vpiArrayGetCapacity (VPIArray array, int32_t *capacity)
 Returns the array capacity in elements. More...
 
VPIStatus vpiArrayGetStrideBytes (VPIArray array, int32_t *strideBytes)
 Returns the array stride (distance between two consecutive elements) in bytes. More...
 
VPIStatus vpiArrayGetFlags (VPIArray array, uint32_t *flags)
 Returns the array flags. More...
 
VPIStatus vpiArrayGetType (VPIArray array, VPIArrayType *type)
 Returns 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.