Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1944

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: ivaria/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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>ivaria/gradient.h</h1><a href="ivaria_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_IVARIA_GRADIENT_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IVARIA_GRADIENT_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="iutil_2array_8h.html" title="Templates for array interfaces.">iutil/array.h</a>"</span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="cscolor_8h.html" title="Floating-point color.">csutil/cscolor.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="rgbpixel_8h.html" title="RGB colors.">csgfx/rgbpixel.h</a>"</span>
<a name="l00032"></a>00032 
<a name="l00036"></a><a class="code" href="structcsGradientShade.html">00036</a> <span class="keyword">struct </span><a class="code" href="structcsGradientShade.html" title="An entry in an iGradient gradient.">csGradientShade</a>
<a name="l00037"></a>00037 {
<a name="l00039"></a><a class="code" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957">00039</a>   <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a> <a class="code" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957" title="Color of the left side.">left</a>;
<a name="l00041"></a><a class="code" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588">00041</a>   <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a> <a class="code" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588" title="Color of the right side.">right</a>;
<a name="l00043"></a><a class="code" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92">00043</a>   <span class="keywordtype">float</span> <a class="code" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92" title="Position in the gradient.">position</a>;
<a name="l00044"></a>00044   
<a name="l00046"></a><a class="code" href="structcsGradientShade.html#9768bed3a3ff9e6dac6adc786db4bfa9">00046</a>   <a class="code" href="structcsGradientShade.html#9768bed3a3ff9e6dac6adc786db4bfa9" title="Construct with all values set to 0.">csGradientShade</a> () : <a class="code" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957" title="Color of the left side.">left</a> (0, 0, 0, 1.0f), <a class="code" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588" title="Color of the right side.">right</a> (0, 0, 0, 1.0f), 
<a name="l00047"></a>00047     <a class="code" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92" title="Position in the gradient.">position</a> (0) {}
<a name="l00048"></a>00048       
<a name="l00050"></a><a class="code" href="structcsGradientShade.html#498db8ddf0114cde3115344f7542172b">00050</a>   <a class="code" href="structcsGradientShade.html#9768bed3a3ff9e6dac6adc786db4bfa9" title="Construct with all values set to 0.">csGradientShade</a> (<span class="keyword">const</span> <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a>&amp; left_color, <span class="keyword">const</span> <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a>&amp; right_color, 
<a name="l00051"></a>00051     <span class="keywordtype">float</span> pos)  : <a class="code" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957" title="Color of the left side.">left</a> (left_color), <a class="code" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588" title="Color of the right side.">right</a> (right_color), <a class="code" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92" title="Position in the gradient.">position</a> (pos) {}
<a name="l00053"></a><a class="code" href="structcsGradientShade.html#b29cea5e93bd5f808de7fed42c15139a">00053</a>   <span class="keyword">explicit</span> <a class="code" href="structcsGradientShade.html#9768bed3a3ff9e6dac6adc786db4bfa9" title="Construct with all values set to 0.">csGradientShade</a> (<span class="keyword">const</span> <a class="code" href="classcsColor.html" title="A class used to represent a color in RGB space.">csColor</a>&amp; left_color, 
<a name="l00054"></a>00054     <span class="keyword">const</span> <a class="code" href="classcsColor.html" title="A class used to represent a color in RGB space.">csColor</a>&amp; right_color, <span class="keywordtype">float</span> pos) : <a class="code" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957" title="Color of the left side.">left</a> (left_color), 
<a name="l00055"></a>00055     <a class="code" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588" title="Color of the right side.">right</a> (right_color), <a class="code" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92" title="Position in the gradient.">position</a> (pos) {}
<a name="l00056"></a>00056       
<a name="l00061"></a><a class="code" href="structcsGradientShade.html#88605f861c013cc905b0a51c848a0c21">00061</a>   <a class="code" href="structcsGradientShade.html#9768bed3a3ff9e6dac6adc786db4bfa9" title="Construct with all values set to 0.">csGradientShade</a> (<span class="keyword">const</span> <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a>&amp; color, <span class="keywordtype">float</span> pos) : <a class="code" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957" title="Color of the left side.">left</a> (color), 
<a name="l00062"></a>00062     <a class="code" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588" title="Color of the right side.">right</a> (color), <a class="code" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92" title="Position in the gradient.">position</a> (pos) {}
<a name="l00067"></a><a class="code" href="structcsGradientShade.html#fbcff23d50612ed7a22bf4e37195a657">00067</a>   <span class="keyword">explicit</span> <a class="code" href="structcsGradientShade.html#9768bed3a3ff9e6dac6adc786db4bfa9" title="Construct with all values set to 0.">csGradientShade</a> (<span class="keyword">const</span> <a class="code" href="classcsColor.html" title="A class used to represent a color in RGB space.">csColor</a>&amp; color, <span class="keywordtype">float</span> pos) : 
<a name="l00068"></a>00068     <a class="code" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957" title="Color of the left side.">left</a> (color), <a class="code" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588" title="Color of the right side.">right</a> (color), <a class="code" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92" title="Position in the gradient.">position</a> (pos) {}
<a name="l00069"></a>00069 
<a name="l00070"></a><a class="code" href="structcsGradientShade.html#371257bf17c940daec6786fe33400097">00070</a>   <span class="keywordtype">bool</span> <a class="code" href="structcsGradientShade.html#371257bf17c940daec6786fe33400097">operator== </a>(<span class="keyword">const</span> <a class="code" href="structcsGradientShade.html" title="An entry in an iGradient gradient.">csGradientShade</a>&amp; other)
<a name="l00071"></a>00071   { 
<a name="l00072"></a>00072     <span class="keywordflow">return</span> (<a class="code" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957" title="Color of the left side.">left</a> == other.<a class="code" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957" title="Color of the left side.">left</a>) &amp;&amp; (<a class="code" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588" title="Color of the right side.">right</a> == other.<a class="code" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588" title="Color of the right side.">right</a>)
<a name="l00073"></a>00073       &amp;&amp; (<a class="code" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92" title="Position in the gradient.">position</a> == other.<a class="code" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92" title="Position in the gradient.">position</a>);
<a name="l00074"></a>00074   }
<a name="l00075"></a>00075 };
<a name="l00076"></a>00076 
<a name="l00080"></a><a class="code" href="structiGradientShades.html">00080</a> <span class="keyword">struct </span><a class="code" href="structiGradientShades.html" title="An array of gradient shades.">iGradientShades</a> : <span class="keyword">public</span> <a class="code" href="structiArrayReadOnly.html" title="Array interface template, read-only.">iArrayReadOnly</a>&lt;csGradientShade&gt;
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082   SCF_IARRAYREADONLY_INTERFACE(<a class="code" href="structiGradientShades.html" title="An array of gradient shades.">iGradientShades</a>);
<a name="l00083"></a>00083 };
<a name="l00084"></a>00084 
<a name="l00127"></a><a class="code" href="structiGradient.html">00127</a> <span class="keyword">struct </span><a class="code" href="structiGradient.html" title="A simple color gradient.">iGradient</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00128"></a>00128 {
<a name="l00129"></a>00129   SCF_INTERFACE(<a class="code" href="structiGradient.html" title="A simple color gradient.">iGradient</a>, 0, 0, 1);
<a name="l00130"></a>00130   
<a name="l00132"></a>00132 
<a name="l00133"></a>00133   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiGradient.html#bafb739cac7eaf209c1a78ae5c62247b" title="Add a shade.">AddShade</a> (<span class="keyword">const</span> <a class="code" href="structcsGradientShade.html" title="An entry in an iGradient gradient.">csGradientShade</a>&amp; shade) = 0;
<a name="l00134"></a>00134   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiGradient.html#bafb739cac7eaf209c1a78ae5c62247b" title="Add a shade.">AddShade</a> (<span class="keyword">const</span> <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a>&amp; color, <span class="keywordtype">float</span> position) = 0;
<a name="l00135"></a>00135   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiGradient.html#bafb739cac7eaf209c1a78ae5c62247b" title="Add a shade.">AddShade</a> (<span class="keyword">const</span> <a class="code" href="classcsColor4.html" title="A class used to represent a color in RGBA space.">csColor4</a>&amp; 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>&amp; right, 
<a name="l00136"></a>00136     <span class="keywordtype">float</span> position) = 0;
<a name="l00138"></a>00138   
<a name="l00140"></a>00140   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiGradient.html#9b881571bc707e5cd4f57d2f18d72880" title="Clear all shades.">Clear</a> () = 0;
<a name="l00141"></a>00141   
<a name="l00158"></a>00158   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiGradient.html#8ebb11c93c33f6ff51d5f50109559903" title="Interpolate the colors over a part of the gradient.">Render</a> (<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="l00159"></a>00159     <span class="keywordtype">float</span> end = 1.0f) <span class="keyword">const</span> = 0;
<a name="l00160"></a>00160   
<a name="l00177"></a>00177   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiGradient.html#8ebb11c93c33f6ff51d5f50109559903" title="Interpolate the colors over a part of the gradient.">Render</a> (<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="l00178"></a>00178     <span class="keywordtype">float</span> end = 1.0f) <span class="keyword">const</span> = 0;
<a name="l00179"></a>00179 
<a name="l00181"></a>00181   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iGradientShades&gt;</a> <a class="code" href="structiGradient.html#ce86492d535820fadca55ceed2763cce" title="Get the array of shades.">GetShades</a> () = 0;
<a name="l00182"></a>00182 };
<a name="l00183"></a>00183 
<a name="l00184"></a>00184 
<a name="l00185"></a>00185 <span class="preprocessor">#endif // __CS_IVARIA_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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional