Sophie

Sophie

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

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: csCommonImageFile 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>csCommonImageFile Class Reference<br>
<small>
[<a class="el" href="group__plugincommon.html">Common Plugin Classes</a>]</small>
</h1><!-- doxytag: class="csCommonImageFile" --><!-- doxytag: inherits="scfImplementationExt0&lt; csCommonImageFile, csImageMemory &gt;" -->A base class for image loader plugin <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> implementations.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="commonimagefile_8h-source.html">csplugincommon/imageloader/commonimagefile.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for csCommonImageFile:</div>
<div class="dynsection">
<p><center><img src="classcsCommonImageFile__inherit__graph.png" border="0" usemap="#csCommonImageFile__inherit__map" alt="Inheritance graph"></center>
<map name="csCommonImageFile__inherit__map">
<area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\&lt; csCommonImageFile, csImageMemory \&gt;" alt="" coords="5,471,461,497"><area shape="rect" href="classcsImageMemory.html" title="Memory image." alt="" coords="168,393,299,420"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\&lt; csImageMemory, csImageBase \&gt;" alt="" coords="31,316,436,343"><area shape="rect" href="classcsImageBase.html" title="Base class for iImage implementations." alt="" coords="180,239,287,265"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; csImageBase, iImage \&gt;" alt="" coords="75,161,392,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\&lt; csImageBase \&gt;" alt="" coords="12,84,271,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="287,7,343,33"><area shape="rect" href="structiImage.html" title="The iImage interface is used to work with image objects." alt="" coords="295,84,359,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="31,7,252,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcsCommonImageFile-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#52eb4dcce4f38fded746cc8e6df78d33">GetAlpha</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get alpha map for 8-bit paletted image.  <a href="#52eb4dcce4f38fded746cc8e6df78d33"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#0fc5c8f36c1f8ad9626d339300a8ce11">GetImageData</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get image data: returns either (<a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> *) or (unsigned char *) depending on format.  <a href="#0fc5c8f36c1f8ad9626d339300a8ce11"></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="classcsCommonImageFile.html#3d4f16347be90e13ce89d1d81f8247c7">GetKeyColor</a> (int &amp;r, int &amp;g, int &amp;b) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the keycolour stored with the image.  <a href="#3d4f16347be90e13ce89d1d81f8247c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<a class="el" href="structcsRGBpixel.html">csRGBpixel</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#930e39e085bc6a905036711f9047788e">GetPalette</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get image palette (or 0 if no palette).  <a href="#930e39e085bc6a905036711f9047788e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br>
&lt; <a class="el" href="structiDataBuffer.html">iDataBuffer</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#ec21772b6225bce4b19c4a5bfeaac688">GetRawData</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the raw data of the image (or 0 if raw data is not provided).  <a href="#ec21772b6225bce4b19c4a5bfeaac688"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#df390477df78180ad356ddd90fe83383">GetRawFormat</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a string identifying the format of the raw data of the image (or 0 if raw data is not provided).  <a href="#df390477df78180ad356ddd90fe83383"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#421637e134710b348c21c683e4626381">HasKeyColor</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if image has a keycolour stored with it.  <a href="#421637e134710b348c21c683e4626381"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br>
&lt; <a class="el" href="structiImageFileLoader.html">iImageFileLoader</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#2a641aa577cf40ac3f6ac72c00b2543e">InitLoader</a> (<a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiDataBuffer.html">iDataBuffer</a> &gt; source)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a loader object, which will handle the actual loading.  <a href="#2a641aa577cf40ac3f6ac72c00b2543e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#531bf5da882815e71edbe13db0807499">Load</a> (<a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiDataBuffer.html">iDataBuffer</a> &gt; source)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load an image from a data buffer.  <a href="#531bf5da882815e71edbe13db0807499"></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="classcsCommonImageFile.html#4e2c79442bb80b1a61e4fd6a76378350">MakeImageData</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert data from the loader to actual image data.  <a href="#4e2c79442bb80b1a61e4fd6a76378350"></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="classcsCommonImageFile.html#cdffd9cd912ca79070ebadf87c87b4d8">WaitForJob</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wait for the current image loading job to finish.  <a href="#cdffd9cd912ca79070ebadf87c87b4d8"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#01846a0717572b1edc81d72040ed2791">DataTypeString</a> (<a class="el" href="group__plugincommon.html#g54322e5b0a32278ba666a82a86e4ab45">csLoaderDataType</a> dataType)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert an image loader data type into a raw data description (if supported).  <a href="#01846a0717572b1edc81d72040ed2791"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected 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="structiJobQueue.html">iJobQueue</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#7b235d2da32a91ede56ac12620a05e54">jobQueue</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference to job queue.  <a href="#7b235d2da32a91ede56ac12620a05e54"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="classcsCommonImageFile_1_1LoaderJob.html">LoaderJob</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#80a19c458ede45a9a6a7fc7a2fee8eac">loadJob</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference to the job for loading this image.  <a href="#80a19c458ede45a9a6a7fc7a2fee8eac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c0eb5be39a6335342b2947e7c83dba9"></a><!-- doxytag: member="csCommonImageFile::object_reg" ref="7c0eb5be39a6335342b2947e7c83dba9" args="" -->
<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#7c0eb5be39a6335342b2947e7c83dba9">object_reg</a></td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="883c13ca991f2d494c55b86cfbb774af"></a><!-- doxytag: member="csCommonImageFile::csCommonImageFileLoader" ref="883c13ca991f2d494c55b86cfbb774af" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile.html#883c13ca991f2d494c55b86cfbb774af">csCommonImageFileLoader</a></td></tr>

