<!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: Image 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 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 List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="a00168.html">SILLY</a>::<a class="el" href="a00115.html">Image</a></div>
<h1>Image Class Reference</h1><!-- doxytag: class="SILLY::Image" --><a class="el" href="a00115.html">Image</a> is the main user class of the library.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="a00190.html">SILLYImage.h</a>></code>
<p>
Collaboration diagram for Image:<p><center><img src="a00230.png" border="0" usemap="#a00231" alt="Collaboration graph"></center>
<map name="a00231">
<area href="a00116.html" shape="rect" coords="221,144,339,171" alt="">
<area href="a00113.html" shape="rect" coords="96,144,197,171" alt="">
<area href="a00117.html" shape="rect" coords="601,144,711,171" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="a00009.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"><a class="anchor" name="eb0ccdda69dac79dcc96f1ebe4159973"></a><!-- doxytag: member="SILLY::Image::getHeight" ref="eb0ccdda69dac79dcc96f1ebe4159973" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#eb0ccdda69dac79dcc96f1ebe4159973">getHeight</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the height of the image. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35278db5914ad42324d33f68971e120e"></a><!-- doxytag: member="SILLY::Image::getLoaderIdentifierString" ref="35278db5914ad42324d33f68971e120e" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#35278db5914ad42324d33f68971e120e">getLoaderIdentifierString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="a00115.html">Image</a> loader identifier string. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a5d71d922f45a80df2954f99f0dce79"></a><!-- doxytag: member="SILLY::Image::getPixelFormat" ref="4a5d71d922f45a80df2954f99f0dce79" args="() const " -->
<a class="el" href="a00168.html#2f8e63a7cc51f96526c3e81712b64890">PixelFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#4a5d71d922f45a80df2954f99f0dce79">getPixelFormat</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the pixel format of the resulting image. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d464b413abda80f6e0fa05861f71fe0"></a><!-- doxytag: member="SILLY::Image::getPixelsDataPtr" ref="7d464b413abda80f6e0fa05861f71fe0" args="() const " -->
const <a class="el" href="a00168.html#ea185528b70b44efcecbc49855184018">byte</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#7d464b413abda80f6e0fa05861f71fe0">getPixelsDataPtr</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to the pixels data. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="19e099a2d0f7135fb9fd6c50988d8618"></a><!-- doxytag: member="SILLY::Image::getPixelsDataSize" ref="19e099a2d0f7135fb9fd6c50988d8618" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#19e099a2d0f7135fb9fd6c50988d8618">getPixelsDataSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the pixel buffer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ebda0606441ab730297ff49c8fb02c9"></a><!-- doxytag: member="SILLY::Image::getSourcePixelFormat" ref="1ebda0606441ab730297ff49c8fb02c9" args="() const " -->
<a class="el" href="a00168.html#2f8e63a7cc51f96526c3e81712b64890">PixelFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#1ebda0606441ab730297ff49c8fb02c9">getSourcePixelFormat</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the pixel format used for the image storage. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a631da5da7b11ecc0723a48501ae91c6"></a><!-- doxytag: member="SILLY::Image::getWidth" ref="a631da5da7b11ecc0723a48501ae91c6" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#a631da5da7b11ecc0723a48501ae91c6">getWidth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the width of the image. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#668ba7dad51196c9a018ab8719ba6c03">Image</a> (<a class="el" href="a00113.html">DataSource</a> &data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#668ba7dad51196c9a018ab8719ba6c03"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1bc549fe21f279f77205855d40b60007"></a><!-- doxytag: member="SILLY::Image::isValid" ref="1bc549fe21f279f77205855d40b60007" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#1bc549fe21f279f77205855d40b60007">isValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if the image is valid after its loading. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#db6acb75585a0f95523251627e57b0de">loadImageData</a> (<a class="el" href="a00168.html#2f8e63a7cc51f96526c3e81712b64890">PixelFormat</a> resultFormat=PF_RGBA, <a class="el" href="a00168.html#591746ccd8c678870692cbf1cb302d6a">PixelOrigin</a> origin=PO_TOP_LEFT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the image pixels in memory and store them in <em>resultFormat</em>. <a href="#db6acb75585a0f95523251627e57b0de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#28349e7e34acceea10583e9b93fcdd13">loadImageHeader</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the information concerning the image object. <a href="#28349e7e34acceea10583e9b93fcdd13"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7762f31d69c67f2a027d7fe106497f7c"></a><!-- doxytag: member="SILLY::Image::~Image" ref="7762f31d69c67f2a027d7fe106497f7c" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00115.html#7762f31d69c67f2a027d7fe106497f7c">~Image</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="a00115.html">Image</a> is the main user class of the library.
<p>
<p>
Definition at line <a class="el" href="a00190.html#l00046">46</a> of file <a class="el" href="a00190.html">SILLYImage.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="668ba7dad51196c9a018ab8719ba6c03"></a><!-- doxytag: member="SILLY::Image::Image" ref="668ba7dad51196c9a018ab8719ba6c03" args="(DataSource &data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00115.html">Image</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00113.html">DataSource</a> & </td>
<td class="paramname"> <em>data</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<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>data</em> </td><td>the raw input containing the image </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="a00209.html#l00048">48</a> of file <a class="el" href="a00209.html">SILLYImage.cpp</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="db6acb75585a0f95523251627e57b0de"></a><!-- doxytag: member="SILLY::Image::loadImageData" ref="db6acb75585a0f95523251627e57b0de" args="(PixelFormat resultFormat=PF_RGBA, PixelOrigin origin=PO_TOP_LEFT)" -->
<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#2f8e63a7cc51f96526c3e81712b64890">PixelFormat</a> </td>
<td class="paramname"> <em>resultFormat</em> = <code>PF_RGBA</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00168.html#591746ccd8c678870692cbf1cb302d6a">PixelOrigin</a> </td>
<td class="paramname"> <em>origin</em> = <code>PO_TOP_LEFT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load the image pixels in memory and store them in <em>resultFormat</em>.
<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>resultFormat</em> </td><td>the pixel format to be used for storing the result</td></tr>
<tr><td valign="top"></td><td valign="top"><em>origin</em> </td><td>expected origin position for the pixels</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true on success false if an error occured</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>this function can be called several time if the pixel format are different the format is reloaded </dd></dl>
<p>
Definition at line <a class="el" href="a00209.html#l00068">68</a> of file <a class="el" href="a00209.html">SILLYImage.cpp</a>.
</div>
</div><p>
<a class="anchor" name="28349e7e34acceea10583e9b93fcdd13"></a><!-- doxytag: member="SILLY::Image::loadImageHeader" ref="28349e7e34acceea10583e9b93fcdd13" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool loadImageHeader </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the information concerning the image object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
<p>
Definition at line <a class="el" href="a00209.html#l00054">54</a> of file <a class="el" href="a00209.html">SILLYImage.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/<a class="el" href="a00190.html">SILLYImage.h</a><li>/home/paul/dev/cegui/release_tmp/release_tmp/src/<a class="el" href="a00209.html">SILLYImage.cpp</a><li>/home/paul/dev/cegui/release_tmp/release_tmp/include/<a class="el" href="a00191.html">SILLYImage.icpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 5 14:38:43 2006 for Simple Image Loading LibrarY by
<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>
