Sophie

Sophie

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

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: csFogMath Class 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>csFogMath Class Reference</h1><!-- doxytag: class="csFogMath" -->Fog math utilities.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="fogmath_8h-source.html">cstool/fogmath.h</a>&gt;</code>
<p>

<p>
<a href="classcsFogMath-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFogMath.html#56d0f38dafbc32848a267c05417ae3a0">DistanceForOpacity</a> (float density, float opacity)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inverse of OpacityAtDistance.  <a href="#56d0f38dafbc32848a267c05417ae3a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFogMath.html#e5aca5f0130f4180581ac18263dbcdf7">OpacityAtDistance</a> (float density, float dist)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute fog opacity at a given distance.  <a href="#e5aca5f0130f4180581ac18263dbcdf7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFogMath.html#74be5cd72713d13d9fb61bdaa9089e42">Ramp</a> (float depth)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculates fog density for a certain depth in the range [0.  <a href="#74be5cd72713d13d9fb61bdaa9089e42"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Fog math utilities. 
<p>Definition at line <a class="el" href="fogmath_8h-source.html#l00027">27</a> of file <a class="el" href="fogmath_8h-source.html">fogmath.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="56d0f38dafbc32848a267c05417ae3a0"></a><!-- doxytag: member="csFogMath::DistanceForOpacity" ref="56d0f38dafbc32848a267c05417ae3a0" args="(float density, float opacity)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static float csFogMath::DistanceForOpacity           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>density</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>opacity</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Inverse of OpacityAtDistance. 
<p>

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

</div>
</div><p>
<a class="anchor" name="e5aca5f0130f4180581ac18263dbcdf7"></a><!-- doxytag: member="csFogMath::OpacityAtDistance" ref="e5aca5f0130f4180581ac18263dbcdf7" args="(float density, float dist)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static float csFogMath::OpacityAtDistance           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>density</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>dist</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compute fog opacity at a given distance. 
<p>

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

<p>References <a class="el" href="fogmath_8h-source.html#l00033">Ramp()</a>.</p>

</div>
</div><p>
<a class="anchor" name="74be5cd72713d13d9fb61bdaa9089e42"></a><!-- doxytag: member="csFogMath::Ramp" ref="74be5cd72713d13d9fb61bdaa9089e42" args="(float depth)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static float csFogMath::Ramp           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>depth</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Calculates fog density for a certain depth in the range [0. 
<p>
.1] 
<p>Definition at line <a class="el" href="fogmath_8h-source.html#l00033">33</a> of file <a class="el" href="fogmath_8h-source.html">fogmath.h</a>.</p>

<p>Referenced by <a class="el" href="fogmath_8h-source.html#l00041">OpacityAtDistance()</a>.</p>

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