VPI - Vision Programming Interface

0.4.4 Release

ImageFormat.h File Reference

Defines types and functions to handle image formats. More...

#include "Format.h"
#include "PixelFormat.h"
#include <assert.h>
+ Include dependency graph for ImageFormat.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define VPI_MAKE_IMAGE_FORMAT(colorSpace, chromaSubsamp, memLayout, dataType, swizzle, numPlanes, packing0, packing1, ...)
 Creates an user-defined image format constant using abbreviated parameters. More...
 

Enumerations

enum  VPIImageFormat
 Pre-defined image formats. More...
 

Functions

VPIImageFormat vpiMakeImageFormat (VPIColorSpace colorSpace, VPIChromaSubsampling chromaSub, VPIMemLayout memLayout, VPIFormatDataType dataType, VPISwizzle swizzle, VPIFormatPacking packing0, VPIFormatPacking packing1, VPIFormatPacking packing2, VPIFormatPacking packing3)
 Creates an user-defined image format. More...
 
VPIFormatPacking vpiImageFormatGetPlanePacking (VPIImageFormat fmt, int plane)
 Get the packing for a given plane of an image format. More...
 
int vpiImageFormatGetPlaneBitsPerPixel (VPIImageFormat fmt, int plane)
 Get the image format's plane bits per pixel count. More...
 
VPIImageFormat vpiImageFormatSetDataType (VPIImageFormat fmt, VPIFormatDataType dataType)
 Set the image format's data type. More...
 
VPIFormatDataType vpiImageFormatGetDataType (VPIImageFormat fmt)
 Get the image format's data type. More...
 
VPISwizzle vpiImageFormatGetSwizzle (VPIImageFormat fmt)
 Get the image format's channel swizzle operation. More...
 
VPISwizzle vpiImageFormatGetPlaneSwizzle (VPIImageFormat fmt, int plane)
 Get the swizzle operation of the given image format's plane. More...
 
VPISwizzleChannel vpiImageFormatGetSwizzleX (VPIImageFormat fmt)
 Get the color model channel that corresponds to the first component of given image format. More...
 
VPISwizzleChannel vpiImageFormatGetSwizzleY (VPIImageFormat fmt)
 Get the color model channel that corresponds to the second component of given image format. More...
 
VPISwizzleChannel vpiImageFormatGetSwizzleZ (VPIImageFormat fmt)
 Get the color model channel that corresponds to the third component of given image format. More...
 
VPISwizzleChannel vpiImageFormatGetSwizzleW (VPIImageFormat fmt)
 Get the color model channel that corresponds to the fourth component of given image format. More...
 
VPIImageFormat vpiImageFormatSetMemLayout (VPIImageFormat fmt, VPIMemLayout memLayout)
 Set the image format's memory layout. More...
 
VPIMemLayout vpiImageFormatGetMemLayout (VPIImageFormat fmt)
 Get the image format's memory layout. More...
 
VPIImageFormat vpiImageFormatSetColorSpace (VPIImageFormat fmt, VPIColorSpace colorSpace)
 Set the image format's color space. More...
 
VPIColorSpace vpiImageFormatGetColorSpace (VPIImageFormat fmt)
 Get the image format's color space. More...
 
VPIColorModel vpiImageFormatGetColorModel (VPIImageFormat fmt)
 Get the image format's color model. More...
 
VPIImageFormat vpiImageFormatSetChromaSubsampling (VPIImageFormat fmt, VPIChromaSubsampling css)
 Set the image format's chroma subsampling type. More...
 
VPIChromaSubsampling vpiImageFormatGetChromaSubsampling (VPIImageFormat fmt)
 Get the image format's chroma subsampling type. More...
 
int vpiImageFormatGetChromaSubsamplingDivHoriz (VPIImageFormat fmt)
 Get the image format's chroma subsampling horizontal downscale factor. More...
 
int vpiImageFormatGetChromaSubsamplingDivVert (VPIImageFormat fmt)
 Get the image format's chroma subsampling vertical downscale factor. More...
 
int vpiImageFormatGetChromaSubsamplingCenterHoriz (VPIImageFormat fmt)
 Get the image format's chroma horizontal sample position. More...
 
int vpiImageFormatGetChromaSubsamplingCenterVert (VPIImageFormat fmt)
 Get the image format's chroma vertical sample position. More...
 
int vpiImageFormatGetPlaneChannelCount (VPIImageFormat fmt, int plane)
 Get the number of channels in a plane of an image format. More...
 
int vpiImageFormatGetPlaneCount (VPIImageFormat fmt)
 Get the number of planes of an image format. More...
 
int vpiImageFormatGetChannelCount (VPIImageFormat fmt)
 Get the total number of channels of an image format. More...
 
VPIPixelFormat vpiImageFormatGetPlanePixelFormat (VPIImageFormat fmt, int plane)
 Get the pixel format of image format's plane. More...
 
VPIImageFormat vpiImageFormatGetPlaneFormat (VPIImageFormat fmt, int plane)
 Get the plane format of an image format. More...
 
VPIImageFormat vpiMakeImageFormatFromPlanes (VPIImageFormat plane0, VPIImageFormat plane1, VPIImageFormat plane2, VPIImageFormat plane3)
 Constructs an image format given the format of each plane. More...
 

Detailed Description

Defines types and functions to handle image formats.

Definition in file ImageFormat.h.