CrystalSpace

Public API Reference

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

csgfx/gradient.h

Go to the documentation of this file.
00001 /*
00002     Copyright (C) 2003 by Jorrit Tyberghein
00003               (C) 2003 by Frank Richter
00004 
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014 
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00018 */
00019 
00020 #ifndef __CS_CSTOOL_GRADIENT_H__
00021 #define __CS_CSTOOL_GRADIENT_H__
00022 
00027 #include "csutil/cscolor.h"
00028 #include "csutil/array.h"
00029 #include "csgfx/rgbpixel.h"
00030 
00031 class csGradient;
00032 
00036 struct csGradientShade 
00037 {
00039   csColor left;
00041   csColor right;
00043   float position;
00044   
00046   csGradientShade ();
00048   csGradientShade (csColor left_color, csColor right_color, float pos);
00053   csGradientShade (csColor color, float pos);
00054 };
00055 
00094 class csGradient
00095 {
00096 protected:
00098   csArray<csGradientShade> shades;
00099 public:
00101   csGradient ();
00103   csGradient (csColor first, csColor last);
00104   
00106   void AddShade (csGradientShade shade);
00107   
00109   void Clear ();
00110   
00127   bool Render (csRGBcolor* pal, int count, float begin = 0.0f, 
00128     float end = 1.0f) const;
00129 };
00130 
00131 
00132 #endif

Generated for Crystal Space by doxygen 1.2.18