E:/Programming/MyProject/K_Game_hg/GameEngine/include/resource/PixelFormat.h

Go to the documentation of this file.

// Copyright 2006-2011 by Kat'Oun

#ifndef _PIXEL_FORMAT_H_
#define _PIXEL_FORMAT_H_

#include <EngineConfig.h>
#include <core/Types.h>

namespace render
{
class Color;
}

namespace resource
{

enum PixelFormat
{
        PF_UNKNOWN = 0,                         
        PF_L8 = 1,                                      
        PF_BYTE_L = PF_L8,
        PF_L16 = 2,                                     
        PF_SHORT_L = PF_L16,
        PF_A8 = 3,                                      
        PF_BYTE_A = PF_A8,
        PF_A4L4 = 4,                            
        PF_BYTE_LA = 5,                         
        PF_R5G6B5 = 6,                          
        PF_B5G6R5 = 7,                          
        PF_R3G3B2 = 31,                         
        PF_A4R4G4B4 = 8,                        
        PF_A1R5G5B5 = 9,                        
        PF_R8G8B8 = 10,                         
        PF_B8G8R8 = 11,                         
        PF_A8R8G8B8 = 12,                       
        PF_A8B8G8R8 = 13,                       
        PF_B8G8R8A8 = 14,                       
        PF_R8G8B8A8 = 28,                       
        PF_X8R8G8B8 = 26,                       
        PF_X8B8G8R8 = 27,                       
#if GAME_ARCHITECTURE_ENDIAN == ENDIAN_BIG
        PF_BYTE_RGB = PF_R8G8B8,        
        PF_BYTE_BGR = PF_B8G8R8,        
        PF_BYTE_BGRA = PF_B8G8R8A8,     
        PF_BYTE_RGBA = PF_R8G8B8A8,     
#else
        PF_BYTE_RGB = PF_B8G8R8,        
        PF_BYTE_BGR = PF_R8G8B8,        
        PF_BYTE_BGRA = PF_A8R8G8B8,     
        PF_BYTE_RGBA = PF_A8B8G8R8,     
#endif        
        PF_A2R10G10B10 = 15,            
        PF_A2B10G10R10 = 16,            
        PF_DXT1 = 17,                           
        PF_DXT2 = 18,                           
        PF_DXT3 = 19,                           
        PF_DXT4 = 20,                           
        PF_DXT5 = 21,                           
        PF_FLOAT16_R = 32,                      
        PF_FLOAT16_RGB = 22,            
        PF_FLOAT16_RGBA = 23,           
        PF_FLOAT32_R = 33,                      
        PF_FLOAT32_RGB = 24,            
        PF_FLOAT32_RGBA = 25,           
        PF_FLOAT16_GR = 35,                     
        PF_FLOAT32_GR = 36,                     
        PF_DEPTH = 29,                          
        PF_SHORT_RGBA = 30,                     
        PF_SHORT_GR = 34,                       
        PF_SHORT_RGB = 37,                      
        PF_PVRTC_RGB2 = 38,                     
        PF_PVRTC_RGBA2 = 39,            
        PF_PVRTC_RGB4 = 40,                     
        PF_PVRTC_RGBA4 = 41,            
        PF_COUNT = 42                           
};

enum PixelComponentType
{
        PCT_BYTE,               
        PCT_SHORT,              
        PCT_FLOAT16,    
        PCT_FLOAT32,    
        PCT_COUNT               
};

enum PixelFormatFlags
{       
        PFF_HASALPHA            = 0x00000001,   // This format has an alpha channel.    
        PFF_COMPRESSED          = 0x00000002,   // This format is compressed.   
        PFF_FLOAT                       = 0x00000004,   // This is a floating point format.     
        PFF_DEPTH                       = 0x00000008,   // This is a depth format (for depth textures). 
        PFF_NATIVEENDIAN        = 0x00000010,   // Format is in native endian.  
        PFF_LUMINANCE           = 0x00000020    
};

struct PixelFormatDescription
{
        c8 *name;                                                       
        u8 elemBytes;                                           
        u32 flags;                                                      
        PixelComponentType componentType;       
        u8 componentCount;                                      
        u8 rbits,gbits,bbits,abits;                     
        u32 rmask, gmask, bmask, amask;         
        u8 rshift, gshift, bshift, ashift;      
};

class ENGINE_PUBLIC_EXPORT PixelUtil
{
public:

        static const PixelFormatDescription& getDescriptionFor(const PixelFormat format);
        static u32 getNumElemBytes(PixelFormat format);

        static u32 getNumElemBits(PixelFormat format);

        static void getBitDepths(PixelFormat format, s32 rgba[4]);

        static void getBitMasks(PixelFormat format, u32 rgba[4]);

        static u32 getFlags(PixelFormat format);
        static bool hasAlpha(PixelFormat format);
        static bool isFloatingPoint(PixelFormat format);
        static bool isCompressed(PixelFormat format);
        static bool isDepth(PixelFormat format);
        static bool isNativeEndian(PixelFormat format);
        static bool isLuminance(PixelFormat format);

        static void unpackColor(f32 *r, f32 *g, f32 *b, f32 *a, PixelFormat pf,  const void* src);
        static void packColor(const f32 r, const f32 g, const f32 b, const f32 a, const PixelFormat pf,  void* dest);

        static u32 getMemorySize(u32 width, u32 height, u32 depth, PixelFormat format);

        // Calculate size in bytes from the number of mipmaps, faces and the dimensions
        static u32 calculateSize(u32 mipmaps, u32 faces, u32 width, u32 height, u32 depth, PixelFormat format);

private:

        static PixelFormatDescription pixelFormats[PF_COUNT];
};

}// end namespace resource

#endif// _PIXELFORMAT_H_