<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csgfx/gradient.h Source File (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>csgfx/gradient.h</h1><a href="csgfx_2gradient_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2003 by Jorrit Tyberghein</span> <a name="l00003"></a>00003 <span class="comment"> (C) 2003 by Frank Richter</span> <a name="l00004"></a>00004 <span class="comment"> (C) 2006 by Christopher Nelson</span> <a name="l00005"></a>00005 <span class="comment"></span> <a name="l00006"></a>00006 <span class="comment"> This library is free software; you can redistribute it and/or</span> <a name="l00007"></a>00007 <span class="comment"> modify it under the terms of the GNU Library General Public</span> <a name="l00008"></a>00008 <span class="comment"> License as published by the Free Software Foundation; either</span> <a name="l00009"></a>00009 <span class="comment"> version 2 of the License, or (at your option) any later version.</span> <a name="l00010"></a>00010 <span class="comment"></span> <a name="l00011"></a>00011 <span class="comment"> This library is distributed in the hope that it will be useful,</span> <a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00014"></a>00014 <span class="comment"> Library General Public License for more details.</span> <a name="l00015"></a>00015 <span class="comment"></span> <a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU Library General Public</span> <a name="l00017"></a>00017 <span class="comment"> License along with this library; if not, write to the Free</span> <a name="l00018"></a>00018 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span> <a name="l00019"></a>00019 <span class="comment">*/</span> <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="preprocessor">#ifndef __CS_CSGFX_GRADIENT_H__</span> <a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSGFX_GRADIENT_H__</span> <a name="l00023"></a>00023 <span class="preprocessor"></span> <a name="l00028"></a>00028 <span class="preprocessor">#include "csextern.h"</span> <a name="l00029"></a>00029 <a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="ivaria_2gradient_8h.html" title="Simple color gradient interfaces.">ivaria/gradient.h</a>"</span> <a name="l00031"></a>00031 <a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span> <a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="cscolor_8h.html" title="Floating-point color.">csutil/cscolor.h</a>"</span> <a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span> <a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="scfarray_8h.html" title="Implementation for iArrayReadOnly&lt;&gt;-, iArrayChangeElements&lt;&gt;- and iArrayChangeAll&lt;&gt...">csutil/scfarray.h</a>"</span> <a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="rgbpixel_8h.html" title="RGB colors.">csgfx/rgbpixel.h</a>"</span> <a name="l00037"></a>00037 <a name="l00057"></a><a class="code" href="classcsGradient.html">00057</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsGradient.html" title="A simple color gradient.">csGradient</a> : <a name="l00058"></a>00058 <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a><csGradient, iGradient> <a name="l00059"></a>00059 { <a name="l00060"></a>00060 <span class="keyword">protected</span>: <a name="l00062"></a><a class="code" href="classcsGradient.html#ea586d1f88b32ca13c608a5ee85c712f">00062</a> <a class="code" href="classcsArray.html" title="A templated array class.">csArray<csGradientShade></a> shades; <a name="l00063"></a><a class="code" href="structcsGradient_1_1scfGradientShadesArray.html">00063</a> <span class="keyword">struct </span><a class="code" href="structcsGradient_1_1scfGradientShadesArray.html">scfGradientShadesArray</a> : <span class="keyword">public</span> <a class="code" href="classscfArrayWrapConst.html" title="Implementation for iArrayReadOnly&lt;&gt;-derived interfaces, backed by a reference...">scfArrayWrapConst</a><iGradientShades, <a name="l00064"></a>00064 csArray<csGradientShade> > <a name="l00065"></a>00065 { <a name="l00066"></a><a class="code" href="structcsGradient_1_1scfGradientShadesArray.html#932573b5539894470253cef14c4d02f0">00066</a> <a class="code" href="structcsGradient_1_1scfGradientShadesArray.html">scfGradientShadesArray</a> (<a class="code" href="classcsGradient.html" title="A simple color gradient.">csGradient</a>* parent) : <a name="l00067"></a>00067 <a class="code" href="classscfArrayWrapConst.html" title="Implementation for iArrayReadOnly&lt;&gt;-derived interfaces, backed by a reference...">scfArrayWrapConst</a><<a class="code" href="structiGradientShades.html" title="An array of gradient shades.">iGradientShades</a>, <a class="code" href="classcsArray.html" title="A templated array class.">csArray</a><<a class="code" href="structcsGradientShade.html" title="An entry in an iGradient gradient.">csGradientShade</a>> > ( <a name="l00068"></a>00068 parent->shades, parent) {} <a name="l00069"></a>00069 }; <a name="l00070"></a>00070 <span class="keyword">public</span>: <a name="l00072"></a>00072 <a class="code" href="classcsGradient.html" title="A simple color gradient.">csGradient</a> (); <a name="l00074"></a>00074 <a class="code" href="classcsGradient.html" title="A simple color gradient.">csGradient</a> (<a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a> first, <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a> last); <a name="l00075"></a>00075 <a name="l00077"></a>00077 <a name="l00078"></a>00078 <a name="l00079"></a>00079 <span class="keywordtype">void</span> AddShade (<span class="keyword">const</span> <a class="code" href="structcsGradientShade.html" title="An entry in an iGradient gradient.">csGradientShade</a>& shade); <a name="l00080"></a>00080 <span class="keywordtype">void</span> AddShade (<span class="keyword">const</span> <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a>& color, <span class="keywordtype">float</span> position); <a name="l00081"></a>00081 <span class="keywordtype">void</span> AddShade (<span class="keyword">const</span> <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a>& left, <span class="keyword">const</span> <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a>& right, <a name="l00082"></a>00082 <span class="keywordtype">float</span> position); <a name="l00084"></a>00084 <a name="l00086"></a>00086 <span class="keywordtype">void</span> Clear (); <a name="l00087"></a>00087 <a name="l00104"></a>00104 <span class="keywordtype">bool</span> Render (<a class="code" href="structcsRGBcolor.html" title="An RGB color.">csRGBcolor</a>* pal, <span class="keywordtype">size_t</span> count, <span class="keywordtype">float</span> begin = 0.0f, <a name="l00105"></a>00105 <span class="keywordtype">float</span> end = 1.0f) <span class="keyword">const</span>; <a name="l00106"></a>00106 <a name="l00123"></a>00123 <span class="keywordtype">bool</span> Render (<a class="code" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a>* pal, <span class="keywordtype">size_t</span> count, <span class="keywordtype">float</span> begin = 0.0f, <a name="l00124"></a>00124 <span class="keywordtype">float</span> end = 1.0f) <span class="keyword">const</span>; <a name="l00125"></a>00125 <a name="l00127"></a>00127 <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iGradientShades></a> GetShades (); <a name="l00128"></a>00128 }; <a name="l00129"></a>00129 <a name="l00130"></a>00130 <a name="l00131"></a>00131 <span class="preprocessor">#endif // __CS_CSGFX_GRADIENT_H__</span> </pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>