Files
OpenArena/doc/xml/class_open_arena_1_1_video_plugin.xml
2006-07-19 00:15:26 -04:00

165 lines
8.6 KiB
XML

<?xml version='1.0' encoding='iso-8859-1' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.4.7">
<compounddef id="class_open_arena_1_1_video_plugin" kind="class" prot="public">
<compoundname>OpenArena::VideoPlugin</compoundname>
<basecompoundref refid="class_open_arena_1_1_plugin" prot="public" virt="non-virtual">OpenArena::Plugin</basecompoundref>
<derivedcompoundref refid="class_open_arena_1_1_null_video_plugin" prot="public" virt="non-virtual">OpenArena::NullVideoPlugin</derivedcompoundref>
<includes local="no">VideoPlugin.h</includes>
<sectiondef kind="public-func">
<memberdef kind="function" id="class_open_arena_1_1_video_plugin_11254366f2b63b23cb7cbd18bd14aedcd" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
<type>virtual</type>
<definition>virtual OpenArena::VideoPlugin::~VideoPlugin</definition>
<argsstring>()</argsstring>
<name>~VideoPlugin</name>
<briefdescription>
<para>Write brief comment for ~VideoPlugin here. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="exception"><parameteritem>
<parameternamelist>
<parametername>&lt;exception</parametername>
</parameternamelist>
<parameterdescription>
<para>class&gt; Description of criteria for throwing this exception.</para></parameterdescription>
</parameteritem>
</parameterlist>
Write detailed description for ~VideoPlugin here.</para><para><simplesect kind="remark"><para>Write remarks for ~VideoPlugin here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/VideoPlugin.h" line="39" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/VideoPlugin.h" bodystart="39" bodyend="39"/>
</memberdef>
<memberdef kind="function" id="class_open_arena_1_1_video_plugin_1954e14695396e3c6d20dc4dddd864a44" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
<type><ref refid="class_open_arena_1_1_window" kindref="compound">Window</ref> *</type>
<definition>virtual Window* OpenArena::VideoPlugin::CreateNewWindow</definition>
<argsstring>(uint32 width, uint32 height, uint32 bpp=32, bool fullscreen=false, const char *title=NULL)=0</argsstring>
<name>CreateNewWindow</name>
<reimplementedby refid="class_open_arena_1_1_null_video_plugin_1313039d35ab592784bda75c90c53317c">CreateNewWindow</reimplementedby>
<param>
<type>uint32</type>
<declname>width</declname>
</param>
<param>
<type>uint32</type>
<declname>height</declname>
</param>
<param>
<type>uint32</type>
<declname>bpp</declname>
<defval>32</defval>
</param>
<param>
<type>bool</type>
<declname>fullscreen</declname>
<defval>false</defval>
</param>
<param>
<type>const char *</type>
<declname>title</declname>
<defval>NULL</defval>
</param>
<briefdescription>
<para>Write brief comment for CreateNewWindow here. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>width</parametername>
</parameternamelist>
<parameterdescription>
<para>Description of parameter width.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>height</parametername>
</parameternamelist>
<parameterdescription>
<para>Description of parameter height.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>bpp</parametername>
</parameternamelist>
<parameterdescription>
<para>Description of parameter bpp.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>fullscreen</parametername>
</parameternamelist>
<parameterdescription>
<para>Description of parameter fullscreen.</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>title</parametername>
</parameternamelist>
<parameterdescription>
<para>Description of parameter title.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>Write description of return value here.</para></simplesect>
<parameterlist kind="exception"><parameteritem>
<parameternamelist>
<parametername>&lt;exception</parametername>
</parameternamelist>
<parameterdescription>
<para>class&gt; Description of criteria for throwing this exception.</para></parameterdescription>
</parameteritem>
</parameterlist>
Write detailed description for CreateNewWindow here.</para><para><simplesect kind="remark"><para>Write remarks for CreateNewWindow here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/VideoPlugin.h" line="77"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Write brief comment for <ref refid="class_open_arena_1_1_video_plugin" kindref="compound">VideoPlugin</ref> here. </para> </briefdescription>
<detaileddescription>
<para>Write detailed description for <ref refid="class_open_arena_1_1_video_plugin" kindref="compound">VideoPlugin</ref> here.</para><para><simplesect kind="remark"><para>Write remarks for <ref refid="class_open_arena_1_1_video_plugin" kindref="compound">VideoPlugin</ref> here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para> </detaileddescription>
<inheritancegraph>
<node id="84">
<label>OpenArena::NullVideoPlugin</label>
<link refid="class_open_arena_1_1_null_video_plugin"/>
<childnode refid="82" relation="public-inheritance">
</childnode>
</node>
<node id="82">
<label>OpenArena::VideoPlugin</label>
<link refid="class_open_arena_1_1_video_plugin"/>
<childnode refid="83" relation="public-inheritance">
</childnode>
</node>
<node id="83">
<label>OpenArena::Plugin</label>
<link refid="class_open_arena_1_1_plugin"/>
</node>
</inheritancegraph>
<collaborationgraph>
<node id="85">
<label>OpenArena::VideoPlugin</label>
<link refid="class_open_arena_1_1_video_plugin"/>
<childnode refid="86" relation="public-inheritance">
</childnode>
</node>
<node id="86">
<label>OpenArena::Plugin</label>
<link refid="class_open_arena_1_1_plugin"/>
</node>
</collaborationgraph>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/VideoPlugin.h" line="21" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/VideoPlugin.h" bodystart="20" bodyend="78"/>
<listofallmembers>
<member refid="class_open_arena_1_1_plugin_14db1c9624c3894a5ef2220bfaf6c00e4f7e7f2ab39f985ac95d238558f6cda54" prot="public" virt="non-virtual"><scope>OpenArena::VideoPlugin</scope><name>AudioPlugin</name></member>
<member refid="class_open_arena_1_1_video_plugin_1954e14695396e3c6d20dc4dddd864a44" prot="public" virt="pure-virtual"><scope>OpenArena::VideoPlugin</scope><name>CreateNewWindow</name></member>
<member refid="class_open_arena_1_1_plugin_14db1c9624c3894a5ef2220bfaf6c00e427fac2aa3af683e6840a1a7a8cca5766" prot="public" virt="non-virtual"><scope>OpenArena::VideoPlugin</scope><name>InputPlugin</name></member>
<member refid="class_open_arena_1_1_plugin_14db1c9624c3894a5ef2220bfaf6c00e4" prot="public" virt="non-virtual"><scope>OpenArena::VideoPlugin</scope><name>Type</name></member>
<member refid="class_open_arena_1_1_plugin_14db1c9624c3894a5ef2220bfaf6c00e49f71439bc4ee268dd64321426aa8b40c" prot="public" virt="non-virtual"><scope>OpenArena::VideoPlugin</scope><name>VideoPlugin</name></member>
<member refid="class_open_arena_1_1_plugin_10fd911031b5c842b099d767e07a3b6d2" prot="public" virt="virtual"><scope>OpenArena::VideoPlugin</scope><name>~Plugin</name></member>
<member refid="class_open_arena_1_1_video_plugin_11254366f2b63b23cb7cbd18bd14aedcd" prot="public" virt="virtual"><scope>OpenArena::VideoPlugin</scope><name>~VideoPlugin</name></member>
</listofallmembers>
</compounddef>
</doxygen>