Rtch/Unuk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
903156c1e2
Unuk/Docs/html/class_image_loader.html
Rtch90 903156c1e2 -- [Add] Adding doxygen documentation to the docs Directory. 
-- I am too lazy to write my own documentation right now, this is what doxygen was designed for right?
2011-11-02 22:53:34 +00:00

332 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Unuk: ImageLoader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Unuk&#160;<span id="projectnumber">1.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('class_image_loader.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">ImageLoader Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="ImageLoader" -->
<p><code>#include &lt;<a class="el" href="_image_loader_8h_source.html">ImageLoader.h</a>&gt;</code></p>
<p><a href="class_image_loader-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#aff8e0ecf1611ba1c2d9f1fbf6f4efb38">ImageLoader</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#aa68025bde21fa6566ad43d04b61fa211">ImageLoader</a> (const char *filename)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#acce398271fc04e6a5ab9707d9210cb3e">~ImageLoader</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#a24fdb991574efb5d45afc1aae608f9d0">LoadBMP</a> (const char *filename)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_image_loader_8h.html#a4ae1dab0fb4b072a66584546209e7d58">BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#a216f7a6ba0bd49a673de772e0e6dca29">GetAlpha</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_image_loader_8h.html#a9154c0d0c21af4686624543215b4e5f2">LONG</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#a82df5f39b2a699ab215ae2f1c714b76e">GetHeight</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_image_loader_8h.html#ae6f8a4686bbcb20bd72057e00143b167">RGBQUAD</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#ae6e6d2dff943e9596fc16dd27a4851a0">GetColors</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#a142aaed3cf7bb654af091d215ce05091">GetLoaded</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_image_loader_8h.html#a4ae1dab0fb4b072a66584546209e7d58">BYTE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#a3a4ed52e7b28bb4f48f967de8bf702a9">GetPixelData</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_image_loader_8h.html#a9154c0d0c21af4686624543215b4e5f2">LONG</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_image_loader.html#ab673a17dd93d0a4393934afc14b86885">GetWidth</a> (void) const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="_image_loader_8h_source.html#l00045">45</a> of file <a class="el" href="_image_loader_8h_source.html">ImageLoader.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aff8e0ecf1611ba1c2d9f1fbf6f4efb38"></a><!-- doxytag: member="ImageLoader::ImageLoader" ref="aff8e0ecf1611ba1c2d9f1fbf6f4efb38" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ImageLoader::ImageLoader </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8cpp_source.html#l00009">9</a> of file <a class="el" href="_image_loader_8cpp_source.html">ImageLoader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa68025bde21fa6566ad43d04b61fa211"></a><!-- doxytag: member="ImageLoader::ImageLoader" ref="aa68025bde21fa6566ad43d04b61fa211" args="(const char *filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ImageLoader::ImageLoader </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8cpp_source.html#l00014">14</a> of file <a class="el" href="_image_loader_8cpp_source.html">ImageLoader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acce398271fc04e6a5ab9707d9210cb3e"></a><!-- doxytag: member="ImageLoader::~ImageLoader" ref="acce398271fc04e6a5ab9707d9210cb3e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ImageLoader::~ImageLoader </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8cpp_source.html#l00019">19</a> of file <a class="el" href="_image_loader_8cpp_source.html">ImageLoader.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a216f7a6ba0bd49a673de772e0e6dca29"></a><!-- doxytag: member="ImageLoader::GetAlpha" ref="a216f7a6ba0bd49a673de772e0e6dca29" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_image_loader_8h.html#a4ae1dab0fb4b072a66584546209e7d58">BYTE</a> * ImageLoader::GetAlpha </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8cpp_source.html#l00164">164</a> of file <a class="el" href="_image_loader_8cpp_source.html">ImageLoader.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae6e6d2dff943e9596fc16dd27a4851a0"></a><!-- doxytag: member="ImageLoader::GetColors" ref="ae6e6d2dff943e9596fc16dd27a4851a0" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_image_loader_8h.html#ae6f8a4686bbcb20bd72057e00143b167">RGBQUAD</a>* ImageLoader::GetColors </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8h_source.html#l00056">56</a> of file <a class="el" href="_image_loader_8h_source.html">ImageLoader.h</a>.</p>
</div>
</div>
<a class="anchor" id="a82df5f39b2a699ab215ae2f1c714b76e"></a><!-- doxytag: member="ImageLoader::GetHeight" ref="a82df5f39b2a699ab215ae2f1c714b76e" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_image_loader_8h.html#a9154c0d0c21af4686624543215b4e5f2">LONG</a> ImageLoader::GetHeight </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8h_source.html#l00055">55</a> of file <a class="el" href="_image_loader_8h_source.html">ImageLoader.h</a>.</p>
</div>
</div>
<a class="anchor" id="a142aaed3cf7bb654af091d215ce05091"></a><!-- doxytag: member="ImageLoader::GetLoaded" ref="a142aaed3cf7bb654af091d215ce05091" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ImageLoader::GetLoaded </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8h_source.html#l00057">57</a> of file <a class="el" href="_image_loader_8h_source.html">ImageLoader.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3a4ed52e7b28bb4f48f967de8bf702a9"></a><!-- doxytag: member="ImageLoader::GetPixelData" ref="a3a4ed52e7b28bb4f48f967de8bf702a9" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_image_loader_8h.html#a4ae1dab0fb4b072a66584546209e7d58">BYTE</a>* ImageLoader::GetPixelData </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8h_source.html#l00058">58</a> of file <a class="el" href="_image_loader_8h_source.html">ImageLoader.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab673a17dd93d0a4393934afc14b86885"></a><!-- doxytag: member="ImageLoader::GetWidth" ref="ab673a17dd93d0a4393934afc14b86885" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_image_loader_8h.html#a9154c0d0c21af4686624543215b4e5f2">LONG</a> ImageLoader::GetWidth </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8h_source.html#l00059">59</a> of file <a class="el" href="_image_loader_8h_source.html">ImageLoader.h</a>.</p>
</div>
</div>
<a class="anchor" id="a24fdb991574efb5d45afc1aae608f9d0"></a><!-- doxytag: member="ImageLoader::LoadBMP" ref="a24fdb991574efb5d45afc1aae608f9d0" args="(const char *filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ImageLoader::LoadBMP </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_image_loader_8cpp_source.html#l00029">29</a> of file <a class="el" href="_image_loader_8cpp_source.html">ImageLoader.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/libUnuk/<a class="el" href="_image_loader_8h_source.html">ImageLoader.h</a></li>
<li>src/libUnuk/<a class="el" href="_image_loader_8cpp_source.html">ImageLoader.cpp</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="class_image_loader.html">ImageLoader</a> </li>
<li class="footer">Generated on Wed Nov 2 2011 22:46:25 for Unuk by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink