ImageFormat.h

Go to the documentation of this file.

#ifndef GLG3D_ImageFormat_h
#define GLG3D_ImageFormat_h

#include "G3D/platform.h"
#include "G3D/Table.h"
#include "G3D/enumclass.h"
#include "G3D/Any.h"

namespace G3D {

class ImageFormat {
public:

 // Must update ImageFormat::name() when this enum changes.
 enum Code {
 CODE_AUTO = -2,
 CODE_NONE = -1,
 CODE_L8,
 CODE_L16,
 CODE_L16F,
 CODE_L32F,

 CODE_A8,
 CODE_A16,
 CODE_A16F,
 CODE_A32F,

 CODE_LA4,
 CODE_LA8,
 CODE_LA16,
 CODE_LA16F,
 CODE_LA32F,

 CODE_RGB5,
 CODE_RGB5A1,
 CODE_RGB8,
 CODE_RGB10,
 CODE_RGB10A2,
 CODE_RGB16,
 CODE_RGB16F,
 CODE_RGB32F,
 CODE_R11G11B10F,
 CODE_RGB9E5F,

 CODE_RGB8I,
 CODE_RGB8UI,

 CODE_RGBA8I,
 CODE_RGBA8UI,

 CODE_RGB8_SNORM,
 CODE_RGBA8_SNORM,
 CODE_RGB16_SNORM,
 CODE_RGBA16_SNORM,

 CODE_ARGB8,
 CODE_BGR8,
 CODE_BGRA8,

 CODE_R8,
 CODE_R8I,
 CODE_R8UI,

 CODE_R16,
 CODE_R16I,
 CODE_R16UI,

 CODE_R32I,
 CODE_R32UI,

 CODE_RG8,
 CODE_RG8I,
 CODE_RG8UI,

 CODE_RG16,
 CODE_RG16I,
 CODE_RG16UI,

 CODE_R16F,
 CODE_RG16F,

 CODE_RG32I,
 CODE_RG32UI,

 CODE_R32F,
 CODE_RG32F,

 CODE_RGBA8,
 CODE_RGBA16,
 CODE_RGBA16F,
 CODE_RGBA32F,

 CODE_RGBA16I,
 CODE_RGBA16UI,

 CODE_RGB32I,
 CODE_RGB32UI,
 CODE_RGBA32I,
 CODE_RGBA32UI,

 CODE_BAYER_RGGB8,
 CODE_BAYER_GRBG8,
 CODE_BAYER_GBRG8,
 CODE_BAYER_BGGR8,
 CODE_BAYER_RGGB32F,
 CODE_BAYER_GRBG32F,
 CODE_BAYER_GBRG32F,
 CODE_BAYER_BGGR32F,

 CODE_HSV8,
 CODE_HSV32F,

 CODE_YUV420_PLANAR,
 CODE_YUV422,
 CODE_YUV444,

 CODE_RGB_DXT1,
 CODE_RGBA_DXT1,
 CODE_RGBA_DXT3,
 CODE_RGBA_DXT5,

 CODE_SRGB8,
 CODE_SRGBA8,

 CODE_SL8,
 CODE_SLA8,

 CODE_SRGB_DXT1,
 CODE_SRGBA_DXT1,
 CODE_SRGBA_DXT3,
 CODE_SRGBA_DXT5,

 CODE_DEPTH16,
 CODE_DEPTH24,
 CODE_DEPTH32,
 CODE_DEPTH32F,
 
 CODE_STENCIL1,
 CODE_STENCIL4,
 CODE_STENCIL8,
 CODE_STENCIL16,

 CODE_DEPTH24_STENCIL8,

 CODE_NUM
 };

 enum ColorSpace {
 COLOR_SPACE_NONE,
 COLOR_SPACE_RGB,
 COLOR_SPACE_HSV,
 COLOR_SPACE_YUV,
 COLOR_SPACE_SRGB
 };

