UTColor.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_COLOR_H_
#define _UT_COLOR_H_



//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTgfx.h"


EXTERN_C_BEGIN


//==================================================================================================
struct UTGFX_EXPORT Color_t
//==================================================================================================
{
    uint8                   red;

    uint8                   green;

    uint8                   blue;

    uint8                   alpha;

    #if __cplusplus

    inline                  Color_t();

    inline                  Color_t( uint8 red, uint8 green, uint8 blue, uint8 alpha = 255 );

    inline const Color_t&   operator =(const Color_t& copy);

    inline bool             operator ==(const Color_t& other) const;

    inline bool             operator !=(const Color_t& other) const;

    #endif // __cplusplus
};


EXTERN_C_END
#if __cplusplus


//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline
Color_t::Color_t()
{
    red = 0;    // Irrelevant
    green = 0;  // Irrelevant
    blue = 0;   // Irrelevant
    alpha = 0;  // Transparent
}


inline
Color_t::Color_t( uint8 a_red, uint8 a_green, uint8 a_blue, uint8 a_alpha )
{
    red = a_red;
    green = a_green;
    blue = a_blue;
    alpha = a_alpha;
}


inline const Color_t&
Color_t::operator =(const Color_t& copy)
{
    red = copy.red;
    green = copy.green;
    blue = copy.blue;
    alpha = copy.alpha;

    return *this;
}


inline bool
Color_t::operator ==(const Color_t& other) const
{
    return (    red == other.red
            &&  green == other.green
            &&  blue == other.blue
            &&  alpha == other.alpha );
}


inline bool
Color_t::operator !=(const Color_t& other) const
{
    return (    red != other.red
            ||  green != other.green
            ||  blue != other.blue
            ||  alpha != other.alpha );
}


#endif // __cplusplus
#endif // _UT_COLOR_H_