Sophie

Sophie

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

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: csGenerateImageTextureSingle 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>csGenerateImageTextureSingle Class Reference</h1><!-- doxytag: class="csGenerateImageTextureSingle" --><!-- doxytag: inherits="csGenerateImageTexture" -->A class for a single texture.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="gentrtex_8h-source.html">cstool/gentrtex.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for csGenerateImageTextureSingle:</div>
<div class="dynsection">
<p><center><img src="classcsGenerateImageTextureSingle__inherit__graph.png" border="0" usemap="#csGenerateImageTextureSingle__inherit__map" alt="Inheritance graph"></center>
<map name="csGenerateImageTextureSingle__inherit__map">
<area shape="rect" href="classcsGenerateImageTexture.html" title="A base class which represents a texture that can be displayed on the terrain." alt="" coords="24,7,208,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcsGenerateImageTextureSingle-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGenerateImageTextureSingle.html#0073c4416fe6d721cc33589dc0aba879">ComputeLayerColor</a> (const <a class="el" href="classcsVector2.html">csVector2</a> &amp;pos, <a class="el" href="classcsColor.html">csColor</a> &amp;col)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compute a color (0..1) for a spot on a layer  <a href="#0073c4416fe6d721cc33589dc0aba879"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGenerateImageTextureSingle.html#bc305faffcfa1835979e10ece7b55282">GetColor</a> (<a class="el" href="classcsColor.html">csColor</a> &amp;col, float x, float y)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the color  <a href="#bc305faffcfa1835979e10ece7b55282"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGenerateImageTextureSingle.html#4a592f8172da874d133a73247fc90eb3">GetImagePixel</a> (<a class="el" href="structiImage.html">iImage</a> *<a class="el" href="classcsGenerateImageTextureSingle.html#3bd1ec0c20aaf109077153d1c91878d4">image</a>, int x, int y, <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> &amp;res)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get a color for a pixel in image, tiles, result in res.  <a href="#4a592f8172da874d133a73247fc90eb3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGenerateImageTextureSingle.html#95d49cc4ab4c35281fe7d585c241f9e2">SetImage</a> (<a class="el" href="structiImage.html">iImage</a> *im)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add image  <a href="#95d49cc4ab4c35281fe7d585c241f9e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGenerateImageTextureSingle.html#048935be699e831192014daab298c272">~csGenerateImageTextureSingle</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">delete it  <a href="#048935be699e831192014daab298c272"></a><br></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="classcsRef.html">csRef</a>&lt; <a class="el" href="structiImage.html">iImage</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGenerateImageTextureSingle.html#3bd1ec0c20aaf109077153d1c91878d4">image</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the image - the texture image  <a href="#3bd1ec0c20aaf109077153d1c91878d4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector2.html">csVector2</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGenerateImageTextureSingle.html#e28391c6b077a2a20ce109eddf918007">offset</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">offset to shift image (0..1)  <a href="#e28391c6b077a2a20ce109eddf918007"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector2.html">csVector2</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGenerateImageTextureSingle.html#2c3619516fac06579ee7ffa3dcc07ff2">scale</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the scale of the image, (nr of times tiled on the terrain)  <a href="#2c3619516fac06579ee7ffa3dcc07ff2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A class for a single texture. 
<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd></dd></dl>

<p>Definition at line <a class="el" href="gentrtex_8h-source.html#l00144">144</a> of file <a class="el" href="gentrtex_8h-source.html">gentrtex.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="048935be699e831192014daab298c272"></a><!-- doxytag: member="csGenerateImageTextureSingle::~csGenerateImageTextureSingle" ref="048935be699e831192014daab298c272" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual csGenerateImageTextureSingle::~csGenerateImageTextureSingle           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
delete it 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0073c4416fe6d721cc33589dc0aba879"></a><!-- doxytag: member="csGenerateImageTextureSingle::ComputeLayerColor" ref="0073c4416fe6d721cc33589dc0aba879" args="(const csVector2 &amp;pos, csColor &amp;col)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csGenerateImageTextureSingle::ComputeLayerColor           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector2.html">csVector2</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>pos</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsColor.html">csColor</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>col</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
compute a color (0..1) for a spot on a layer 
<p>

