All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Image Handling

Classes

struct  VuImageInfo
 Data structure describing image data. More...
 

Typedefs

typedef struct VuImagePixelFormatList_ VuImagePixelFormatList
 List of image pixel formats.
 
typedef struct VuImage_ VuImage
 Vuforia Image.
 
typedef struct VuImageList_ VuImageList
 Vuforia Image List.
 

Enumerations

enum  VuImagePixelFormat : int32_t {
  VU_IMAGE_PIXEL_FORMAT_UNKNOWN = 0x1 ,
  VU_IMAGE_PIXEL_FORMAT_RGB565 = 0x2 ,
  VU_IMAGE_PIXEL_FORMAT_RGB888 = 0x3 ,
  VU_IMAGE_PIXEL_FORMAT_GRAYSCALE = 0x4 ,
  VU_IMAGE_PIXEL_FORMAT_RGBA8888 = 0x5 ,
  VU_IMAGE_PIXEL_FORMAT_NV21 = 0x6 ,
  VU_IMAGE_PIXEL_FORMAT_NV12 = 0x7 ,
  VU_IMAGE_PIXEL_FORMAT_YV12 = 0x8 ,
  VU_IMAGE_PIXEL_FORMAT_YUV420P = 0x9 ,
  VU_IMAGE_PIXEL_FORMAT_YUYV = 0xA ,
  VU_IMAGE_PIXEL_FORMAT_DEPTH_METER_FLOAT32 = 0x101 ,
  VU_IMAGE_PIXEL_FORMAT_DEPTH_CONFIDENCE_LMH_UINT8 = 0x201
}
 Pixel format types supported by Vuforia. More...
 

Functions

VuResult vuImagePixelFormatListCreate (VuImagePixelFormatList **list)
 Create an image pixel format list.
 
VuResult vuImagePixelFormatListGetSize (const VuImagePixelFormatList *list, int32_t *listSize)
 Get number of elements in an image pixel format list.
 
VuResult vuImagePixelFormatListGetElement (const VuImagePixelFormatList *list, int32_t element, VuImagePixelFormat *format)
 Get an element in an image pixel format list.
 
VuResult vuImagePixelFormatListDestroy (VuImagePixelFormatList *list)
 Destroy an image pixel format list.
 
VuResult vuImageGetImageInfo (const VuImage *image, VuImageInfo *imageInfo)
 Get Image data.
 
VuResult vuImageAcquireReference (const VuImage *image, VuImage **imageOut)
 Acquire a new reference to the given image.
 
VuResult vuImageRelease (VuImage *image)
 Release the given image.
 
VuResult vuImageListCreate (VuImageList **list)
 Create an image list.
 
VuResult vuImageListGetSize (const VuImageList *list, int32_t *numElements)
 Get number of elements in an image list.
 
VuResult vuImageListGetElement (const VuImageList *list, int32_t element, VuImage **image)
 Get an element in an image list.
 
VuResult vuImageListAppendElement (VuImageList *list, const VuImage *image)
 Append an element to an image list.
 
VuResult vuImageListDestroy (VuImageList *list)
 Destroy an image list.
 

Detailed Description

Enumeration Type Documentation

◆ VuImagePixelFormat

enum VuImagePixelFormat : int32_t

Pixel format types supported by Vuforia.

Note
Pixel format types containing FORMAT_DEPTH in the name are specific to depth frames, while others, which do not contain FORMAT_DEPTH, define video camera image pixel formats.
Enumerator
VU_IMAGE_PIXEL_FORMAT_UNKNOWN 

Unknown pixel format.

VU_IMAGE_PIXEL_FORMAT_RGB565 

A color pixel stored in 2 bytes using 5 bits for red, 6 bits for green and 5 bits for blue.

VU_IMAGE_PIXEL_FORMAT_RGB888 

A color pixel stored in 3 bytes using 8 bits each for red, green and blue.

VU_IMAGE_PIXEL_FORMAT_GRAYSCALE 

A grayscale pixel stored in one byte.

VU_IMAGE_PIXEL_FORMAT_RGBA8888 

A color pixel stored in 4 bytes using 8 bits each for red, green and blue and 8 bits for alpha channel.

VU_IMAGE_PIXEL_FORMAT_NV21 

YUV 4:2:0 with a plane of 8 bit Y (luma) samples followed by an interleaved plane of 8 bit, 2x2 subsampled, V/U (chroma) samples.

VU_IMAGE_PIXEL_FORMAT_NV12 

YUV 4:2:0 with a plane of 8 bit Y (luma) samples followed by an interleaved plane of 8 bit, 2x2 subsampled, U/V (chroma) samples.

VU_IMAGE_PIXEL_FORMAT_YV12 

YUV 4:2:0 with a plane of 8 bit Y (luma) samples followed by a plane of 8 bit, 2x2 subsampled, V (chroma) samples followed by a plane of 8 bit, 2x2 subsampled, U (chroma) samples.

VU_IMAGE_PIXEL_FORMAT_YUV420P 

YUV 4:2:0 with a plane of 8 bit Y (luma) samples followed by a plane of 8 bit, 2x2 subsampled, U (chroma) samples followed by a plane of 8 bit, 2x2 subsampled, V (chroma) samples. Note that this format is also known as I420

VU_IMAGE_PIXEL_FORMAT_YUYV 

YUV 4:2:2 with a single plane of interleaved 8 bit samples in YUYV order where each pixel has a Y value and U, V values 2x1 subsampled. Note that this format is also known as YUY2

VU_IMAGE_PIXEL_FORMAT_DEPTH_METER_FLOAT32 

A depth value in meters, stored in a 32-bit floating point value.

Note
This pixel format is part of a feature in beta and may change from release to release without notice.
VU_IMAGE_PIXEL_FORMAT_DEPTH_CONFIDENCE_LMH_UINT8 

A depth confidence pixel stored in one byte that can have one of the following three discrete values:

  • 0: low confidence
  • 1: medium confidence
  • 2: high confidence
Note
This pixel format is part of a feature in beta and may change from release to release without notice.