Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 4163dd693a738ea142308d7e6e658e9c > files > 46

SILLY-devel-0.1.0-7.fc12.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Simple Image Loading LibrarY: PNGImageLoader Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</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>
<div class="nav">
<a class="el" href="a00168.html">SILLY</a>::<a class="el" href="a00123.html">PNGImageLoader</a></div>
<h1>PNGImageLoader Class Reference</h1><!-- doxytag: class="SILLY::PNGImageLoader" --><!-- doxytag: inherits="SILLY::ImageLoader" -->Loader for PNG <a class="el" href="a00115.html">Image</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="a00178.html">SILLYPNGImageLoader.h</a>&gt;</code>
<p>
Inheritance diagram for PNGImageLoader:<p><center><img src="a00258.png" border="0" usemap="#a00259" alt="Inheritance graph"></center>
<map name="a00259">
<area href="a00117.html" shape="rect" coords="20,5,129,32" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for PNGImageLoader:<p><center><img src="a00260.png" border="0" usemap="#a00261" alt="Collaboration graph"></center>
<map name="a00261">
<area href="a00117.html" shape="rect" coords="20,96,129,123" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="a00004.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="a00117.html#231c0d4600e6c023f61bbdd7dfa9ddda">destroyContext</a> (<a class="el" href="a00116.html">ImageContext</a> *context)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy the image context.  <a href="#231c0d4600e6c023f61bbdd7dfa9ddda"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a41c5aea136e098a823fd5a7f0685d6"></a><!-- doxytag: member="SILLY::PNGImageLoader::getIdentifierString" ref="7a41c5aea136e098a823fd5a7f0685d6" args="() const " -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00117.html#7a41c5aea136e098a823fd5a7f0685d6">getIdentifierString</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the name of the loader. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00116.html">ImageContext</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00123.html#4f11ee7a4608e00c76388a3f13a718a1">loadHeader</a> (<a class="el" href="a00168.html#2f8e63a7cc51f96526c3e81712b64890">PixelFormat</a> &amp;formatSource, <a class="el" href="a00113.html">DataSource</a> *data)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse the header of the image and fill the header struct.  <a href="#4f11ee7a4608e00c76388a3f13a718a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00123.html#aaadc333060f75e71f11a89128d9a350">loadImageData</a> (<a class="el" href="a00168.html#591746ccd8c678870692cbf1cb302d6a">PixelOrigin</a> origin, <a class="el" href="a00113.html">DataSource</a> *data, <a class="el" href="a00116.html">ImageContext</a> *context)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse the pixels data of the image and fill the header struct.  <a href="#aaadc333060f75e71f11a89128d9a350"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0168121ae72ab968bf3ac497fc76951"></a><!-- doxytag: member="SILLY::PNGImageLoader::PNGImageLoader" ref="c0168121ae72ab968bf3ac497fc76951" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00123.html#c0168121ae72ab968bf3ac497fc76951">PNGImageLoader</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9968fdc5f7536636d8ed02e4e8924861"></a><!-- doxytag: member="SILLY::PNGImageLoader::~PNGImageLoader" ref="9968fdc5f7536636d8ed02e4e8924861" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00123.html#9968fdc5f7536636d8ed02e4e8924861">~PNGImageLoader</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Loader for PNG <a class="el" href="a00115.html">Image</a>. 
<p>

<p>
Definition at line <a class="el" href="a00178.html#l00042">42</a> of file <a class="el" href="a00178.html">SILLYPNGImageLoader.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="231c0d4600e6c023f61bbdd7dfa9ddda"></a><!-- doxytag: member="SILLY::PNGImageLoader::destroyContext" ref="231c0d4600e6c023f61bbdd7dfa9ddda" args="(ImageContext *context)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void destroyContext           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00116.html">ImageContext</a> *&nbsp;</td>
          <td class="paramname"> <em>context</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inherited]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destroy the image context. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>a pointer to the context </td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a00211.html#l00047">47</a> of file <a class="el" href="a00211.html">SILLYImageLoader.cpp</a>.
</div>
</div><p>
<a class="anchor" name="4f11ee7a4608e00c76388a3f13a718a1"></a><!-- doxytag: member="SILLY::PNGImageLoader::loadHeader" ref="4f11ee7a4608e00c76388a3f13a718a1" args="(PixelFormat &amp;formatSource, DataSource *data)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00116.html">ImageContext</a> * loadHeader           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00168.html#2f8e63a7cc51f96526c3e81712b64890">PixelFormat</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>formatSource</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00113.html">DataSource</a> *&nbsp;</td>
          <td class="paramname"> <em>data</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>
Parse the header of the image and fill the header struct. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>formatSource</em>&nbsp;</td><td>this var should contains the pixel format used to store the image initialy</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the input of the image data</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Context for the rest of the parsing or 0 if an error occured </dd></dl>

<p>
Implements <a class="el" href="a00117.html#073e8dfd4da7ffd43d29345cc2cec8e2">ImageLoader</a>.
<p>
Definition at line <a class="el" href="a00204.html#l00083">83</a> of file <a class="el" href="a00204.html">SILLYPNGImageLoader.cpp</a>.
</div>
</div><p>
<a class="anchor" name="aaadc333060f75e71f11a89128d9a350"></a><!-- doxytag: member="SILLY::PNGImageLoader::loadImageData" ref="aaadc333060f75e71f11a89128d9a350" args="(PixelOrigin origin, DataSource *data, ImageContext *context)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool loadImageData           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00168.html#591746ccd8c678870692cbf1cb302d6a">PixelOrigin</a>&nbsp;</td>
          <td class="paramname"> <em>origin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00113.html">DataSource</a> *&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00116.html">ImageContext</a> *&nbsp;</td>
          <td class="paramname"> <em>context</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>
Parse the pixels data of the image and fill the header struct. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>origin</em>&nbsp;</td><td>the layout of the pixel in the resulting pixel array</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the input of the image data</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>the data associated to the image parsing</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true on success false on error </dd></dl>

<p>
Implements <a class="el" href="a00117.html#74b19c12550e24d34217721f23bbce42">ImageLoader</a>.
<p>
Definition at line <a class="el" href="a00204.html#l00149">149</a> of file <a class="el" href="a00204.html">SILLYPNGImageLoader.cpp</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>/home/paul/dev/cegui/release_tmp/release_tmp/include/loaders/<a class="el" href="a00178.html">SILLYPNGImageLoader.h</a><li>/home/paul/dev/cegui/release_tmp/release_tmp/src/loaders/<a class="el" href="a00204.html">SILLYPNGImageLoader.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 5 14:38:46 2006 for Simple Image Loading LibrarY by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>