maj/OpenArena
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
74933be888e044ae560859d7b09a6d3cb3292ae6
OpenArena/doc/html/class_open_arena_1_1_image.html
Tom Hicks fdc4f9e0ce *** empty log message ***
2006-07-19 00:03:26 -04:00

308 lines
16 KiB
HTML
Raw Blame History

<!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>OpenArena: OpenArena::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&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="annotated.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="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="namespace_open_arena.html">OpenArena</a>::<a class="el" href="class_open_arena_1_1_image.html">Image</a></div>
<h1>OpenArena::Image Class Reference</h1><!-- doxytag: class="OpenArena::Image" -->Write brief comment for <a class="el" href="class_open_arena_1_1_image.html">Image</a> here.
<a href="#_details">More...</a>
<p>
<code>#include &lt;image.h&gt;</code>
<p>
<a href="class_open_arena_1_1_image-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_image.html#ca37f2ad5dd96e2859831f1906bad38fda51471d353b3637e396865d74d257f6">Type_RGB</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_image.html#ca37f2ad5dd96e2859831f1906bad38f">Type</a> { <a class="el" href="class_open_arena_1_1_image.html#ca37f2ad5dd96e2859831f1906bad38fda51471d353b3637e396865d74d257f6">Type_RGB</a>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint8 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_image.html#4e42b3c49bf88e31c50029664e3604b9">GetImageData</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for GetImageData here. <a href="#4e42b3c49bf88e31c50029664e3604b9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_image.html#9e2571d03127a4b8ea677952e46b10eb">GetBitsPerPixel</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for GetBitsPerPixel here. <a href="#9e2571d03127a4b8ea677952e46b10eb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_image.html#37073327914dd416fd86f57cdca62502">GetBytesPerPixel</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for GetBytesPerPixel here. <a href="#37073327914dd416fd86f57cdca62502"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_image.html#ea45a60931d45196828269ed70f87bbc">GetWidth</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for GetWidth here. <a href="#ea45a60931d45196828269ed70f87bbc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_image.html#c3d4fbafd28103aafdb20d8b222fe1ba">GetHeight</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for GetHeight here. <a href="#c3d4fbafd28103aafdb20d8b222fe1ba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_open_arena_1_1_image.html#ca37f2ad5dd96e2859831f1906bad38f">Image::Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_image.html#65f02cae03bc870e9781f87ddde10b85">GetType</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for GetType here. <a href="#65f02cae03bc870e9781f87ddde10b85"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_image.html#387e4530a6408fce279a6c19fad64584">~Image</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for ~Image here. <a href="#387e4530a6408fce279a6c19fad64584"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Write brief comment for <a class="el" href="class_open_arena_1_1_image.html">Image</a> here.
<p>
Write detailed description for <a class="el" href="class_open_arena_1_1_image.html">Image</a> here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for <a class="el" href="class_open_arena_1_1_image.html">Image</a> here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="ca37f2ad5dd96e2859831f1906bad38f"></a><!-- doxytag: member="OpenArena::Image::Type" ref="ca37f2ad5dd96e2859831f1906bad38f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_open_arena_1_1_image.html#ca37f2ad5dd96e2859831f1906bad38f">OpenArena::Image::Type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="ca37f2ad5dd96e2859831f1906bad38fda51471d353b3637e396865d74d257f6"></a><!-- doxytag: member="Type_RGB" ref="ca37f2ad5dd96e2859831f1906bad38fda51471d353b3637e396865d74d257f6" args="" -->Type_RGB</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="387e4530a6408fce279a6c19fad64584"></a><!-- doxytag: member="OpenArena::Image::~Image" ref="387e4530a6408fce279a6c19fad64584" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OpenArena::Image::~Image </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write brief comment for ~Image here.
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for ~Image here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for ~Image here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9e2571d03127a4b8ea677952e46b10eb"></a><!-- doxytag: member="OpenArena::Image::GetBitsPerPixel" ref="9e2571d03127a4b8ea677952e46b10eb" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint32 OpenArena::Image::GetBitsPerPixel </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write brief comment for GetBitsPerPixel here.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for GetBitsPerPixel here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for GetBitsPerPixel here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
</div>
</div><p>
<a class="anchor" name="37073327914dd416fd86f57cdca62502"></a><!-- doxytag: member="OpenArena::Image::GetBytesPerPixel" ref="37073327914dd416fd86f57cdca62502" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint32 OpenArena::Image::GetBytesPerPixel </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write brief comment for GetBytesPerPixel here.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for GetBytesPerPixel here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for GetBytesPerPixel here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c3d4fbafd28103aafdb20d8b222fe1ba"></a><!-- doxytag: member="OpenArena::Image::GetHeight" ref="c3d4fbafd28103aafdb20d8b222fe1ba" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint32 OpenArena::Image::GetHeight </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write brief comment for GetHeight here.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for GetHeight here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for GetHeight here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4e42b3c49bf88e31c50029664e3604b9"></a><!-- doxytag: member="OpenArena::Image::GetImageData" ref="4e42b3c49bf88e31c50029664e3604b9" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint8* OpenArena::Image::GetImageData </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write brief comment for GetImageData here.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for GetImageData here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for GetImageData here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
</div>
</div><p>
<a class="anchor" name="65f02cae03bc870e9781f87ddde10b85"></a><!-- doxytag: member="OpenArena::Image::GetType" ref="65f02cae03bc870e9781f87ddde10b85" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_open_arena_1_1_image.html#ca37f2ad5dd96e2859831f1906bad38f">Image::Type</a> OpenArena::Image::GetType </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write brief comment for GetType here.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for GetType here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for GetType here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ea45a60931d45196828269ed70f87bbc"></a><!-- doxytag: member="OpenArena::Image::GetWidth" ref="ea45a60931d45196828269ed70f87bbc" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual uint32 OpenArena::Image::GetWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write brief comment for GetWidth here.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for GetWidth here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for GetWidth here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="image_8h.html">image.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jul 11 00:17:53 2006 for OpenArena 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>
Reference in New Issue View Git Blame Copy Permalink