GxColor.h

Go to the documentation of this file.

//===========================================================================
//===========================================================================
#pragma once
 
GX_CORE_NAMESPACE_BEGIN()
 
struct GxColorHDR;
 
//===========================================================================
//===========================================================================
struct GxColor : public GxStructBase
{
    //-------------------------------------------------------------
    //-------------------------------------------------------------
public:
    GX_RTTI_STRUCT(GxColor)
 
    static const GxColor BLACK;         
    static const GxColor RED;           
    static const GxColor BLUE;          
    static const GxColor MAGENTA;       
    static const GxColor GREEN;         
    static const GxColor YELLOW;        
    static const GxColor CYAN;          
    static const GxColor ORANGE;        
    static const GxColor WHITE;         
 
    static const GxColor DARK_RED;      
    static const GxColor DARK_BLUE;     
    static const GxColor DARK_MAGENTA;  
    static const GxColor DARK_GREEN;    
    static const GxColor DARK_YELLOW;   
    static const GxColor DARK_CYAN;     
    static const GxColor DARK_GRAY;     
 
    static const GxColor LIGHT_RED;     
    static const GxColor LIGHT_BLUE;    
    static const GxColor LIGHT_MAGENTA; 
    static const GxColor LIGHT_GREEN;   
    static const GxColor LIGHT_YELLOW;  
    static const GxColor LIGHT_CYAN;    
    static const GxColor LIGHT_GRAY;    
 
    static const GxColor SYSTEM_AXIS_X; 
    static const GxColor SYSTEM_AXIS_Y; 
    static const GxColor SYSTEM_AXIS_Z; 
 
#if GX_COLOR_RGB_SWAP
    static constexpr u32 MASK_RED   = 0x00FF0000;
    static constexpr u32 MASK_BLUE  = 0x000000FF;
#else //GX_COLOR_RGB_SWAP
    static constexpr u32 MASK_RED   = 0x000000FF;
    static constexpr u32 MASK_BLUE  = 0x00FF0000;
#endif // !GX_COLOR_RGB_SWAP
    static constexpr u32 MASK_GREEN = 0x0000FF00;
    static constexpr u32 MASK_ALPHA = 0xFF000000;
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    GxColor(void) {}
    GX_FORCE_INLINE GxColor(u32 red, u32 green, u32 blue, u32 alpha = 255);
    GX_FORCE_INLINE GxColor(const GxColor color, u32 alpha);
    GX_FORCE_INLINE GxColor(const GxColorHDR& color);
 
    GX_FORCE_INLINE GxColor(const GxColor& color);
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    GX_FORCE_INLINE GxColor& operator = (const GxColor color);
    GX_FORCE_INLINE GxColor& operator += (u32 scalar);
    GX_FORCE_INLINE GxColor& operator -= (u32 scalar);
    GX_FORCE_INLINE GxColor& operator *= (f32 scalar);
    GX_FORCE_INLINE GxColor& operator /= (f32 scalar);
    GX_FORCE_INLINE GxColor& operator += (const GxColor color);
    GX_FORCE_INLINE GxColor& operator -= (const GxColor color);
    GX_FORCE_INLINE GxColor& operator *= (const GxColor color);
    friend GX_FORCE_INLINE const GxColor operator + (const GxColor color, u32 scalar);
    friend GX_FORCE_INLINE const GxColor operator - (const GxColor color, u32 scalar);
    friend GX_FORCE_INLINE const GxColor operator * (const GxColor color, f32 scalar);
    friend GX_FORCE_INLINE const GxColor operator * (f32 scalar, const GxColor color);
    friend GX_FORCE_INLINE const GxColor operator / (const GxColor color, f32 scalar);
    friend GX_FORCE_INLINE const GxColor operator + (const GxColor color0, const GxColor color1);
    friend GX_FORCE_INLINE const GxColor operator - (const GxColor color0, const GxColor color1);
    friend GX_FORCE_INLINE const GxColor operator * (const GxColor color0, const GxColor color1);
    friend GX_FORCE_INLINE b32 operator == (const GxColor color0, const GxColor color1);
    friend GX_FORCE_INLINE b32 operator != (const GxColor color0, const GxColor color1);
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    constexpr void getPropertyRed(void* const pValue) const { *static_cast<u8*>(pValue) = _red; }
    constexpr void setPropertyRed(const void* const pValue) { _red = *static_cast<u8*>(const_cast<void*>(pValue)); }
    constexpr void getPropertyGreen(void* const pValue) const { *static_cast<u8*>(pValue) = _green; }
    constexpr void setPropertyGreen(const void* const pValue) { _green = *static_cast<u8*>(const_cast<void*>(pValue)); }
    constexpr void getPropertyBlue(void* const pValue) const { *static_cast<u8*>(pValue) = _blue; }
    constexpr void setPropertyBlue(const void* const pValue) { _blue = *static_cast<u8*>(const_cast<void*>(pValue)); }
    constexpr void getPropertyAlpha(void* const pValue) const { *static_cast<u8*>(pValue) = _alpha; }
    constexpr void setPropertyAlpha(const void* const pValue) { _alpha = *static_cast<u8*>(const_cast<void*>(pValue)); }
 
