VPI - Vision Programming Interface

1.0 Release

DataLayout.h File Reference

Defines types and functions to handle data layouts. More...

#include "Export.h"
#include "detail/FormatUtils.h"
+ Include dependency graph for DataLayout.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  VPIPackingParams
 Defines the parameters encoded in a VPIPacking. More...
 

Macros

#define VPI_MAKE_SWIZZLE_ABBREV(x, y, z, w)
 Creates a user-defined swizzle operation, using abbreviated parameters. More...
 
#define VPI_MAKE_SWIZZLE(x, y, z, w)
 Creates a user-defined swizzle operation. More...
 

Enumerations

enum  VPIPacking
 Defines how channels are packed into an image plane element. More...
 
enum  VPIDataType
 Defines the channel data type. More...
 
enum  VPIMemLayout
 Defines how the 2D plane pixels are laid out in memory. More...
 
enum  VPIChannel
 Defines the format channel names. More...
 
enum  VPISwizzle
 Defines the supported channel swizzle operations. More...
 
enum  VPIEndianness
 Endianness of a VPIPacking value. More...
 

Functions

VPISwizzle vpiMakeSwizzle (VPIChannel x, VPIChannel y, VPIChannel z, VPIChannel w)
 Creates a user-defined VPISwizzle operation. More...
 
void vpiSwizzleGetChannels (VPISwizzle swizzle, VPIChannel *channels)
 Get the swizzle channels. More...
 
int vpiSwizzleGetChannelCount (VPISwizzle swizzle)
 Get the number of channels specified by the given swizzle. More...
 
VPIPacking vpiMakePacking (const VPIPackingParams *params)
 Returns a pre-defined VPIPacking given its params. More...
 
void vpiPackingGetParams (VPIPacking packing, VPIPackingParams *params)
 Returns channels' information from a format packing. More...
 
int vpiPackingGetComponentCount (VPIPacking packing)
 Returns the number of components defined by the given packing. More...
 
void vpiPackingGetBitsPerComponent (VPIPacking packing, int32_t *bits)
 Returns the number of bits per packing component. More...
 
int vpiPackingGetBitsPerPixel (VPIPacking packing)
 Returns the number of bits per pixel of the given packing. More...
 

Detailed Description

Defines types and functions to handle data layouts.

Definition in file DataLayout.h.