VPI - Vision Programming Interface

2.1 Release

Image.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  VPIImagePlanePitchLinear
 Represents one image plane in pitch-linear layout. More...
 
struct  VPIImageBufferPitchLinear
 Stores the image plane contents. More...
 
union  VPIImageBuffer
 Represents the available methods to access image contents. More...
 
struct  VPIImageData
 Stores information about image characteristics and content. More...
 
struct  VPIImageWrapperParams
 Parameters for customizing image wrapping. More...
 

Macros

#define VPI_MAX_PLANE_COUNT   (6)
 Maximum number of data planes an image can have.
 

Enumerations

enum  VPIImageBufferType
 Represents how the image data is stored. More...
 

Functions

VPIStatus vpiImageCreate (int32_t width, int32_t height, VPIImageFormat fmt, uint64_t flags, VPIImage *img)
 Create an empty image instance with the specified flags. More...
 
VPIStatus vpiInitImageWrapperParams (VPIImageWrapperParams *params)
 Initialize VPIImageWrapperParams with default values. More...
 
VPIStatus vpiImageCreateView (VPIImage imgParent, const VPIRectangleI *clipBounds, uint64_t flags, VPIImage *imgView)
 Create an image that wraps an axis-aligned rectangular sub-region of an existing image. More...
 
VPIStatus vpiImageSetView (VPIImage view, VPIImage parent, const VPIRectangleI *clipBounds)
 Redefines the image view position inside a parent image. More...
 
VPIStatus vpiImageCreateWrapper (const VPIImageData *data, const VPIImageWrapperParams *params, uint64_t flags, VPIImage *img)
 Create an image object by wrapping an existing memory block. More...
 
VPIStatus vpiImageSetWrapper (VPIImage img, const VPIImageData *data)
 Redefines the wrapped memory in an existing VPIImage wrapper. More...
 
void vpiImageDestroy (VPIImage img)
 Destroy an image instance. More...
 
VPIStatus vpiImageGetSize (VPIImage img, int32_t *width, int32_t *height)
 Get the image dimensions in pixels. More...
 
VPIStatus vpiImageGetFormat (VPIImage img, VPIImageFormat *format)
 Get the image format. More...
 
VPIStatus vpiImageGetFlags (VPIImage img, uint64_t *flags)
 Get the image flags. More...
 
VPIStatus vpiImageLock (VPIImage img, VPILockMode mode)
 Acquires the lock on an image object. More...
 
VPIStatus vpiImageLockData (VPIImage img, VPILockMode mode, VPIImageBufferType bufType, VPIImageData *data)
 Acquires the lock on an image object and returns the image contents. More...
 
VPIStatus vpiImageUnlock (VPIImage img)
 Releases the lock on an image object. More...
 

Detailed Description

Functions and structures for dealing with VPI images.

Definition in file Image.h.