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 | VPIArrayBufferAOS |
| Stores information about array characteristics and content. More... | |
| struct | VPIArrayBuffer |
| Represents the availablemethods to access array contents. More... | |
| struct | VPIArrayData |
| Stores information about array characteristics and contents. More... | |
Enumerations | |
| enum | VPIArrayBufferType |
| Represents how the array data is stored. More... | |
Functions | |
| VPIStatus | vpiArrayCreate (int32_t capacity, VPIArrayType type, uint64_t flags, VPIArray *array) |
| Create an empty array instance. More... | |
| VPIStatus | vpiArrayCreateWrapper (const VPIArrayData *data, uint64_t flags, VPIArray *array) |
| Create an array object by wrapping an existing host memory block. More... | |
| VPIStatus | vpiArraySetWrapper (VPIArray array, const VPIArrayData *data) |
| Redefines the wrapped memory buffer in an existing VPIArray wrapper. More... | |
| void | vpiArrayDestroy (VPIArray array) |
| Destroy an array instance. 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, uint64_t *flags) |
| Returns the array flags. More... | |
| VPIStatus | vpiArrayGetType (VPIArray array, VPIArrayType *type) |
| Returns the array type. More... | |
| VPIStatus | vpiArrayLock (VPIArray array, VPILockMode mode) |
| Acquires the lock on an array object. More... | |
| VPIStatus | vpiArrayLockData (VPIArray array, VPILockMode mode, VPIArrayBufferType bufType, VPIArrayData *data) |
| Acquires the lock on an array object and returns the array contents. 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.