VPI - Vision Programming Interface

0.1.0 Release

Getting Started

This section is directed to programmers that are having their first contact with VPI.

It's divided in the following subsections:

  • Installation - gives instructions on how to install VPI on the target device.
  • Basic Concepts - Exposes basic concepts succintly, giving a big picture on how VPI works.
  • Tutorial - Hands-on tutorial teaching how to write a simple, albeit full VPI application from scratch.
VPI_PIXEL_TYPE_DEFAULT
Used to signal that the pixel type must be inferred from image type.
Definition: Types.h:188
VPIImagePlane::height
uint32_t height
Height of this plane in pixels.
Definition: Image.h:126
VPIImagePlane::width
uint32_t width
Width of this plane in pixels.
Definition: Image.h:125
vpiSubmitBoxImageFilter
VPIStatus vpiSubmitBoxImageFilter(VPIStream stream, VPIImage input, VPIImage output, uint32_t kernelSizeX, uint32_t kernelSizeY, VPIBoundaryCond boundary)
Runs a 2D box filter over an image.
BoxImageFilter.h
VPIImagePlane::rowStride
uint32_t rowStride
Difference in bytes of beginning of one row and the beginning of the previous.
Definition: Image.h:127
vpiImageUnlock
VPIStatus vpiImageUnlock(VPIImage img)
Releases the lock on an image object.
vpiStreamCreate
VPIStatus vpiStreamCreate(VPIDeviceType devType, VPIStream *stream)
Create a stream instance.
vpiStreamSync
VPIStatus vpiStreamSync(VPIStream stream)
Blocks the calling thread until all submitted commands in this stream queue are done (queue is empty)...
VPIImageData
Stores information about image characteristics and content.
Definition: Image.h:143
vpiStreamDestroy
void vpiStreamDestroy(VPIStream stream)
Destroy a stream instance and deallocate all HW resources.
VPI_LOCK_READ
Lock memory only for reading.
Definition: Types.h:386
VPIImageData::planes
VPIImagePlane planes[VPI_MAX_PLANE_COUNT]
Data of all image planes.
Definition: Image.h:151
vpiImageDestroy
void vpiImageDestroy(VPIImage img)
Destroy an image instance as well as all resources it owns.
VPIImagePlane::pixelType
VPIPixelType pixelType
Type of each pixel within this plane.
Definition: Image.h:124
VPI_IMAGE_TYPE_Y8
unsigned 8-bit grayscale/luma.
Definition: Types.h:174
Image.h
VPIImage
struct VPIImageImpl * VPIImage
Definition: Types.h:153
VPIImageData::numPlanes
int32_t numPlanes
Number of planes.
Definition: Image.h:146
vpiImageLock
VPIStatus vpiImageLock(VPIImage img, VPILockMode mode, VPIImageData *hostData)
Acquires the lock on an image object and returns a pointer to the image planes Depending on the inter...
VPIImageData::type
VPIImageType type
Image type.
Definition: Image.h:145
vpiImageCreate
VPIStatus vpiImageCreate(uint32_t width, uint32_t height, VPIImageType type, uint32_t flags, VPIImage *img)
Create an empty image instance with the specified flags.
VPI_BOUNDARY_COND_ZERO
All pixels outside the image are considered to be zero.
Definition: Types.h:204
vpiImageWrapHostMem
VPIStatus vpiImageWrapHostMem(const VPIImageData *hostData, uint32_t flags, VPIImage *img)
Create an image object by wrapping around an existing host-memory block.
Stream.h
VPIImagePlane::data
void * data
Pointer to the first row of this plane.
Definition: Image.h:135
VPIStream
struct VPIStreamImpl * VPIStream
Definition: Types.h:147
VPI_DEVICE_TYPE_CUDA
CUDA backend.
Definition: Types.h:434