Sophie

Sophie

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

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: csImageTools 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>csImageTools Class Reference<br>
<small>
[<a class="el" href="group__gfx.html">Graphics</a>]</small>
</h1><!-- doxytag: class="csImageTools" -->Some helper functions to deal with <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> objects.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="imagetools_8h-source.html">csgfx/imagetools.h</a>&gt;</code>
<p>

<p>
<a href="classcsImageTools-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 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageTools.html#0cc65872b2e4d8951364a41185ce9c5d">ClosestPaletteIndex</a> (const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> *Palette, const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> &amp;iColor, int palEntries=256)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the closest palette index to given color.  <a href="#0cc65872b2e4d8951364a41185ce9c5d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsImageTools.html#80dbdf96145b6159e3b1aebe70c6b724">ComputeDataSize</a> (<a class="el" href="structiImage.html">iImage</a> *img)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute the size of an image data, in bytes.  <a href="#80dbdf96145b6159e3b1aebe70c6b724"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Some helper functions to deal with <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> objects. 
<p>Definition at line <a class="el" href="imagetools_8h-source.html#l00038">38</a> of file <a class="el" href="imagetools_8h-source.html">imagetools.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0cc65872b2e4d8951364a41185ce9c5d"></a><!-- doxytag: member="csImageTools::ClosestPaletteIndex" ref="0cc65872b2e4d8951364a41185ce9c5d" args="(const csRGBpixel *Palette, const csRGBpixel &amp;iColor, int palEntries=256)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int csImageTools::ClosestPaletteIndex           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> *&nbsp;</td>
          <td class="paramname"> <em>Palette</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>iColor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>palEntries</em> = <code>256</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the closest palette index to given color. 
<p>

</div>
</div><p>
<a class="anchor" name="80dbdf96145b6159e3b1aebe70c6b724"></a><!-- doxytag: member="csImageTools::ComputeDataSize" ref="80dbdf96145b6159e3b1aebe70c6b724" args="(iImage *img)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static size_t csImageTools::ComputeDataSize           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiImage.html">iImage</a> *&nbsp;</td>
          <td class="paramname"> <em>img</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compute the size of an image data, in bytes. 
<p>

<p>Definition at line <a class="el" href="imagetools_8h-source.html#l00042">42</a> of file <a class="el" href="imagetools_8h-source.html">imagetools.h</a>.</p>

<p>References <a class="el" href="image_8h-source.html#l00044">CS_IMGFMT_MASK</a>, <a class="el" href="image_8h-source.html#l00053">CS_IMGFMT_PALETTED8</a>, <a class="el" href="structiImage.html#af91c32e0a30f974fdcad3919cb5ba66">iImage::GetDepth()</a>, <a class="el" href="structiImage.html#dcfcf95222b2f49662efaf5aca8033c8">iImage::GetFormat()</a>, <a class="el" href="structiImage.html#31a45f12e47bbdca9754117200ce9658">iImage::GetHeight()</a>, and <a class="el" href="structiImage.html#e46445da6aa7836ce65a1181b9125835">iImage::GetWidth()</a>.</p>

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