</div>
</div><p>
<a class="anchor" name="bc305faffcfa1835979e10ece7b55282"></a><!-- doxytag: member="csGenerateImageTextureSingle::GetColor" ref="bc305faffcfa1835979e10ece7b55282" args="(csColor &amp;col, float x, float y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csGenerateImageTextureSingle::GetColor           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsColor.html">csColor</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>col</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get the color 
<p>

<p>Implements <a class="el" href="classcsGenerateImageTexture.html#f1f1b5a8e27e3c8cf44402260b41de63">csGenerateImageTexture</a>.</p>

</div>
</div><p>
<a class="anchor" name="4a592f8172da874d133a73247fc90eb3"></a><!-- doxytag: member="csGenerateImageTextureSingle::GetImagePixel" ref="4a592f8172da874d133a73247fc90eb3" args="(iImage *image, int x, int y, csRGBpixel &amp;res)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csGenerateImageTextureSingle::GetImagePixel           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiImage.html">iImage</a> *&nbsp;</td>
          <td class="paramname"> <em>image</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcsRGBpixel.html">csRGBpixel</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>res</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
get a color for a pixel in image, tiles, result in res. 
<p>

</div>
</div><p>
<a class="anchor" name="95d49cc4ab4c35281fe7d585c241f9e2"></a><!-- doxytag: member="csGenerateImageTextureSingle::SetImage" ref="95d49cc4ab4c35281fe7d585c241f9e2" args="(iImage *im)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csGenerateImageTextureSingle::SetImage           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiImage.html">iImage</a> *&nbsp;</td>
          <td class="paramname"> <em>im</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
add image 
<p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="3bd1ec0c20aaf109077153d1c91878d4"></a><!-- doxytag: member="csGenerateImageTextureSingle::image" ref="3bd1ec0c20aaf109077153d1c91878d4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsRef.html">csRef</a>&lt;<a class="el" href="structiImage.html">iImage</a>&gt; <a class="el" href="classcsGenerateImageTextureSingle.html#3bd1ec0c20aaf109077153d1c91878d4">csGenerateImageTextureSingle::image</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
the image - the texture image 
<p>

<p>Definition at line <a class="el" href="gentrtex_8h-source.html#l00149">149</a> of file <a class="el" href="gentrtex_8h-source.html">gentrtex.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="e28391c6b077a2a20ce109eddf918007"></a><!-- doxytag: member="csGenerateImageTextureSingle::offset" ref="e28391c6b077a2a20ce109eddf918007" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsVector2.html">csVector2</a> <a class="el" href="classcsGenerateImageTextureSingle.html#e28391c6b077a2a20ce109eddf918007">csGenerateImageTextureSingle::offset</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
offset to shift image (0..1) 
<p>

<p>Definition at line <a class="el" href="gentrtex_8h-source.html#l00153">153</a> of file <a class="el" href="gentrtex_8h-source.html">gentrtex.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="2c3619516fac06579ee7ffa3dcc07ff2"></a><!-- doxytag: member="csGenerateImageTextureSingle::scale" ref="2c3619516fac06579ee7ffa3dcc07ff2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsVector2.html">csVector2</a> <a class="el" href="classcsGenerateImageTextureSingle.html#2c3619516fac06579ee7ffa3dcc07ff2">csGenerateImageTextureSingle::scale</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
the scale of the image, (nr of times tiled on the terrain) 
<p>

<p>Definition at line <a class="el" href="gentrtex_8h-source.html#l00151">151</a> of file <a class="el" href="gentrtex_8h-source.html">gentrtex.h</a>.</p>

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