Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OgreColourValue.h

Go to the documentation of this file.
00001 /*
00002 -----------------------------------------------------------------------------
00003 This source file is part of OGRE
00004     (Object-oriented Graphics Rendering Engine)
00005 For the latest info, see http://www.ogre3d.org/
00006 
00007 Copyright © 2000-2002 The OGRE Team
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 -----------------------------------------------------------------------------
00024 */
00025 #ifndef _COLOURVALUE_H__
00026 #define _COLOURVALUE_H__
00027 
00028 #include "OgrePrerequisites.h"
00029 
00030 namespace Ogre {
00031 
00032     typedef unsigned long RGBA;
00033     typedef unsigned long ARGB;
00034     typedef unsigned long ABGR;
00035 
00047     class _OgreExport ColourValue
00048     {
00049     public:
00050         static ColourValue Black;
00051         static ColourValue White;
00052         static ColourValue Red;
00053         static ColourValue Green;
00054         static ColourValue Blue;
00055 
00056         ColourValue( Real red = 1.0f,
00057                     Real green = 1.0f,
00058                     Real blue = 1.0f,
00059                     Real alpha = 1.0f ) : r(red), g(green), b(blue), a(alpha)
00060         { }
00061 
00062         bool operator==(const ColourValue& rhs) const;
00063         bool operator!=(const ColourValue& rhs) const;
00064 
00065         union {
00066             struct {
00067                 Real r,g,b,a;
00068             };
00069             Real val[4];
00070         };
00071 
00074         RGBA getAsLongRGBA(void) const;
00075 
00078         ARGB getAsLongARGB(void) const;
00079 
00081         ABGR getAsLongABGR(void) const;
00082 
00083     };
00084 
00085 } // namespace
00086 
00087 #endif

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:21:57 2004