Sophie

Sophie

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

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: csGradientShade Struct Reference (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 class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csGradientShade Struct Reference</h1><!-- doxytag: class="csGradientShade" -->An entry in an <a class="el" href="structiGradient.html" title="A simple color gradient.">iGradient</a> gradient.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ivaria_2gradient_8h-source.html">ivaria/gradient.h</a>&gt;</code>
<p>

<p>
<a href="structcsGradientShade-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsGradientShade.html#fbcff23d50612ed7a22bf4e37195a657">csGradientShade</a> (const <a class="el" href="classcsColor.html">csColor</a> &amp;color, float pos)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct using a color and position.  <a href="#fbcff23d50612ed7a22bf4e37195a657"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsGradientShade.html#88605f861c013cc905b0a51c848a0c21">csGradientShade</a> (const <a class="el" href="classcsColor4.html">csColor4</a> &amp;color, float pos)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct using a color and position.  <a href="#88605f861c013cc905b0a51c848a0c21"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsGradientShade.html#b29cea5e93bd5f808de7fed42c15139a">csGradientShade</a> (const <a class="el" href="classcsColor.html">csColor</a> &amp;left_color, const <a class="el" href="classcsColor.html">csColor</a> &amp;right_color, float pos)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct supplying all values.  <a href="#b29cea5e93bd5f808de7fed42c15139a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsGradientShade.html#498db8ddf0114cde3115344f7542172b">csGradientShade</a> (const <a class="el" href="classcsColor4.html">csColor4</a> &amp;left_color, const <a class="el" href="classcsColor4.html">csColor4</a> &amp;right_color, float pos)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct supplying all values.  <a href="#498db8ddf0114cde3115344f7542172b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsGradientShade.html#9768bed3a3ff9e6dac6adc786db4bfa9">csGradientShade</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct with all values set to 0.  <a href="#9768bed3a3ff9e6dac6adc786db4bfa9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="371257bf17c940daec6786fe33400097"></a><!-- doxytag: member="csGradientShade::operator==" ref="371257bf17c940daec6786fe33400097" args="(const csGradientShade &amp;other)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsGradientShade.html#371257bf17c940daec6786fe33400097">operator==</a> (const <a class="el" href="structcsGradientShade.html">csGradientShade</a> &amp;other)</td></tr>

<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor4.html">csColor4</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957">left</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Color of the left side.  <a href="#dafe66d649abd0dcd930a175a3db2957"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92">position</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Position in the gradient.  <a href="#6bbd701eeeb985c384699a270574bb92"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsColor4.html">csColor4</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588">right</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Color of the right side.  <a href="#138d3eb1b980c92688f21b3b16a39588"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An entry in an <a class="el" href="structiGradient.html" title="A simple color gradient.">iGradient</a> gradient. 
<p>Definition at line <a class="el" href="ivaria_2gradient_8h-source.html#l00036">36</a> of file <a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="9768bed3a3ff9e6dac6adc786db4bfa9"></a><!-- doxytag: member="csGradientShade::csGradientShade" ref="9768bed3a3ff9e6dac6adc786db4bfa9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csGradientShade::csGradientShade           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct with all values set to 0. 
<p>

<p>Definition at line <a class="el" href="ivaria_2gradient_8h-source.html#l00046">46</a> of file <a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="498db8ddf0114cde3115344f7542172b"></a><!-- doxytag: member="csGradientShade::csGradientShade" ref="498db8ddf0114cde3115344f7542172b" args="(const csColor4 &amp;left_color, const csColor4 &amp;right_color, float pos)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csGradientShade::csGradientShade           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>left_color</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>right_color</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>pos</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct supplying all values. 
<p>

<p>Definition at line <a class="el" href="ivaria_2gradient_8h-source.html#l00050">50</a> of file <a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b29cea5e93bd5f808de7fed42c15139a"></a><!-- doxytag: member="csGradientShade::csGradientShade" ref="b29cea5e93bd5f808de7fed42c15139a" args="(const csColor &amp;left_color, const csColor &amp;right_color, float pos)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csGradientShade::csGradientShade           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>left_color</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>right_color</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>pos</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct supplying all values. 
<p>

<p>Definition at line <a class="el" href="ivaria_2gradient_8h-source.html#l00053">53</a> of file <a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="88605f861c013cc905b0a51c848a0c21"></a><!-- doxytag: member="csGradientShade::csGradientShade" ref="88605f861c013cc905b0a51c848a0c21" args="(const csColor4 &amp;color, float pos)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csGradientShade::csGradientShade           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsColor4.html">csColor4</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>color</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>pos</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct using a color and position. 
<p>
Both left and right will have the value of color. 
<p>Definition at line <a class="el" href="ivaria_2gradient_8h-source.html#l00061">61</a> of file <a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fbcff23d50612ed7a22bf4e37195a657"></a><!-- doxytag: member="csGradientShade::csGradientShade" ref="fbcff23d50612ed7a22bf4e37195a657" args="(const csColor &amp;color, float pos)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csGradientShade::csGradientShade           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsColor.html">csColor</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>color</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>pos</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct using a color and position. 
<p>
Both left and right will have the value of color. 
<p>Definition at line <a class="el" href="ivaria_2gradient_8h-source.html#l00067">67</a> of file <a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="dafe66d649abd0dcd930a175a3db2957"></a><!-- doxytag: member="csGradientShade::left" ref="dafe66d649abd0dcd930a175a3db2957" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsColor4.html">csColor4</a> <a class="el" href="structcsGradientShade.html#dafe66d649abd0dcd930a175a3db2957">csGradientShade::left</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Color of the left side. 
<p>

<p>Definition at line <a class="el" href="ivaria_2gradient_8h-source.html#l00039">39</a> of file <a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a>.</p>

<p>Referenced by <a class="el" href="ivaria_2gradient_8h-source.html#l00070">operator==()</a>.</p>

</div>
</div><p>
<a class="anchor" name="6bbd701eeeb985c384699a270574bb92"></a><!-- doxytag: member="csGradientShade::position" ref="6bbd701eeeb985c384699a270574bb92" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="structcsGradientShade.html#6bbd701eeeb985c384699a270574bb92">csGradientShade::position</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Position in the gradient. 
<p>

<p>Definition at line <a class="el" href="ivaria_2gradient_8h-source.html#l00043">43</a> of file <a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a>.</p>

<p>Referenced by <a class="el" href="ivaria_2gradient_8h-source.html#l00070">operator==()</a>.</p>

</div>
</div><p>
<a class="anchor" name="138d3eb1b980c92688f21b3b16a39588"></a><!-- doxytag: member="csGradientShade::right" ref="138d3eb1b980c92688f21b3b16a39588" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsColor4.html">csColor4</a> <a class="el" href="structcsGradientShade.html#138d3eb1b980c92688f21b3b16a39588">csGradientShade::right</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Color of the right side. 
<p>

<p>Definition at line <a class="el" href="ivaria_2gradient_8h-source.html#l00041">41</a> of file <a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a>.</p>

<p>Referenced by <a class="el" href="ivaria_2gradient_8h-source.html#l00070">operator==()</a>.</p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="ivaria_2gradient_8h-source.html">gradient.h</a></ul>
<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>