 enum BayerPattern {
 BAYER_PATTERN_NONE,
 BAYER_PATTERN_RGGB,
 BAYER_PATTERN_GRBG,
 BAYER_PATTERN_GBRG,
 BAYER_PATTERN_BGGR
 };


 enum NumberFormat { 
 FLOATING_POINT_FORMAT,
 INTEGER_FORMAT,
 NORMALIZED_FIXED_POINT_FORMAT,
 OTHER // e.g. DXT
 };

 int numComponents;
 bool compressed;

 Code code;

 ColorSpace colorSpace;

 BayerPattern bayerPattern;

 int openGLFormat;

 int openGLBaseFormat;

 int luminanceBits;

 int alphaBits;
 
 int redBits;

 int greenBits;
 
 int blueBits;

 int stencilBits;

 int depthBits;

 int cpuBitsPerPixel;

 int openGLBitsPerPixel;

 int openGLDataFormat;

 bool opaque;

 
 bool floatingPoint;

 NumberFormat numberFormat;

 const std::string& name() const;

 bool canInterpretAs(const ImageFormat* otherFormat) const;

 static const ImageFormat* getFormatWithAlpha(const ImageFormat* otherFormat);

 static const ImageFormat* getSRGBFormat(const ImageFormat* otherFormat);

 static const ImageFormat* fromString(const std::string& s);


private:

 ImageFormat
 (int numComponents,
 bool compressed,
 int glFormat,
 int glBaseFormat,
 int luminanceBits,
 int alphaBits,
 int redBits,
 int greenBits,
 int blueBits,
 int depthBits,
 int stencilBits,
 int openGLBitsPerPixel,
 int cpuBitsPerPixel,
 int glDataFormat,
 bool opaque,
 NumberFormat numberFormat,
 Code code,
 ColorSpace colorSpace,
 BayerPattern bayerPattern = BAYER_PATTERN_NONE);

public:

 static const ImageFormat* L8();

 static const ImageFormat* L16();

 static const ImageFormat* L16F();
 
 static const ImageFormat* L32F();

 static const ImageFormat* A8();

 static const ImageFormat* A16();

 static const ImageFormat* A16F();
 
 static const ImageFormat* A32F();

 static const ImageFormat* LA4();

 static const ImageFormat* LA8();

 static const ImageFormat* LA16();

 static const ImageFormat* LA16F();
 
 static const ImageFormat* LA32F();

 static const ImageFormat* BGR8();

 static const ImageFormat* BGRA8();

 static const ImageFormat* R8();
 static const ImageFormat* R8I();
 static const ImageFormat* R8UI();

 static const ImageFormat* R16();
 static const ImageFormat* R16I();
 static const ImageFormat* R16UI();

 static const ImageFormat* R32I();
 static const ImageFormat* R32UI();

 static const ImageFormat* RG8();
 static const ImageFormat* RG8I();
 static const ImageFormat* RG8UI();

 static const ImageFormat* RG16();
 static const ImageFormat* RG16I();
 static const ImageFormat* RG16UI();

 static const ImageFormat* R16F();
 static const ImageFormat* RG16F();

 static const ImageFormat* RG32I();
 static const ImageFormat* RG32UI();

 static const ImageFormat* R32F();
 static const ImageFormat* RG32F();

 static const ImageFormat* RGB5();

 static const ImageFormat* RGB5A1();

 static const ImageFormat* RGB8();

 static const ImageFormat* RGB10();

 static const ImageFormat* RGB10A2();

 static const ImageFormat* RGB16();

 static const ImageFormat* RGB16F();

 static const ImageFormat* RGB32F();

 static const ImageFormat* RGBA8();

 static const ImageFormat* RGBA16();

 static const ImageFormat* RGBA16F();
 
 static const ImageFormat* RGBA32F();

 static const ImageFormat* RGBA16I();
 static const ImageFormat* RGBA16UI();

