VPIImagePlaneRec Struct Reference

Stores information about an image plane. More...

#include <vpi/Image.h>

Collaboration diagram for VPIImagePlaneRec:

Data Fields
VPIPixelType	pixelType
	Type of each pixel within this plane.
uint32_t	width
	Width of this plane in pixels.
uint32_t	height
	Height of this plane in pixels.
uint32_t	rowStride
	Difference in bytes of beginning of one row and the beginning of the previous. More...
void *	data
	Pointer to the first row of this plane. More...

Detailed Description

Stores information about an image plane.

Image planes represent 2D data where consecutive rows are laid out in memory one after the other. This structure has all information needed to address any pixel in the plane.

Definition at line 122 of file Image.h.

Field Documentation

data

void* VPIImagePlaneRec::data

Pointer to the first row of this plane.

This points to the actual data represented by this plane. Depending on how the plane is used, the pointer might be addressing a GPU memory or host memory. Care is needed to know when it is allowed to dereference this memory.

Definition at line 135 of file Image.h.

rowStride

uint32_t VPIImagePlaneRec::rowStride

Difference in bytes of beginning of one row and the beginning of the previous.

This is used to address every row (and ultimately every pixel) in the plane.

T *pix_addr = (T *)((uint8_t *)data + rowStride*height)+width;

where T is the C type related to pixelType.

Definition at line 127 of file Image.h.

---

The documentation for this struct was generated from the following file:

• vpi/Image.h