Files
OpenArena/doc/html/class_open_arena_1_1_video_plugin.html
2006-07-19 00:03:26 -04:00

159 lines
8.4 KiB
HTML

<!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::VideoPlugin 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_video_plugin.html">VideoPlugin</a></div>
<h1>OpenArena::VideoPlugin Class Reference</h1><!-- doxytag: class="OpenArena::VideoPlugin" --><!-- doxytag: inherits="OpenArena::Plugin" -->Write brief comment for <a class="el" href="class_open_arena_1_1_video_plugin.html">VideoPlugin</a> here.
<a href="#_details">More...</a>
<p>
<code>#include &lt;VideoPlugin.h&gt;</code>
<p>
<p>Inheritance diagram for OpenArena::VideoPlugin:
<p><center><img src="class_open_arena_1_1_video_plugin.png" usemap="#OpenArena::VideoPlugin_map" border="0" alt=""></center>
<map name="OpenArena::VideoPlugin_map">
<area href="class_open_arena_1_1_plugin.html" alt="OpenArena::Plugin" shape="rect" coords="0,0,174,24">
<area href="class_open_arena_1_1_null_video_plugin.html" alt="OpenArena::NullVideoPlugin" shape="rect" coords="0,112,174,136">
</map>
<a href="class_open_arena_1_1_video_plugin-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 Member Functions</h2></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_video_plugin.html#1254366f2b63b23cb7cbd18bd14aedcd">~VideoPlugin</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for ~VideoPlugin here. <a href="#1254366f2b63b23cb7cbd18bd14aedcd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_open_arena_1_1_window.html">Window</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_video_plugin.html#954e14695396e3c6d20dc4dddd864a44">CreateNewWindow</a> (uint32 width, uint32 height, uint32 bpp=32, bool <a class="el" href="main_8h.html#5a9147cb82d1cbeefadd62beb9e6910b">fullscreen</a>=false, const char *title=NULL)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for CreateNewWindow here. <a href="#954e14695396e3c6d20dc4dddd864a44"></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_video_plugin.html">VideoPlugin</a> here.
<p>
Write detailed description for <a class="el" href="class_open_arena_1_1_video_plugin.html">VideoPlugin</a> here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for <a class="el" href="class_open_arena_1_1_video_plugin.html">VideoPlugin</a> here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="1254366f2b63b23cb7cbd18bd14aedcd"></a><!-- doxytag: member="OpenArena::VideoPlugin::~VideoPlugin" ref="1254366f2b63b23cb7cbd18bd14aedcd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OpenArena::VideoPlugin::~VideoPlugin </td>
<td>(</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 ~VideoPlugin 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 ~VideoPlugin here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for ~VideoPlugin 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="954e14695396e3c6d20dc4dddd864a44"></a><!-- doxytag: member="OpenArena::VideoPlugin::CreateNewWindow" ref="954e14695396e3c6d20dc4dddd864a44" args="(uint32 width, uint32 height, uint32 bpp=32, bool fullscreen=false, const char *title=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_open_arena_1_1_window.html">Window</a>* OpenArena::VideoPlugin::CreateNewWindow </td>
<td>(</td>
<td class="paramtype">uint32&nbsp;</td>
<td class="paramname"> <em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32&nbsp;</td>
<td class="paramname"> <em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32&nbsp;</td>
<td class="paramname"> <em>bpp</em> = <code>32</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>fullscreen</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>title</em> = <code>NULL</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write brief comment for CreateNewWindow here.
<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>width</em>&nbsp;</td><td>Description of parameter width.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>height</em>&nbsp;</td><td>Description of parameter height.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>bpp</em>&nbsp;</td><td>Description of parameter bpp.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>fullscreen</em>&nbsp;</td><td>Description of parameter fullscreen.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>title</em>&nbsp;</td><td>Description of parameter title.</td></tr>
</table>
</dl>
<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 CreateNewWindow here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for CreateNewWindow here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<p>
Implemented in <a class="el" href="class_open_arena_1_1_null_video_plugin.html#313039d35ab592784bda75c90c53317c">OpenArena::NullVideoPlugin</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="_video_plugin_8h.html">VideoPlugin.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jul 11 00:17:59 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>