<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommonImageFile_1_1LoaderJob.html">LoaderJob</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A base class for image loader plugin <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> implementations. 
<p>Definition at line <a class="el" href="commonimagefile_8h-source.html#l00143">143</a> of file <a class="el" href="commonimagefile_8h-source.html">commonimagefile.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="01846a0717572b1edc81d72040ed2791"></a><!-- doxytag: member="csCommonImageFile::DataTypeString" ref="01846a0717572b1edc81d72040ed2791" args="(csLoaderDataType dataType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static const char* csCommonImageFile::DataTypeString           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__plugincommon.html#g54322e5b0a32278ba666a82a86e4ab45">csLoaderDataType</a>&nbsp;</td>
          <td class="paramname"> <em>dataType</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convert an image loader data type into a raw data description (if supported). 
<p>

</div>
</div><p>
<a class="anchor" name="52eb4dcce4f38fded746cc8e6df78d33"></a><!-- doxytag: member="csCommonImageFile::GetAlpha" ref="52eb4dcce4f38fded746cc8e6df78d33" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a>* csCommonImageFile::GetAlpha           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get alpha map for 8-bit paletted image. 
<p>
RGBA images contains alpha within themself. If image has no alpha map, or the image is in RGBA format, this function will return 0. 
<p>Reimplemented from <a class="el" href="classcsImageMemory.html#792c385b2e95334f99e2bf0c4f9d73e2">csImageMemory</a>.</p>

</div>
</div><p>
<a class="anchor" name="0fc5c8f36c1f8ad9626d339300a8ce11"></a><!-- doxytag: member="csCommonImageFile::GetImageData" ref="0fc5c8f36c1f8ad9626d339300a8ce11" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const void* csCommonImageFile::GetImageData           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get image data: returns either (<a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> *) or (unsigned char *) depending on format. 
<p>
Note that for RGBA images the <a class="el" href="structcsRGBpixel.html" title="An RGB pixel.">csRGBpixel</a> structure contains the alpha channel as well, so GetAlpha (see below) method will return 0 (because alpha is not stored separately, as for paletted images). 
<p>Reimplemented from <a class="el" href="classcsImageMemory.html#ad1819c50cc745d90b45e513a59bdb9f">csImageMemory</a>.</p>

