ImageFormat.h

Go to the documentation of this file.

#ifndef GLIMG_IMAGE_FORMAT_H
#define GLIMG_IMAGE_FORMAT_H

#include <string>
#include <exception>


namespace glimg
{

    enum PixelDataType
    {
        DT_NORM_UNSIGNED_INTEGER,           
        DT_NORM_SIGNED_INTEGER,             
        DT_UNSIGNED_INTEGRAL,               
        DT_SIGNED_INTEGRAL,                 
        DT_FLOAT,                           
        DT_SHARED_EXP_FLOAT,                
        DT_NUM_UNCOMPRESSED_TYPES,

        DT_COMPRESSED_BC1 = DT_NUM_UNCOMPRESSED_TYPES,  
        DT_COMPRESSED_BC2,                  
        DT_COMPRESSED_BC3,                  
        DT_COMPRESSED_UNSIGNED_BC4,         
        DT_COMPRESSED_SIGNED_BC4,           
        DT_COMPRESSED_UNSIGNED_BC5,         
        DT_COMPRESSED_SIGNED_BC5,           
        DT_COMPRESSED_UNSIGNED_BC6H,        
        DT_COMPRESSED_SIGNED_BC6H,          
        DT_COMPRESSED_BC7,                  

        DT_NUM_TYPES,
    };

    enum PixelComponents
    {
        FMT_COLOR_RED,                  
        FMT_COLOR_RG,                   
        FMT_COLOR_RGB,                  
        FMT_COLOR_RGBX,                 
        FMT_COLOR_RGBA,                 
        FMT_COLOR_RGB_sRGB,             
        FMT_COLOR_RGBX_sRGB,            
        FMT_COLOR_RGBA_sRGB,            

        FMT_DEPTH,                      
        FMT_DEPTH_X,                    

        FMT_NUM_FORMATS,
    };

    enum ComponentOrder
    {
        ORDER_RGBA,             
        ORDER_BGRA,             
        ORDER_RGBE,             

        ORDER_DEPTH_STENCIL,    

        ORDER_COMPRESSED,       

        ORDER_NUM_ORDERS,
    };

    enum Bitdepth
    {
        BD_COMPRESSED,                  

        BD_PER_COMP_8,                  
        BD_PER_COMP_16,                 
        BD_PER_COMP_32,                 
        BD_NUM_PER_COMPONENT,           

        BD_PACKED_16_BIT_565 = BD_NUM_PER_COMPONENT,
        BD_PACKED_16_BIT_5551,          
        BD_PACKED_16_BIT_4444,          

        BD_PACKED_32_BIT_8888,          
        BD_PACKED_32_BIT_1010102,       
        BD_PACKED_32_BIT_248,           

        BD_PACKED_16_BIT_565_REV,       
        BD_PACKED_16_BIT_1555_REV,      
        BD_PACKED_16_BIT_4444_REV,      

        BD_PACKED_32_BIT_8888_REV,      
        BD_PACKED_32_BIT_2101010_REV,   
        BD_PACKED_32_BIT_101111_REV,    
        BD_PACKED_32_BIT_5999_REV,      

        BD_NUM_BITDEPTH,
    };

    struct UncheckedImageFormat
    {
        PixelDataType eType;        
        PixelComponents eFormat;    
        ComponentOrder eOrder;      
        Bitdepth eBitdepth;         

        int lineAlignment;          

        std::string ValidateFormatText() const;

        bool ValidateFormat() const;
    };

    class InvalidFormatException : public std::exception
    {
    public:
        InvalidFormatException()
            : message("Invalid Image Format")
        {}

        InvalidFormatException(const std::string &msg)
            : message("Invalid Image Format:\n")
        {
            message += msg;
        }

        virtual ~InvalidFormatException() throw() {}

        virtual const char *what() const throw() {return message.c_str();}

    protected:
        std::string message;
    };

    class ImageFormat
    {
    public:
        ImageFormat(PixelDataType _eType,
                    PixelComponents _eFormat,
                    ComponentOrder _eOrder,
                    Bitdepth _eBitdepth,
                    int _lineAlignment);

        ImageFormat(UncheckedImageFormat _fmt);

        UncheckedImageFormat GetUncheckedFormat() const {return fmt;}

        PixelDataType       Type() const        {return fmt.eType;}
        PixelComponents     Components() const  {return fmt.eFormat;}
        ComponentOrder      Order() const       {return fmt.eOrder;}
        Bitdepth            Depth() const       {return fmt.eBitdepth;}
        int                 LineAlign() const   {return fmt.lineAlignment;}

        size_t AlignByteCount(size_t byteCount) const;

    private:
        UncheckedImageFormat fmt;
    };



}


#endif //GLIMG_IMAGE_FORMAT_H