    GX_FORCE_INLINE GxColor getInvert(void) const { GxColor color; color._color = _color ^ (MASK_RED | MASK_GREEN | MASK_BLUE); return color; }
    constexpr f32 getLuminance(void) const { return 0.29891f * static_cast<f32>(_red) + 0.58661f * static_cast<f32>(_green) + 0.11448f * static_cast<f32>(_blue); }
 
    static GX_FORCE_INLINE const GxColor&       getAddScalar(GxColor& dst, const GxColor color, u32 scalar);
    static GX_FORCE_INLINE const GxColor&       getSubScalar(GxColor& dst, const GxColor color, u32 scalar);
    static GX_FORCE_INLINE const GxColor&       getMulScalar(GxColor& dst, const GxColor color, f32 scalar);
    static GX_FORCE_INLINE const GxColor&       getDivScalar(GxColor& dst, const GxColor color, f32 scalar);
    static GX_FORCE_INLINE const GxColor&       getAddColor(GxColor& dst, const GxColor color0, const GxColor color1);
    static GX_FORCE_INLINE const GxColor&       getSubColor(GxColor& dst, const GxColor color0, const GxColor color1);
    static GX_FORCE_INLINE const GxColor&       getMulColor(GxColor& dst, const GxColor color0, const GxColor color1);
    static GX_FORCE_INLINE GxColor              getLerp(const GxColor color0, const GxColor color1, f32 t);
    static GX_FORCE_INLINE const GxColor&       getLerp(GxColor& dst, const GxColor color0, const GxColor color1, f32 t);
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
 
    GX_FORCE_INLINE const GxColor&          addScalar(u32 scalar);
    GX_FORCE_INLINE const GxColor&          subScalar(u32 scalar);
    GX_FORCE_INLINE const GxColor&          mulScalar(f32 scalar);
    GX_FORCE_INLINE const GxColor&          divScalar(f32 scalar);
    GX_FORCE_INLINE const GxColor&          addColor(const GxColor color);
    GX_FORCE_INLINE const GxColor&          subColor(const GxColor color);
    GX_FORCE_INLINE const GxColor&          mulColor(const GxColor color);
 
    static GxColor              createColor(GX_CSTR string);
    static GxColor              createColor(u32 value);
 
    static GX_FORCE_INLINE GxColor          convertPs3ToWindows(const GxColor ps3Color);
 
    static GX_FORCE_INLINE GxColor          convertWindowsToPs3(const GxColor windowsColor);
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    union
    {
        struct
        {
#if GX_COLOR_RGB_SWAP
            u32 _blue : 8;      
            u32 _green : 8;     
            u32 _red : 8;       
            u32 _alpha : 8;     
#else //GX_COLOR_RGB_SWAP
            u32 _red : 8;       
            u32 _green : 8;     
            u32 _blue : 8;      
            u32 _alpha : 8;     
#endif // !GX_COLOR_RGB_SWAP
        };
        u32 _color;
    };
 
};
 
//===========================================================================
//===========================================================================
struct GxColorHDR : public GxStructBase
{
    //-------------------------------------------------------------
    //-------------------------------------------------------------
public:
    GX_RTTI_STRUCT(GxColorHDR)
 
    
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    GxColorHDR(void) : _red(0.f), _green(0.f), _blue(0.f), _alpha(0.f){}
    GX_FORCE_INLINE GxColorHDR(f32 red, f32 green, f32 blue, f32 alpha = 1.0f);
    GX_FORCE_INLINE GxColorHDR(const GxColor color);
 
    GX_FORCE_INLINE GxColorHDR(const GxColorHDR& color);
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    GX_FORCE_INLINE GxColorHDR& operator = (const GxColorHDR& color);
    GX_FORCE_INLINE GxColorHDR& operator += (f32 scalar);
    GX_FORCE_INLINE GxColorHDR& operator -= (f32 scalar);
    GX_FORCE_INLINE GxColorHDR& operator *= (f32 scalar);
    GX_FORCE_INLINE GxColorHDR& operator /= (f32 scalar);
    GX_FORCE_INLINE GxColorHDR& operator += (const GxColorHDR& color);
    GX_FORCE_INLINE GxColorHDR& operator -= (const GxColorHDR& color);
    GX_FORCE_INLINE GxColorHDR& operator *= (const GxColorHDR& color);
    friend GX_FORCE_INLINE const GxColorHDR operator + (const GxColorHDR& color, f32 scalar);
    friend GX_FORCE_INLINE const GxColorHDR operator - (const GxColorHDR& color, f32 scalar);
    friend GX_FORCE_INLINE const GxColorHDR operator * (const GxColorHDR& color, f32 scalar);
    friend GX_FORCE_INLINE const GxColorHDR operator * (f32 scalar, const GxColorHDR& color);
    friend GX_FORCE_INLINE const GxColorHDR operator / (const GxColorHDR& color, f32 scalar);
    friend GX_FORCE_INLINE const GxColorHDR operator + (const GxColorHDR& color0, const GxColorHDR& color1);
    friend GX_FORCE_INLINE const GxColorHDR operator - (const GxColorHDR& color0, const GxColorHDR& color1);
    friend GX_FORCE_INLINE const GxColorHDR operator * (const GxColorHDR& color0, const GxColorHDR& color1);
    friend GX_FORCE_INLINE b32 operator == (const GxColorHDR& color0, const GxColorHDR& color1);
    friend GX_FORCE_INLINE b32 operator != (const GxColorHDR& color0, const GxColorHDR& color1);
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    constexpr f32 getLuminance(void) const { return 0.29891f * _red + 0.58661f * _green + 0.11448f * _blue; }
 
