diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/sound__bank_8h-source.html | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/docs/doxygen/nel/sound__bank_8h-source.html b/docs/doxygen/nel/sound__bank_8h-source.html new file mode 100644 index 00000000..2bc62727 --- /dev/null +++ b/docs/doxygen/nel/sound__bank_8h-source.html @@ -0,0 +1,177 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>sound_bank.h</h1><a href="sound__bank_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 +00026 <font class="preprocessor">#ifndef NL_SOUND_BANK_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_SOUND_BANK_H</font> +00028 <font class="preprocessor"></font> +00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font> +00030 <font class="preprocessor">#include <string></font> +00031 <font class="preprocessor">#include <hash_map></font> +00032 +00033 <font class="keyword">namespace </font>NLSOUND { +00034 +00035 +00036 <font class="keyword">class </font>CSound; +00037 <font class="keyword">class </font>CSimpleSound; +00038 +00039 +00040 +<a name="l00048"></a><a class="code" href="classNLSOUND_1_1CSoundBank.html">00048</a> <font class="keyword">class </font>CSoundBank +00049 { +00050 <font class="keyword">public</font>: +00051 +00052 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a0">registerBufferAssoc</a>(CSimpleSound *sound, IBuffer *buffer); +00053 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a1">unregisterBufferAssoc</a>(CSimpleSound *sound, IBuffer *buffer); +00054 +00058 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a2">bufferUnloaded</a>(<font class="keyword">const</font> std::string bufferName); +00062 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a3">bufferLoaded</a>(<font class="keyword">const</font> std::string bufferName, IBuffer *buffer); +00063 +00065 <font class="keyword">virtual</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a4">~CSoundBank</a>(); +00066 +00068 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a5">load</a>(); +00069 +00071 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a6">unload</a>(); +00072 +00074 <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a7">isLoaded</a>(); +00075 +00077 CSound *<a class="code" href="classNLSOUND_1_1CSoundBank.html#a8">getSound</a>(<font class="keyword">const</font> std::string &name); +00078 +00080 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a9">getNames</a>( std::vector<std::string >& names ); +00081 +00083 uint <a class="code" href="classNLSOUND_1_1CSoundBank.html#a10">countSounds</a>(); +00084 +00086 <font class="comment">// static void releaseAll();</font> +00087 +00088 <font class="keyword">static</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#c0">CSoundBank</a> *<a class="code" href="classNLSOUND_1_1CSoundBank.html#d0">instance</a>(); +00089 <font class="keyword">static</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#d1">release</a>(); +00090 +00091 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a11">addSound</a>(CSound *sound); +00092 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#a12">removeSound</a>(<font class="keyword">const</font> std::string &name); +00093 +00094 +00095 <font class="keyword">private</font>: +<a name="l00097"></a><a class="code" href="classNLSOUND_1_1CSoundBank.html#c0">00097</a> <a class="code" href="classNLSOUND_1_1CSoundBank.html#c0">CSoundBank</a>() : <a class="code" href="classNLSOUND_1_1CSoundBank.html#o2">_Loaded</a>(false) {}; +00098 +00099 +00101 <font class="keyword">static</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#c0">CSoundBank</a> *<a class="code" href="classNLSOUND_1_1CSoundBank.html#r0">_Instance</a>; +00102 +<a name="l00103"></a><a class="code" href="classNLSOUND_1_1CSoundBank.html#u0">00103</a> <font class="keyword">typedef</font> std::hash_set<class CSimpleSound*, THashPtr<CSimpleSound*> > <a class="code" href="classNLSOUND_1_1CSoundBank.html#u0">TSimpleSoundContainer</a>; +<a name="l00104"></a><a class="code" href="classNLSOUND_1_1CSoundBank.html#u1">00104</a> <font class="keyword">typedef</font> std::hash_map<std::string, TSimpleSoundContainer > <a class="code" href="classNLSOUND_1_1CSoundBank.html#u1">TBufferAssocContainer</a>; +<a name="l00106"></a><a class="code" href="classNLSOUND_1_1CSoundBank.html#u2">00106</a> <font class="keyword">typedef</font> std::hash_map<std::string, CSound*> <a class="code" href="classNLSOUND_1_1CSoundBank.html#u2">TSoundTable</a>; +00107 +<a name="l00109"></a><a class="code" href="classNLSOUND_1_1CSoundBank.html#o0">00109</a> <a class="code" href="classNLSOUND_1_1CSoundBank.html#u1">TBufferAssocContainer</a> <a class="code" href="classNLSOUND_1_1CSoundBank.html#o0">_BufferAssoc</a>; +00110 +00111 <font class="comment">// Buffer</font> +<a name="l00112"></a><a class="code" href="classNLSOUND_1_1CSoundBank.html#o1">00112</a> <a class="code" href="classNLSOUND_1_1CSoundBank.html#u2">TSoundTable</a> <a class="code" href="classNLSOUND_1_1CSoundBank.html#o1">_Sounds</a>; +00113 +00114 <font class="comment">// Did we load the buffers.</font> +<a name="l00115"></a><a class="code" href="classNLSOUND_1_1CSoundBank.html#o2">00115</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CSoundBank.html#o2">_Loaded</a>; +00116 +00117 }; +00118 +00119 +<a name="l00124"></a><a class="code" href="classNLSOUND_1_1ESoundBankNotFound.html">00124</a> <font class="keyword">class </font>ESoundBankNotFound : <font class="keyword">public</font> NLMISC::Exception +00125 { +00126 <font class="keyword">public</font>: +<a name="l00127"></a><a class="code" href="classNLSOUND_1_1ESoundBankNotFound.html#a0">00127</a> <a class="code" href="classNLSOUND_1_1ESoundBankNotFound.html#a0">ESoundBankNotFound</a>( <font class="keyword">const</font> std::string filename ) : +00128 NLMISC::<a class="code" href="classNLMISC_1_1Exception.html#a0">Exception</a>( (std::string("Sound bank not found: ")+filename).c_str() ) {} +00129 }; +00130 +00131 } <font class="comment">// NLSOUND</font> +00132 +00133 +00134 <font class="preprocessor">#endif // NL_SOUND_BANK_H</font> +00135 <font class="preprocessor"></font> +00136 <font class="comment">/* End of sound.h */</font> +00137 +</pre></div> + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |