CascadeColor.h

Go to the documentation of this file.

//
// CascadeColor.h - header file for class CascadeColor
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADECOLOR_H
#define _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADECOLOR_H

#include <cascade/CascadeObject.h>

class CascadeColor : public CascadeObject
{
public:
        CascadeColor()                                      { SetRGBA(0, 0, 0, 0xFF); }
        CascadeColor(u8 red, u8 green, u8 blue)             { SetRGBA(red, green, blue, 0xFF); }
        CascadeColor(u8 red, u8 green, u8 blue, u8 alpha)   { SetRGBA(red, green, blue, alpha); }
    CascadeColor(const CascadeColor & color)            { m_nColor = color.m_nColor; }
    
public:
    inline void SetRed(u8 red);
    inline void SetGreen(u8 green);
    inline void SetBlue(u8 blue);
    inline void SetAlpha(u8 alpha);
    inline void SetRGB(u8 red, u8 green, u8 blue);
    inline void SetRGBA(u8 red, u8 green, u8 blue, u8 alpha);
    inline u8   GetRed();
    inline u8   GetGreen();
    inline u8   GetBlue();
    inline u8   GetAlpha();
    inline void GetRGB(u8 & redToSet, u8 & greenToSet, u8 & blueToSet);   
    inline void GetRGBA(u8 & redToSet, u8 & greenToSet, u8 & blueToSet, u8 & alphaToSet);
    inline bool operator == (const CascadeColor & colorThat) const
    {
        return (m_nColor == colorThat.m_nColor);
    }
public:
    u32 m_nColor;
};

// class CascadeColor inline methods
inline void
CascadeColor::SetRed(u8 red)
{
    m_nColor &= 0x00FFFFFF;
    m_nColor |= ((u32)red) << 24;
}

inline void
CascadeColor::SetGreen(u8 green)
{

    m_nColor &= 0xFF00FFFF;
    m_nColor |= ((u32)green) << 16;
}

inline void
CascadeColor::SetBlue(u8 blue)
{
    m_nColor &= 0xFFFF00FF;
    m_nColor |= ((u32)blue) << 8;
}

inline void
CascadeColor::SetAlpha(u8 alpha)
{
    m_nColor &= 0xFFFFFF00;
    m_nColor |= ((u32)alpha);
}

inline void
CascadeColor::SetRGB(u8 red, u8 green, u8 blue)
{
    m_nColor = (((u32)red) << 24) | (((u32)green) << 16) | (((u32)blue) << 8) | (m_nColor & 0x000000FF);
}

inline void
CascadeColor::SetRGBA(u8 red, u8 green, u8 blue, u8 alpha)
{
    m_nColor = (((u32)red) << 24) | (((u32)green) << 16) | (((u32)blue) << 8) | ((u32)alpha);
}

inline u8
CascadeColor::GetRed()
{
    return (u8)(m_nColor >> 24);
}

inline u8
CascadeColor::GetGreen()
{
    return (u8)(m_nColor >> 16);
}

inline u8
CascadeColor::GetBlue()
{
    return (u8)(m_nColor >> 8);
}

inline u8
CascadeColor::GetAlpha()
{
    return (u8)m_nColor;
}

inline void
CascadeColor::GetRGB(u8 & redToSet, u8 & greenToSet, u8 & blueToSet)
{
    redToSet =   (u8)(m_nColor >> 24);
    greenToSet = (u8)(m_nColor >> 16);
    blueToSet =  (u8)(m_nColor >> 8);
}

inline void
CascadeColor::GetRGBA(u8 & redToSet, u8 & greenToSet, u8 & blueToSet, u8 & alphaToSet)
{
    redToSet =   (u8)(m_nColor >> 24);
    greenToSet = (u8)(m_nColor >> 16);
    blueToSet =  (u8)(m_nColor >> 8);
    alphaToSet = (u8)m_nColor;
}

#endif // #ifndef _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADECOLOR_H

//  LOG
//  20-Jan-03   dwoodward       created
//  20-Jan-03   dwoodward       1.0 STATUS: 100% complete
//  26-Jan-03   dwoodward       reworked to not be opaque and driver dependent
//  05-May-03   dwoodward   doxygenated
//  08-Jul-03   dwoodward   fixed alpha treatment
//  16-Sep-03   dwoodward   added operator ==

---