format.hpp File Reference

Namespaces

 kanzi
 

Enumerations

enum  kanzi::GraphicsElementType { kanzi::GraphicsElementTypeUINT, kanzi::GraphicsElementTypeSINT, kanzi::GraphicsElementTypeFLOAT }
 GraphicsElementType is used to specify type of element of data consumed by shaders. More...
 
enum  kanzi::GraphicsDataType {
  kanzi::GraphicsDataTypeNone, kanzi::GraphicsDataTypeUNORM8, kanzi::GraphicsDataTypeSNORM8, kanzi::GraphicsDataTypeUNORM16,
  kanzi::GraphicsDataTypeSNORM16, kanzi::GraphicsDataTypeUNORM32, kanzi::GraphicsDataTypeSNORM32, kanzi::GraphicsDataTypeUNORM_PACK16_5_6_5,
  kanzi::GraphicsDataTypeCOMPRESSED, kanzi::GraphicsDataTypeUINT8, kanzi::GraphicsDataTypeSINT8, kanzi::GraphicsDataTypeUINT16,
  kanzi::GraphicsDataTypeSINT16, kanzi::GraphicsDataTypeUINT32, kanzi::GraphicsDataTypeSINT32, kanzi::GraphicsDataTypeSFLOAT16,
  kanzi::GraphicsDataTypeSFLOAT32, kanzi::GraphicsDataTypeUNORM24, kanzi::GraphicsDataTypeUNORM24_UINT8, kanzi::GraphicsDataTypeUNORM_PACK32_2_10_10_10,
  kanzi::GraphicsDataTypeSNORM_PACK32_2_10_10_10
}
 GraphicsDataType is used to specify type of data in textures and vertex buffers. More...
 
enum  kanzi::GraphicsFormat {
  kanzi::GraphicsFormatNone, kanzi::GraphicsFormatLUMINANCE8_UNORM, kanzi::GraphicsFormatALPHA8_UNORM, kanzi::GraphicsFormatLUMINANCE8_ALPHA8_UNORM,
  kanzi::GraphicsFormatR8_UNORM, kanzi::GraphicsFormatR8_UINT, kanzi::GraphicsFormatR8_SINT, kanzi::GraphicsFormatR8G8_UNORM,
  kanzi::GraphicsFormatR8G8_UINT, kanzi::GraphicsFormatR8G8_SINT, kanzi::GraphicsFormatR8G8B8_UNORM, kanzi::GraphicsFormatR8G8B8_SRGB,
  kanzi::GraphicsFormatR8G8B8_UINT, kanzi::GraphicsFormatR8G8B8_SINT, kanzi::GraphicsFormatR8G8B8A8_UNORM, kanzi::GraphicsFormatR8G8B8A8_SRGB,
  kanzi::GraphicsFormatR8G8B8A8_UINT, kanzi::GraphicsFormatR8G8B8A8_SINT, kanzi::GraphicsFormatR16_UINT, kanzi::GraphicsFormatR16_SINT,
  kanzi::GraphicsFormatR16_SFLOAT, kanzi::GraphicsFormatR16G16_UINT, kanzi::GraphicsFormatR16G16_SINT, kanzi::GraphicsFormatR16G16_SFLOAT,
  kanzi::GraphicsFormatR16G16B16_UINT, kanzi::GraphicsFormatR16G16B16_SINT, kanzi::GraphicsFormatR16G16B16_SFLOAT, kanzi::GraphicsFormatR16G16B16A16_UINT,
  kanzi::GraphicsFormatR16G16B16A16_SINT, kanzi::GraphicsFormatR16G16B16A16_SFLOAT, kanzi::GraphicsFormatR5G6B5_UNORM_PACK16, kanzi::GraphicsFormatETC1_R8G8B8_UNORM,
  kanzi::GraphicsFormatETC2_R8G8B8_UNORM, kanzi::GraphicsFormatETC2_R8G8B8A1_UNORM, kanzi::GraphicsFormatETC2_R8G8B8A8_UNORM, kanzi::GraphicsFormatBC2_UNORM,
  kanzi::GraphicsFormatBC3_UNORM, kanzi::GraphicsFormatPVRTC1_RGB_2BPP, kanzi::GraphicsFormatPVRTC1_RGB_4BPP, kanzi::GraphicsFormatPVRTC1_RGBA_2BPP,
  kanzi::GraphicsFormatPVRTC1_RGBA_4BPP, kanzi::GraphicsFormatPVRTC2_RGBA_2BPP, kanzi::GraphicsFormatPVRTC2_RGBA_4BPP, kanzi::GraphicsFormatATC_RGB,
  kanzi::GraphicsFormatATC_RGBA_EXPLICIT_ALPHA, kanzi::GraphicsFormatATC_RGBA_INTERPOLATED_ALPHA, kanzi::GraphicsFormatD16_UNORM, kanzi::GraphicsFormatD24_UNORM,
  kanzi::GraphicsFormatD32_SFLOAT, kanzi::GraphicsFormatD24_UNORM_S8_UINT, kanzi::GraphicsFormatS8_UINT, kanzi::GraphicsFormatCount,
  kanzi::GraphicsFormatRangeBegin, kanzi::GraphicsFormatRangeEnd
}
 GraphicsFormat specifies format of graphics data used for example in textures and vertex attributes. More...
 

Functions

KANZI_API unsigned int kanzi::getBytesPerBlock (GraphicsFormat format)
 Returns number of bytes per block of the specified format. More...
 
KANZI_API bool kanzi::isCompressed (GraphicsFormat format)
 Indicates whether format is compressed format or not. More...
 
KANZI_API GraphicsFormat kanzi::getFallback (GraphicsFormat format)
 Returns an alternative format which is potentially more widely supported. More...
 
KANZI_API GraphicsFormat kanzi::getCommon (GraphicsFormat format1, GraphicsFormat format2)
 Returns a common superset of two formats, or GraphicsFormatNone if formats cannot be combined. More...
 
KANZI_API GraphicsDataType kanzi::getDataType (GraphicsFormat format)
 Returns data type of the format. More...
 
KANZI_API unsigned int kanzi::getDataSizeBytes (int width, int height, GraphicsFormat format)
 Returns data size in bytes for image with specified dimensions and format. More...
 
KANZI_API bool kanzi::hasColor (GraphicsFormat format)
 Indicates whether given format has one more more color channels. More...
 
KANZI_API bool kanzi::hasAlpha (GraphicsFormat format)
 Indicates whether given format has alpha channel. More...
 
KANZI_API bool kanzi::hasDepth (GraphicsFormat format)
 Indicates whether given format has depth channel. More...
 
KANZI_API bool kanzi::hasStencil (GraphicsFormat format)
 Indicates whether given format has stencil channel. More...
 
KANZI_API unsigned int kanzi::getByteCount (GraphicsDataType dataType)
 Return number of bytes per one element of data type. More...
 
KANZI_API bool kanzi::isPacked (GraphicsDataType dataType)
 Indicates whether given data type is packed or not. More...
 
KANZI_API unsigned int kanzi::getByteCount (GraphicsDataType dataType, unsigned int dimension)
 Returns number of bytes for graphics data. More...
 
KANZI_API FixedString kanzi::toFixedString (GraphicsDataType dataType)
 Returns human readable string for GraphicsDataType. More...
 
KANZI_API FixedString kanzi::toFixedString (GraphicsFormat format)
 Returns human readable string for GraphicsFormat. More...