 static const ImageFormat* RGB32UI();
 static const ImageFormat* RGB32I();
 static const ImageFormat* RGBA32I();
 static const ImageFormat* RGBA32UI();

 static const ImageFormat* R11G11B10F();

 static const ImageFormat* RGB9E5F(); 

 static const ImageFormat* RGB8I(); 

 static const ImageFormat* RGB8UI(); 

 static const ImageFormat* RGBA8I(); 

 static const ImageFormat* RGBA8UI(); 

 static const ImageFormat* RGB8_SNORM(); 
 static const ImageFormat* RGBA8_SNORM(); 
 static const ImageFormat* RGB16_SNORM(); 
 static const ImageFormat* RGBA16_SNORM(); 

 static const ImageFormat* RGB_DXT1();

 static const ImageFormat* RGBA_DXT1();

 static const ImageFormat* RGBA_DXT3();

 static const ImageFormat* RGBA_DXT5();

 static const ImageFormat* SRGB8();

 static const ImageFormat* SRGBA8();

 static const ImageFormat* SL8();

 static const ImageFormat* SLA8();

 static const ImageFormat* SRGB_DXT1();

 static const ImageFormat* SRGBA_DXT1();

 static const ImageFormat* SRGBA_DXT3();

 static const ImageFormat* SRGBA_DXT5();

 static const ImageFormat* DEPTH16();

 static const ImageFormat* DEPTH24();

 static const ImageFormat* DEPTH32();

 static const ImageFormat* DEPTH32F();

 static const ImageFormat* STENCIL1();

 static const ImageFormat* STENCIL4();

 static const ImageFormat* STENCIL8();

 static const ImageFormat* STENCIL16();

 static const ImageFormat* DEPTH24_STENCIL8();

 static const ImageFormat* YUV420_PLANAR();

 static const ImageFormat* YUV422();

 static const ImageFormat* YUV444();

 static const ImageFormat* AUTO() { return NULL; }

 static const ImageFormat* depth(int depthBits = 24);

 static const ImageFormat* stencil(int bits = 8);

 static const ImageFormat* fromCode(ImageFormat::Code code);


 class BayerAlgorithm {
 public:
 enum Value { 
 NEAREST,
 BILINEAR,
 MHC,
 BEST = MHC
 };
 private:
 static const char* toString(int i, Value& v) {
 static const char* str[] = {"NEAREST", "BILINEAR", "MHC", "BEST", NULL}; 
 static const Value val[] = {NEAREST, BILINEAR, MHC, BEST};
 const char* s = str[i];
 if (s) {
 v = val[i];
 }
 return s;
 }

 Value value;

 public:

 G3D_DECLARE_ENUM_CLASS_METHODS(BayerAlgorithm);
 };

 static bool convert(const Array<const void*>& srcBytes, int srcWidth, int srcHeight, const ImageFormat* srcFormat, int srcRowPadBits,
 const Array<void*>& dstBytes, const ImageFormat* dstFormat, int dstRowPadBits,
 bool invertY = false, BayerAlgorithm bayerAlg = BayerAlgorithm::MHC);

 static bool conversionAvailable(const ImageFormat* srcFormat, int srcRowPadBits, const ImageFormat* dstFormat, int dstRowPadBits, bool invertY = false);

 bool representableAsColor1unorm8() const;

 bool representableAsColor2unorm8() const;

 bool representableAsColor3unorm8() const;

 bool representableAsColor4unorm8() const;

 Color4 channelMask() const;

 bool isIntegerFormat() const{
 return (numberFormat == INTEGER_FORMAT);
 }

 bool sameComponents(const ImageFormat* other) const;

};

typedef ImageFormat TextureFormat;

}

template <>
struct HashTrait<const G3D::ImageFormat*> {
 static size_t hashCode(const G3D::ImageFormat* key) { return reinterpret_cast<size_t>(key); }
};



#endif