</div>
</div><p>
<a class="anchor" name="3d4f16347be90e13ce89d1d81f8247c7"></a><!-- doxytag: member="csCommonImageFile::GetKeyColor" ref="3d4f16347be90e13ce89d1d81f8247c7" args="(int &amp;r, int &amp;g, int &amp;b) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csCommonImageFile::GetKeyColor           </td>
          <td>(</td>
          <td class="paramtype">int &amp;&nbsp;</td>
          <td class="paramname"> <em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&nbsp;</td>
          <td class="paramname"> <em>g</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&nbsp;</td>
          <td class="paramname"> <em>b</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the keycolour stored with the image. 
<p>

<p>Reimplemented from <a class="el" href="classcsImageMemory.html#4599b6db9460da15d5f04be8a5fe9ee3">csImageMemory</a>.</p>

<p>Definition at line <a class="el" href="commonimagefile_8h-source.html#l00210">210</a> of file <a class="el" href="commonimagefile_8h-source.html">commonimagefile.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="930e39e085bc6a905036711f9047788e"></a><!-- doxytag: member="csCommonImageFile::GetPalette" ref="930e39e085bc6a905036711f9047788e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="structcsRGBpixel.html">csRGBpixel</a>* csCommonImageFile::GetPalette           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get image palette (or 0 if no palette). 
<p>

<p>Reimplemented from <a class="el" href="classcsImageMemory.html#678bb2fa71f077c58d30640890ad7b8c">csImageMemory</a>.</p>

</div>
</div><p>
<a class="anchor" name="ec21772b6225bce4b19c4a5bfeaac688"></a><!-- doxytag: member="csCommonImageFile::GetRawData" ref="ec21772b6225bce4b19c4a5bfeaac688" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a>&lt;<a class="el" href="structiDataBuffer.html">iDataBuffer</a>&gt; csCommonImageFile::GetRawData           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the raw data of the image (or 0 if raw data is not provided). 
<p>

<p>Reimplemented from <a class="el" href="classcsImageMemory.html#090a23f2bd3cad916f8f099d3dd2eb6a">csImageMemory</a>.</p>

</div>
</div><p>
<a class="anchor" name="df390477df78180ad356ddd90fe83383"></a><!-- doxytag: member="csCommonImageFile::GetRawFormat" ref="df390477df78180ad356ddd90fe83383" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* csCommonImageFile::GetRawFormat           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a string identifying the format of the raw data of the image (or 0 if raw data is not provided). 
<p>
The format string must be compatible with that supported by <a class="el" href="structiTextureManager.html#c33a27b94680288e287279d7725303dc" title="Create a new texture with the given texture format.">iTextureManager::CreateTexture()</a>. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__gfx3d.html">Texture format strings</a> </dd></dl>

<p>Reimplemented from <a class="el" href="classcsImageMemory.html#5e78e6a1bedf5a2f652791f60a42b2aa">csImageMemory</a>.</p>

</div>
</div><p>
<a class="anchor" name="421637e134710b348c21c683e4626381"></a><!-- doxytag: member="csCommonImageFile::HasKeyColor" ref="421637e134710b348c21c683e4626381" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool csCommonImageFile::HasKeyColor           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if image has a keycolour stored with it. 
<p>

<p>Reimplemented from <a class="el" href="classcsImageMemory.html#3ac872e07d79054d064495b428669dcc">csImageMemory</a>.</p>

<p>Definition at line <a class="el" href="commonimagefile_8h-source.html#l00199">199</a> of file <a class="el" href="commonimagefile_8h-source.html">commonimagefile.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="2a641aa577cf40ac3f6ac72c00b2543e"></a><!-- doxytag: member="csCommonImageFile::InitLoader" ref="2a641aa577cf40ac3f6ac72c00b2543e" args="(csRef&lt; iDataBuffer &gt; source)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a>&lt;<a class="el" href="structiImageFileLoader.html">iImageFileLoader</a>&gt; csCommonImageFile::InitLoader           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiDataBuffer.html">iDataBuffer</a> &gt;&nbsp;</td>
          <td class="paramname"> <em>source</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a loader object, which will handle the actual loading. 
<p>
Note: the returned loader should have a proper width, height, format, data type and keycolor flag (note not the actual color) already set. 
</div>
</div><p>
<a class="anchor" name="531bf5da882815e71edbe13db0807499"></a><!-- doxytag: member="csCommonImageFile::Load" ref="531bf5da882815e71edbe13db0807499" args="(csRef&lt; iDataBuffer &gt; source)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool csCommonImageFile::Load           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiDataBuffer.html">iDataBuffer</a> &gt;&nbsp;</td>
          <td class="paramname"> <em>source</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Load an image from a data buffer. 
<p>

</div>
</div><p>
<a class="anchor" name="4e2c79442bb80b1a61e4fd6a76378350"></a><!-- doxytag: member="csCommonImageFile::MakeImageData" ref="4e2c79442bb80b1a61e4fd6a76378350" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csCommonImageFile::MakeImageData           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convert data from the loader to actual image data. 
<p>

</div>
</div><p>
<a class="anchor" name="cdffd9cd912ca79070ebadf87c87b4d8"></a><!-- doxytag: member="csCommonImageFile::WaitForJob" ref="cdffd9cd912ca79070ebadf87c87b4d8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csCommonImageFile::WaitForJob           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Wait for the current image loading job to finish. 
<p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="7b235d2da32a91ede56ac12620a05e54"></a><!-- doxytag: member="csCommonImageFile::jobQueue" ref="7b235d2da32a91ede56ac12620a05e54" 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="structiJobQueue.html">iJobQueue</a>&gt; <a class="el" href="classcsCommonImageFile.html#7b235d2da32a91ede56ac12620a05e54">csCommonImageFile::jobQueue</a><code> [mutable, protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Reference to job queue. 
<p>

<p>Definition at line <a class="el" href="commonimagefile_8h-source.html#l00169">169</a> of file <a class="el" href="commonimagefile_8h-source.html">commonimagefile.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="80a19c458ede45a9a6a7fc7a2fee8eac"></a><!-- doxytag: member="csCommonImageFile::loadJob" ref="80a19c458ede45a9a6a7fc7a2fee8eac" 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="classcsCommonImageFile_1_1LoaderJob.html">LoaderJob</a>&gt; <a class="el" href="classcsCommonImageFile.html#80a19c458ede45a9a6a7fc7a2fee8eac">csCommonImageFile::loadJob</a><code> [mutable, protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Reference to the job for loading this image. 
<p>

<p>Definition at line <a class="el" href="commonimagefile_8h-source.html#l00167">167</a> of file <a class="el" href="commonimagefile_8h-source.html">commonimagefile.h</a>.</p>

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