## Public API Reference

- Main Page
- Modules
- Namespaces
- Classes
- Files
- Related Pages

- File List
- File Members

# 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 "csextern.h"
    00028
    00029 #include "csutil/cscolor.h"
    00030 #include "csutil/array.h"
    00031 #include "csgfx/rgbpixel.h"
    00032
    00033 class csGradient;
    00034
    00038 struct CS_CRYSTALSPACE_EXPORT csGradientShade
    00039 {
    00041   csColor left;
    00043   csColor right;
    00045   float position;
    00046
    00048   csGradientShade ();
    00050   csGradientShade (csColor left_color, csColor right_color, float pos);
    00055   csGradientShade (csColor color, float pos);
    00056 };
    00057
    00096 class CS_CRYSTALSPACE_EXPORT csGradient
    00097 {
    00098 protected:
    00100   csArray<csGradientShade> shades;
    00101 public:
    00103   csGradient ();
    00105   csGradient (csColor first, csColor last);
    00106
    00108   void AddShade (csGradientShade shade);
    00109
    00111   void Clear ();
    00112
    00129   bool Render (csRGBcolor* pal, size_t count, float begin = 0.0f,
    00130     float end = 1.0f) const;
    00131
    00133   const csArray<csGradientShade>& GetShades () const { return shades; }
    00134 };
    00135
    00136
    00137 #endif