OpenArena/doc/xml/class_open_arena_1_1_image.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_image" kind="class" prot="public">
    <compoundname>OpenArena::Image</compoundname>
    <includes local="no">image.h</includes>
      <sectiondef kind="public-type">
      <memberdef kind="enum" id="class_open_arena_1_1_image_1ca37f2ad5dd96e2859831f1906bad38f" prot="public" static="no">
        <name>Type</name>
        <enumvalue id="class_open_arena_1_1_image_1ca37f2ad5dd96e2859831f1906bad38fda51471d353b3637e396865d74d257f6" prot="public">
          <name>Type_RGB</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/image.h" line="23" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/image.h" bodystart="23" bodyend="23"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="class_open_arena_1_1_image_14e42b3c49bf88e31c50029664e3604b9" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
        <type>uint8 *</type>
        <definition>virtual uint8* OpenArena::Image::GetImageData</definition>
        <argsstring>() const =0</argsstring>
        <name>GetImageData</name>
        <briefdescription>
<para>Write brief comment for GetImageData here. </para>        </briefdescription>
        <detaileddescription>
<para><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 GetImageData here.</para><para><simplesect kind="remark"><para>Write remarks for GetImageData 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/image.h" line="42"/>
      </memberdef>
      <memberdef kind="function" id="class_open_arena_1_1_image_19e2571d03127a4b8ea677952e46b10eb" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
        <type>uint32</type>
        <definition>virtual uint32 OpenArena::Image::GetBitsPerPixel</definition>
        <argsstring>() const =0</argsstring>
        <name>GetBitsPerPixel</name>
        <briefdescription>
<para>Write brief comment for GetBitsPerPixel here. </para>        </briefdescription>
        <detaileddescription>
<para><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 GetBitsPerPixel here.</para><para><simplesect kind="remark"><para>Write remarks for GetBitsPerPixel 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/image.h" line="61"/>
      </memberdef>
      <memberdef kind="function" id="class_open_arena_1_1_image_137073327914dd416fd86f57cdca62502" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
        <type>uint32</type>
        <definition>virtual uint32 OpenArena::Image::GetBytesPerPixel</definition>
        <argsstring>() const =0</argsstring>
        <name>GetBytesPerPixel</name>
        <briefdescription>
<para>Write brief comment for GetBytesPerPixel here. </para>        </briefdescription>
        <detaileddescription>
<para><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 GetBytesPerPixel here.</para><para><simplesect kind="remark"><para>Write remarks for GetBytesPerPixel 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/image.h" line="80"/>
      </memberdef>
      <memberdef kind="function" id="class_open_arena_1_1_image_1ea45a60931d45196828269ed70f87bbc" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
        <type>uint32</type>
        <definition>virtual uint32 OpenArena::Image::GetWidth</definition>
        <argsstring>() const =0</argsstring>
        <name>GetWidth</name>
        <briefdescription>
<para>Write brief comment for GetWidth here. </para>        </briefdescription>
        <detaileddescription>
<para><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 GetWidth here.</para><para><simplesect kind="remark"><para>Write remarks for GetWidth 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/image.h" line="99"/>
      </memberdef>
      <memberdef kind="function" id="class_open_arena_1_1_image_1c3d4fbafd28103aafdb20d8b222fe1ba" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
        <type>uint32</type>
        <definition>virtual uint32 OpenArena::Image::GetHeight</definition>
        <argsstring>() const =0</argsstring>
        <name>GetHeight</name>
        <briefdescription>
<para>Write brief comment for GetHeight here. </para>        </briefdescription>
        <detaileddescription>
<para><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 GetHeight here.</para><para><simplesect kind="remark"><para>Write remarks for GetHeight 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/image.h" line="118"/>
      </memberdef>
      <memberdef kind="function" id="class_open_arena_1_1_image_165f02cae03bc870e9781f87ddde10b85" prot="public" static="no" const="yes" explicit="no" inline="no" virt="pure-virtual">
        <type><ref refid="class_open_arena_1_1_image_1ca37f2ad5dd96e2859831f1906bad38f" kindref="member">Image::Type</ref></type>
        <definition>virtual Image::Type OpenArena::Image::GetType</definition>
        <argsstring>() const =0</argsstring>
        <name>GetType</name>
        <briefdescription>
<para>Write brief comment for GetType here. </para>        </briefdescription>
        <detaileddescription>
<para><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 GetType here.</para><para><simplesect kind="remark"><para>Write remarks for GetType 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/image.h" line="137"/>
      </memberdef>
      <memberdef kind="function" id="class_open_arena_1_1_image_1387e4530a6408fce279a6c19fad64584" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>virtual</type>
        <definition>virtual OpenArena::Image::~Image</definition>
        <argsstring>(void)</argsstring>
        <name>~Image</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>Write brief comment for ~Image 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 ~Image here.</para><para><simplesect kind="remark"><para>Write remarks for ~Image 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/image.h" line="153" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/image.h" bodystart="153" bodyend="153"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Write brief comment for <ref refid="class_open_arena_1_1_image" kindref="compound">Image</ref> here. </para>    </briefdescription>
    <detaileddescription>
<para>Write detailed description for <ref refid="class_open_arena_1_1_image" kindref="compound">Image</ref> here.</para><para><simplesect kind="remark"><para>Write remarks for <ref refid="class_open_arena_1_1_image" kindref="compound">Image</ref> here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para>    </detaileddescription>
    <location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/image.h" line="20" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/image.h" bodystart="19" bodyend="154"/>
    <listofallmembers>
      <member refid="class_open_arena_1_1_image_19e2571d03127a4b8ea677952e46b10eb" prot="public" virt="pure-virtual"><scope>OpenArena::Image</scope><name>GetBitsPerPixel</name></member>
      <member refid="class_open_arena_1_1_image_137073327914dd416fd86f57cdca62502" prot="public" virt="pure-virtual"><scope>OpenArena::Image</scope><name>GetBytesPerPixel</name></member>
      <member refid="class_open_arena_1_1_image_1c3d4fbafd28103aafdb20d8b222fe1ba" prot="public" virt="pure-virtual"><scope>OpenArena::Image</scope><name>GetHeight</name></member>
      <member refid="class_open_arena_1_1_image_14e42b3c49bf88e31c50029664e3604b9" prot="public" virt="pure-virtual"><scope>OpenArena::Image</scope><name>GetImageData</name></member>
      <member refid="class_open_arena_1_1_image_165f02cae03bc870e9781f87ddde10b85" prot="public" virt="pure-virtual"><scope>OpenArena::Image</scope><name>GetType</name></member>
      <member refid="class_open_arena_1_1_image_1ea45a60931d45196828269ed70f87bbc" prot="public" virt="pure-virtual"><scope>OpenArena::Image</scope><name>GetWidth</name></member>
      <member refid="class_open_arena_1_1_image_1ca37f2ad5dd96e2859831f1906bad38f" prot="public" virt="non-virtual"><scope>OpenArena::Image</scope><name>Type</name></member>
      <member refid="class_open_arena_1_1_image_1ca37f2ad5dd96e2859831f1906bad38fda51471d353b3637e396865d74d257f6" prot="public" virt="non-virtual"><scope>OpenArena::Image</scope><name>Type_RGB</name></member>
      <member refid="class_open_arena_1_1_image_1387e4530a6408fce279a6c19fad64584" prot="public" virt="virtual"><scope>OpenArena::Image</scope><name>~Image</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>