diff options
Diffstat (limited to 'docs/doxygen/nel/classNLSOUND_1_1CSoundBank.html')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CSoundBank.html | 900 |
1 files changed, 900 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CSoundBank.html b/docs/doxygen/nel/classNLSOUND_1_1CSoundBank.html new file mode 100644 index 00000000..d064b8d6 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CSoundBank.html @@ -0,0 +1,900 @@ +<!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>NLSOUND::CSoundBank Class Reference</h1>A set of sounds. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="sound__bank_8h-source.html">sound_bank.h</a>></code> +<p> +<a href="classNLSOUND_1_1CSoundBank-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a0">registerBufferAssoc</a> (<a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> *sound, <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> *<a class="el" href="driver__opengl__extension__def_8h.html#a381">buffer</a>)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a1">unregisterBufferAssoc</a> (<a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> *sound, <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> *<a class="el" href="driver__opengl__extension__def_8h.html#a381">buffer</a>)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a2">bufferUnloaded</a> (const std::string bufferName)</td></tr> +<tr><td> </td><td><font size=-1><em>Called by <a class="el" href="classNLSOUND_1_1CSampleBank.html">CSampleBank</a> when a sample(buffer) is unloaded.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a3">bufferLoaded</a> (const std::string bufferName, <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> *<a class="el" href="driver__opengl__extension__def_8h.html#a381">buffer</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Called by <a class="el" href="classNLSOUND_1_1CSampleBank.html">CSampleBank</a> when a sample(buffer) is loaded.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a4">~CSoundBank</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a5">load</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Load all the sound samples.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a6">unload</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Remove all the sounds in this bank.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a7">isLoaded</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns true if the sounds in this bank have been loaded.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CSound.html">CSound</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a8">getSound</a> (const std::string &name)</td></tr> +<tr><td> </td><td><font size=-1><em>Return a sound corresponding to a name.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a9">getNames</a> (std::vector< std::string > &names)</td></tr> +<tr><td> </td><td><font size=-1><em>Return the names of the sounds.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a15">uint</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a10">countSounds</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the number of sounds in this bank.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a11">addSound</a> (<a class="el" href="classNLSOUND_1_1CSound.html">CSound</a> *sound)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#a12">removeSound</a> (const std::string &name)</td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>CSoundBank * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#d0">instance</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Release all the loaded sound banks.</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#d1">release</a> ()</td></tr> +<tr><td colspan=2><br><h2>Private Types</h2></td></tr> +<tr><td nowrap align=right valign=top>typedef std::hash_set< class <br> +<a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> *, <a class="el" href="structNLSOUND_1_1THashPtr.html">THashPtr</a><<br> + <a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> * > > </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#u0">TSimpleSoundContainer</a></td></tr> +<tr><td nowrap align=right valign=top>typedef std::hash_map< std::string,<br> + <a class="el" href="classNLSOUND_1_1CSoundBank.html#u0">TSimpleSoundContainer</a> > </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#u1">TBufferAssocContainer</a></td></tr> +<tr><td nowrap align=right valign=top>typedef std::hash_map< std::string,<br> + <a class="el" href="classNLSOUND_1_1CSound.html">CSound</a> * > </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#u2">TSoundTable</a></td></tr> +<tr><td> </td><td><font size=-1><em>Sound names hash map.</em> <a href="#u2">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#c0">CSoundBank</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#c0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CSoundBank.html#u1">TBufferAssocContainer</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#o0">_BufferAssoc</a></td></tr> +<tr><td> </td><td><font size=-1><em>Assoc from buffer to sound. Used for sound unloading.</em> <a href="#o0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CSoundBank.html#u2">TSoundTable</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#o1">_Sounds</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#o2">_Loaded</a></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>CSoundBank * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundBank.html#r0">_Instance</a></td></tr> +<tr><td> </td><td><font size=-1><em><a class="el" href="classNLSOUND_1_1CSoundBank.html">CSoundBank</a> singleton instance.</em> <a href="#r0">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A set of sounds. +<p> +<dl compact><dt><b> +Author: </b><dd> +Peter Hanappe \authoe Boris Boucher , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8h-source.html#l00048">48</a> of file <a class="el" href="sound__bank_8h-source.html">sound_bank.h</a>.<hr><h2>Member Typedef Documentation</h2> +<a name="u1" doxytag="NLSOUND::CSoundBank::TBufferAssocContainer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> typedef std::hash_map<std::string, <a class="el" href="classNLSOUND_1_1CSoundBank.html#u0">TSimpleSoundContainer</a> > NLSOUND::CSoundBank::TBufferAssocContainer<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8h-source.html#l00104">104</a> of file <a class="el" href="sound__bank_8h-source.html">sound_bank.h</a>. </td> + </tr> +</table> +<a name="u0" doxytag="NLSOUND::CSoundBank::TSimpleSoundContainer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> typedef std::hash_set<class <a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a>*, <a class="el" href="structNLSOUND_1_1THashPtr.html">THashPtr</a><<a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a>*> > NLSOUND::CSoundBank::TSimpleSoundContainer<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8h-source.html#l00103">103</a> of file <a class="el" href="sound__bank_8h-source.html">sound_bank.h</a>. </td> + </tr> +</table> +<a name="u2" doxytag="NLSOUND::CSoundBank::TSoundTable"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> typedef std::hash_map<std::string, <a class="el" href="classNLSOUND_1_1CSound.html">CSound</a>*> NLSOUND::CSoundBank::TSoundTable<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sound names hash map. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8h-source.html#l00106">106</a> of file <a class="el" href="sound__bank_8h-source.html">sound_bank.h</a>. </td> + </tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a4" doxytag="NLSOUND::CSoundBank::~CSoundBank"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::CSoundBank::~CSoundBank </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00143">143</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8cpp-source.html#l00285">unload</a>. </td> + </tr> +</table> +<a name="c0" doxytag="NLSOUND::CSoundBank::CSoundBank"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::CSoundBank::CSoundBank </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8h-source.html#l00097">97</a> of file <a class="el" href="sound__bank_8h-source.html">sound_bank.h</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00115">_Loaded</a>. +<p> +Referenced by <a class="el" href="sound__bank_8cpp-source.html#l00053">instance</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a11" doxytag="NLSOUND::CSoundBank::addSound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::addSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1CSound.html">CSound</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>sound</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00148">148</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00112">_Sounds</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLSOUND::CSoundBank::bufferLoaded"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::bufferLoaded </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string </td> + <td class="mdname" nowrap> <em>bufferName</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td> + <td class="mdname" nowrap> <em>buffer</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called by <a class="el" href="classNLSOUND_1_1CSampleBank.html">CSampleBank</a> when a sample(buffer) is loaded. +<p> +Regenerate link between <a class="el" href="classNLSOUND_1_1CSound.html">CSound</a> and <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a>. +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00086">86</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00109">_BufferAssoc</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::CSoundBank::bufferUnloaded"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::bufferUnloaded </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string </td> + <td class="mdname1" valign="top" nowrap> <em>bufferName</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Called by <a class="el" href="classNLSOUND_1_1CSampleBank.html">CSampleBank</a> when a sample(buffer) is unloaded. +<p> +Remove link from <a class="el" href="classNLSOUND_1_1CSound.html">CSound</a> to unloaded <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a>. +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00068">68</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00109">_BufferAssoc</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLSOUND::CSoundBank::countSounds"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a15">uint</a> NLSOUND::CSoundBank::countSounds </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the number of sounds in this bank. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00351">351</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00112">_Sounds</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::CSoundBank::getNames"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::getNames </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< std::string > & </td> + <td class="mdname1" valign="top" nowrap> <em>names</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the names of the sounds. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00338">338</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00112">_Sounds</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::CSoundBank::getSound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1CSound.html">CSound</a> * NLSOUND::CSoundBank::getSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>name</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a sound corresponding to a name. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00321">321</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00112">_Sounds</a>. </td> + </tr> +</table> +<a name="d0" doxytag="NLSOUND::CSoundBank::instance"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> CSoundBank * NLSOUND::CSoundBank::instance </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Release all the loaded sound banks. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00053">53</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8cpp-source.html#l00049">_Instance</a>, and <a class="el" href="sound__bank_8h-source.html#l00097">CSoundBank</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLSOUND::CSoundBank::isLoaded"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLSOUND::CSoundBank::isLoaded </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns true if the sounds in this bank have been loaded. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00313">313</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00115">_Loaded</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::CSoundBank::load"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::load </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Load all the sound samples. +<p> +Can throw EPathNotFound or <a class="el" href="classNLSOUND_1_1ESoundFileNotFound.html">ESoundFileNotFound</a> (check Exception) +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00273">273</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00115">_Loaded</a>, <a class="el" href="sound__bank_8cpp-source.html#l00267">NLSOUND::Container</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a0" doxytag="NLSOUND::CSoundBank::registerBufferAssoc"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::registerBufferAssoc </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> * </td> + <td class="mdname" nowrap> <em>sound</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td> + <td class="mdname" nowrap> <em>buffer</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00106">106</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00109">_BufferAssoc</a>. </td> + </tr> +</table> +<a name="d1" doxytag="NLSOUND::CSoundBank::release"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::release </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00060">60</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8cpp-source.html#l00049">_Instance</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLSOUND::CSoundBank::removeSound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::removeSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>name</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00153">153</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00112">_Sounds</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::CSoundBank::unload"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::unload </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Remove all the sounds in this bank. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00285">285</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00115">_Loaded</a>, <a class="el" href="sound__bank_8h-source.html#l00112">_Sounds</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. +<p> +Referenced by <a class="el" href="sound__bank_8cpp-source.html#l00143">~CSoundBank</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CSoundBank::unregisterBufferAssoc"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundBank::unregisterBufferAssoc </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1CSimpleSound.html">CSimpleSound</a> * </td> + <td class="mdname" nowrap> <em>sound</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td> + <td class="mdname" nowrap> <em>buffer</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00115">115</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +References <a class="el" href="sound__bank_8h-source.html#l00109">_BufferAssoc</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o0" doxytag="NLSOUND::CSoundBank::_BufferAssoc"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1CSoundBank.html#u1">TBufferAssocContainer</a> NLSOUND::CSoundBank::_BufferAssoc<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Assoc from buffer to sound. Used for sound unloading. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8h-source.html#l00109">109</a> of file <a class="el" href="sound__bank_8h-source.html">sound_bank.h</a>. +<p> +Referenced by <a class="el" href="sound__bank_8cpp-source.html#l00086">bufferLoaded</a>, <a class="el" href="sound__bank_8cpp-source.html#l00068">bufferUnloaded</a>, <a class="el" href="sound__bank_8cpp-source.html#l00106">registerBufferAssoc</a>, and <a class="el" href="sound__bank_8cpp-source.html#l00115">unregisterBufferAssoc</a>. </td> + </tr> +</table> +<a name="r0" doxytag="NLSOUND::CSoundBank::_Instance"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> CSoundBank * NLSOUND::CSoundBank::_Instance<code> [static, private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<a class="el" href="classNLSOUND_1_1CSoundBank.html">CSoundBank</a> singleton instance. +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8cpp-source.html#l00049">49</a> of file <a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a>. +<p> +Referenced by <a class="el" href="sound__bank_8cpp-source.html#l00053">instance</a>, and <a class="el" href="sound__bank_8cpp-source.html#l00060">release</a>. </td> + </tr> +</table> +<a name="o2" doxytag="NLSOUND::CSoundBank::_Loaded"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLSOUND::CSoundBank::_Loaded<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8h-source.html#l00115">115</a> of file <a class="el" href="sound__bank_8h-source.html">sound_bank.h</a>. +<p> +Referenced by <a class="el" href="sound__bank_8h-source.html#l00097">CSoundBank</a>, <a class="el" href="sound__bank_8cpp-source.html#l00313">isLoaded</a>, <a class="el" href="sound__bank_8cpp-source.html#l00273">load</a>, and <a class="el" href="sound__bank_8cpp-source.html#l00285">unload</a>. </td> + </tr> +</table> +<a name="o1" doxytag="NLSOUND::CSoundBank::_Sounds"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1CSoundBank.html#u2">TSoundTable</a> NLSOUND::CSoundBank::_Sounds<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__bank_8h-source.html#l00112">112</a> of file <a class="el" href="sound__bank_8h-source.html">sound_bank.h</a>. +<p> +Referenced by <a class="el" href="sound__bank_8cpp-source.html#l00148">addSound</a>, <a class="el" href="sound__bank_8cpp-source.html#l00351">countSounds</a>, <a class="el" href="sound__bank_8cpp-source.html#l00338">getNames</a>, <a class="el" href="sound__bank_8cpp-source.html#l00321">getSound</a>, <a class="el" href="sound__bank_8cpp-source.html#l00153">removeSound</a>, and <a class="el" href="sound__bank_8cpp-source.html#l00285">unload</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="sound__bank_8h-source.html">sound_bank.h</a><li><a class="el" href="sound__bank_8cpp-source.html">sound_bank.cpp</a></ul> + + +<!-- 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> |