    static GX_FORCE_INLINE const GxColorHDR&        getAddScalar(GxColorHDR& dst, const GxColorHDR& color, f32 scalar);
    static GX_FORCE_INLINE const GxColorHDR&        getSubScalar(GxColorHDR& dst, const GxColorHDR& color, f32 scalar);
    static GX_FORCE_INLINE const GxColorHDR&        getMulScalar(GxColorHDR& dst, const GxColorHDR& color, f32 scalar);
    static GX_FORCE_INLINE const GxColorHDR&        getDivScalar(GxColorHDR& dst, const GxColorHDR& color, f32 scalar);
    static GX_FORCE_INLINE const GxColorHDR&        getAddColor(GxColorHDR& dst, const GxColorHDR& color0, const GxColorHDR& color1);
    static GX_FORCE_INLINE const GxColorHDR&        getSubColor(GxColorHDR& dst, const GxColorHDR& color0, const GxColorHDR& color1);
    static GX_FORCE_INLINE const GxColorHDR&        getMulColor(GxColorHDR& dst, const GxColorHDR& color0, const GxColorHDR& color1);
    static GX_FORCE_INLINE const GxColorHDR&        getLerp(GxColorHDR& dst, const GxColorHDR& color0, const GxColorHDR& color1, f32 t);
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
 
    GX_FORCE_INLINE const GxColorHDR&           addScalar(f32 scalar);
    GX_FORCE_INLINE const GxColorHDR&           subScalar(f32 scalar);
    GX_FORCE_INLINE const GxColorHDR&           mulScalar(f32 scalar);
    GX_FORCE_INLINE const GxColorHDR&           divScalar(f32 scalar);
    GX_FORCE_INLINE const GxColorHDR&           addColor(const GxColorHDR& color);
    GX_FORCE_INLINE const GxColorHDR&           subColor(const GxColorHDR& color);
    GX_FORCE_INLINE const GxColorHDR&           mulColor(const GxColorHDR& color);
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
public:
    f32 _red;           
    f32 _green;         
    f32 _blue;          
    f32 _alpha;         
 
};
 
//===========================================================================
//===========================================================================
struct GxColorHSV : public GxStructBase
{
    //-------------------------------------------------------------
    //-------------------------------------------------------------
public:
    GX_RTTI_STRUCT(GxColorHSV)
 
    
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    GxColorHSV(void) : _hue(0.f), _saturation(0.f), _value(0.f), _alpha(0.f){}
    GX_FORCE_INLINE GxColorHSV(f32 hue, f32 saturation, f32 value, f32 alpha = 1.0f);
    GX_FORCE_INLINE GxColorHSV(const GxColorHDR& colorHDR);
 
    GX_FORCE_INLINE GxColorHSV(const GxColorHSV& color);
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    GX_FORCE_INLINE GxColorHSV& operator = (const GxColorHSV& color);
    friend GX_FORCE_INLINE b32 operator == (const GxColorHSV& color0, const GxColorHSV& color1);
    friend GX_FORCE_INLINE b32 operator != (const GxColorHSV& color0, const GxColorHSV& color1);
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
 
    GX_FORCE_INLINE void                        setRgb(const GxColorHDR& color);
    GX_FORCE_INLINE GxColorHDR                  getRgb(void) const;
 
    static GX_FORCE_INLINE const GxColorHSV&    getInvertHue(GxColorHSV& dst, const GxColorHSV& color);
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
 
    static void                 hsv2rgb(const GxColorHSV& hsv, GxColorHDR& rgb);
    static void                 rgb2hsv(const GxColorHDR& rgb, GxColorHSV& hsv);
 
    //-------------------------------------------------------------
    //-------------------------------------------------------------
public:
    f32 _hue;           
    f32 _saturation;    
    f32 _value;         
    f32 _alpha;         
 
};
 
GX_CORE_NAMESPACE_END()