diff options
Diffstat (limited to 'docs/doxygen/nel/classNLSOUND_1_1CBufferDSound.html')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CBufferDSound.html | 797 |
1 files changed, 797 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CBufferDSound.html b/docs/doxygen/nel/classNLSOUND_1_1CBufferDSound.html new file mode 100644 index 00000000..c208e42f --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CBufferDSound.html @@ -0,0 +1,797 @@ +<!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::CBufferDSound Class Reference</h1>Buffer for the DSound implementation of the audio driver. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::CBufferDSound: +<p><center><img src="classNLSOUND_1_1CBufferDSound.gif" usemap="#NLSOUND::CBufferDSound_map" border="0"></center> +<map name="NLSOUND::CBufferDSound_map"> +<area href="classNLSOUND_1_1IBuffer.html" alt="NLSOUND::IBuffer" shape="rect" coords="0,0,167,24"> +</map> +<a href="classNLSOUND_1_1CBufferDSound-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> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a0">CBufferDSound</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#a0">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_1CBufferDSound.html#a1">~CBufferDSound</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a2">presetName</a> (const std::string &bufferName)</td></tr> +<tr><td> </td><td><font size=-1><em>Preset the name of the buffer.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a3">setFormat</a> (<a class="el" href="namespaceNLSOUND.html#a83">TSampleFormat</a> <a class="el" href="driver__opengl__extension__def_8h.html#a398">format</a>, <a class="el" href="memory__common_8h.html#a15">uint</a> freq)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the sample format. Example: freq=44100.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a4">fillBuffer</a> (void *<a class="el" href="driver__opengl__extension__def_8h.html#a409">src</a>, <a class="el" href="memory__common_8h.html#a11">uint32</a> bufsize)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the buffer size and fill the buffer. Return true if ok. Call <a class="el" href="classNLSOUND_1_1CBufferDSound.html#a3">setFormat</a>() first.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a5">getSize</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the size of the buffer, in bytes.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a6">getDuration</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the duration (in ms) of the sample in the buffer.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a7">isStereo</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if the buffer is stereo, false if mono.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a8">getFormat</a> (<a class="el" href="namespaceNLSOUND.html#a83">TSampleFormat</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a398">format</a>, <a class="el" href="memory__common_8h.html#a15">uint</a> &freq) const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the format and frequency.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a9">isFillMoreSupported</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if the buffer is able to be fill part by part, false if it must be filled in one call (OpenAL 1.0 -> false).</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a10">loadWavFile</a> (const char *filename)</td></tr> +<tr><td> </td><td><font size=-1><em>Load a sound file in the buffer. Throws an exception is an error occurs.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a7">uint8</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a11">getData</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return a pointer to the sample data.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const std::string & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a12">getName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the name of the buffer.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#a13">isBufferLoaded</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if the buffer is loaded. Used for async load/unload.</em> <a href="#a13">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>std::string </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#o0">_Name</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a7">uint8</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#o1">_Data</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#o2">_Size</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLSOUND.html#a83">TSampleFormat</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CBufferDSound.html#o3">_Format</a></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_1CBufferDSound.html#o4">_Freq</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Buffer for the DSound implementation of the audio driver. +<p> +A buffer represents a sound file loaded in RAM. +<p> +<dl compact><dt><b> +Author: </b><dd> +Peter Hanappe, Olivier Cado , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2002 </dl> +<p> + +<p> +Definition at line <a class="el" href="buffer__dsound_8h-source.html#l00045">45</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CBufferDSound::CBufferDSound"></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::CBufferDSound::CBufferDSound </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> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="buffer__dsound_8cpp-source.html#l00041">41</a> of file <a class="el" href="buffer__dsound_8cpp-source.html">buffer_dsound.cpp</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00106">_Data</a>, <a class="el" href="buffer__dsound_8h-source.html#l00110">_Format</a>, <a class="el" href="buffer__dsound_8h-source.html#l00112">_Freq</a>, <a class="el" href="buffer__dsound_8h-source.html#l00108">_Size</a>, and <a class="el" href="namespaceNLSOUND.html#a83a22">NLSOUND::Mono16</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CBufferDSound::~CBufferDSound"></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::CBufferDSound::~CBufferDSound </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="buffer__dsound_8cpp-source.html#l00049">49</a> of file <a class="el" href="buffer__dsound_8cpp-source.html">buffer_dsound.cpp</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00106">_Data</a>, <a class="el" href="buffer__dsound_8h-source.html#l00104">_Name</a>, and <a class="el" href="debug_8h-source.html#l00087">nldebug</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="NLSOUND::CBufferDSound::fillBuffer"></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::CBufferDSound::fillBuffer </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void * </td> + <td class="mdname" nowrap> <em>src</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a11">uint32</a> </td> + <td class="mdname" nowrap> <em>bufsize</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the buffer size and fill the buffer. Return true if ok. Call <a class="el" href="classNLSOUND_1_1CBufferDSound.html#a3">setFormat</a>() first. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a2">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8cpp-source.html#l00072">72</a> of file <a class="el" href="buffer__dsound_8cpp-source.html">buffer_dsound.cpp</a>. +<p> +References <a class="el" href="driver__opengl__extension__def_8h-source.html#l00820">src</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLSOUND::CBufferDSound::getData"></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"> virtual <a class="el" href="memory__common_8h.html#a7">uint8</a>* NLSOUND::CBufferDSound::getData </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a pointer to the sample data. +<p> + +<p> +Definition at line <a class="el" href="buffer__dsound_8h-source.html#l00095">95</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00106">_Data</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::CBufferDSound::getDuration"></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"> float NLSOUND::CBufferDSound::getDuration </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the duration (in ms) of the sample in the buffer. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a4">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8cpp-source.html#l00078">78</a> of file <a class="el" href="buffer__dsound_8cpp-source.html">buffer_dsound.cpp</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00112">_Freq</a>, <a class="el" href="buffer__dsound_8h-source.html#l00108">_Size</a>, <a class="el" href="namespaceNLSOUND.html#a83a22">NLSOUND::Mono16</a>, <a class="el" href="namespaceNLSOUND.html#a83a21">NLSOUND::Mono8</a>, <a class="el" href="namespaceNLSOUND.html#a83a24">NLSOUND::Stereo16</a>, and <a class="el" href="namespaceNLSOUND.html#a83a23">NLSOUND::Stereo8</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::CBufferDSound::getFormat"></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"> virtual void NLSOUND::CBufferDSound::getFormat </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a83">TSampleFormat</a> & </td> + <td class="mdname" nowrap> <em>format</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a15">uint</a> & </td> + <td class="mdname" nowrap> <em>freq</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the format and frequency. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a6">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8h-source.html#l00072">72</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00110">_Format</a>, <a class="el" href="buffer__dsound_8h-source.html#l00112">_Freq</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00712">format</a>, and <a class="el" href="buffer_8h-source.html#l00039">NLSOUND::TSampleFormat</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLSOUND::CBufferDSound::getName"></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"> virtual const std::string& NLSOUND::CBufferDSound::getName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the name of the buffer. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a10">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8h-source.html#l00098">98</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00104">_Name</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::CBufferDSound::getSize"></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"> virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> NLSOUND::CBufferDSound::getSize </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the size of the buffer, in bytes. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a3">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8h-source.html#l00063">63</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00108">_Size</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLSOUND::CBufferDSound::isBufferLoaded"></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"> virtual bool NLSOUND::CBufferDSound::isBufferLoaded </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, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return true if the buffer is loaded. Used for async load/unload. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a11">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8h-source.html#l00100">100</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00106">_Data</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::CBufferDSound::isFillMoreSupported"></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"> virtual bool NLSOUND::CBufferDSound::isFillMoreSupported </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return true if the buffer is able to be fill part by part, false if it must be filled in one call (OpenAL 1.0 -> false). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a7">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8h-source.html#l00078">78</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLSOUND::CBufferDSound::isStereo"></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"> virtual bool NLSOUND::CBufferDSound::isStereo </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return true if the buffer is stereo, false if mono. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a5">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8h-source.html#l00069">69</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00110">_Format</a>, <a class="el" href="namespaceNLSOUND.html#a83a24">NLSOUND::Stereo16</a>, and <a class="el" href="namespaceNLSOUND.html#a83a23">NLSOUND::Stereo8</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLSOUND::CBufferDSound::loadWavFile"></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::CBufferDSound::loadWavFile </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </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> +Load a sound file in the buffer. Throws an exception is an error occurs. +<p> +If the pos+srcsize exceeds the buffer size, the exceeding data is put at the beginning of the buffer. srcsize must be smaller than the buffer size. +<p> +Definition at line <a class="el" href="buffer__dsound_8cpp-source.html#l00100">100</a> of file <a class="el" href="buffer__dsound_8cpp-source.html">buffer_dsound.cpp</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00106">_Data</a>, <a class="el" href="buffer__dsound_8h-source.html#l00110">_Format</a>, <a class="el" href="buffer__dsound_8h-source.html#l00112">_Freq</a>, <a class="el" href="buffer__dsound_8h-source.html#l00104">_Name</a>, <a class="el" href="buffer__dsound_8h-source.html#l00108">_Size</a>, <a class="el" href="cf__lexical_8cpp-source.html#l02654">file</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00712">format</a>, <a class="el" href="namespaceNLSOUND.html#a83a22">NLSOUND::Mono16</a>, <a class="el" href="namespaceNLSOUND.html#a83a21">NLSOUND::Mono8</a>, <a class="el" href="debug_8h-source.html#l00293">nlassertex</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00820">num</a>, <a class="el" href="namespaceNLSOUND.html#a83a24">NLSOUND::Stereo16</a>, and <a class="el" href="namespaceNLSOUND.html#a83a23">NLSOUND::Stereo8</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::CBufferDSound::presetName"></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::CBufferDSound::presetName </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><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Preset the name of the buffer. +<p> +Used for async loading to give a name before the buffer is effectivly loaded. If the name after loading of the buffer doesn't match the preset name, the load will assert. +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a0">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8cpp-source.html#l00059">59</a> of file <a class="el" href="buffer__dsound_8cpp-source.html">buffer_dsound.cpp</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00104">_Name</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLSOUND::CBufferDSound::setFormat"></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::CBufferDSound::setFormat </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a83">TSampleFormat</a> </td> + <td class="mdname" nowrap> <em>format</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>freq</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the sample format. Example: freq=44100. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IBuffer.html#a1">NLSOUND::IBuffer</a>. +<p> +Definition at line <a class="el" href="buffer__dsound_8cpp-source.html#l00065">65</a> of file <a class="el" href="buffer__dsound_8cpp-source.html">buffer_dsound.cpp</a>. +<p> +References <a class="el" href="buffer__dsound_8h-source.html#l00110">_Format</a>, <a class="el" href="buffer__dsound_8h-source.html#l00112">_Freq</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00712">format</a>, and <a class="el" href="buffer_8h-source.html#l00039">NLSOUND::TSampleFormat</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o1" doxytag="NLSOUND::CBufferDSound::_Data"></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#a7">uint8</a>* NLSOUND::CBufferDSound::_Data<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="buffer__dsound_8h-source.html#l00106">106</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +Referenced by <a class="el" href="buffer__dsound_8cpp-source.html#l00041">CBufferDSound</a>, <a class="el" href="buffer__dsound_8h-source.html#l00095">getData</a>, <a class="el" href="buffer__dsound_8h-source.html#l00100">isBufferLoaded</a>, <a class="el" href="buffer__dsound_8cpp-source.html#l00100">loadWavFile</a>, and <a class="el" href="buffer__dsound_8cpp-source.html#l00049">~CBufferDSound</a>. </td> + </tr> +</table> +<a name="o3" doxytag="NLSOUND::CBufferDSound::_Format"></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="namespaceNLSOUND.html#a83">TSampleFormat</a> NLSOUND::CBufferDSound::_Format<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="buffer__dsound_8h-source.html#l00110">110</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +Referenced by <a class="el" href="buffer__dsound_8cpp-source.html#l00041">CBufferDSound</a>, <a class="el" href="buffer__dsound_8h-source.html#l00072">getFormat</a>, <a class="el" href="buffer__dsound_8h-source.html#l00069">isStereo</a>, <a class="el" href="buffer__dsound_8cpp-source.html#l00100">loadWavFile</a>, and <a class="el" href="buffer__dsound_8cpp-source.html#l00065">setFormat</a>. </td> + </tr> +</table> +<a name="o4" doxytag="NLSOUND::CBufferDSound::_Freq"></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::CBufferDSound::_Freq<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="buffer__dsound_8h-source.html#l00112">112</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +Referenced by <a class="el" href="buffer__dsound_8cpp-source.html#l00041">CBufferDSound</a>, <a class="el" href="buffer__dsound_8cpp-source.html#l00078">getDuration</a>, <a class="el" href="buffer__dsound_8h-source.html#l00072">getFormat</a>, <a class="el" href="buffer__dsound_8cpp-source.html#l00100">loadWavFile</a>, and <a class="el" href="buffer__dsound_8cpp-source.html#l00065">setFormat</a>. </td> + </tr> +</table> +<a name="o0" doxytag="NLSOUND::CBufferDSound::_Name"></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"> std::string NLSOUND::CBufferDSound::_Name<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="buffer__dsound_8h-source.html#l00104">104</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +Referenced by <a class="el" href="buffer__dsound_8h-source.html#l00098">getName</a>, <a class="el" href="buffer__dsound_8cpp-source.html#l00100">loadWavFile</a>, <a class="el" href="buffer__dsound_8cpp-source.html#l00059">presetName</a>, and <a class="el" href="buffer__dsound_8cpp-source.html#l00049">~CBufferDSound</a>. </td> + </tr> +</table> +<a name="o2" doxytag="NLSOUND::CBufferDSound::_Size"></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#a11">uint32</a> NLSOUND::CBufferDSound::_Size<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="buffer__dsound_8h-source.html#l00108">108</a> of file <a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a>. +<p> +Referenced by <a class="el" href="buffer__dsound_8cpp-source.html#l00041">CBufferDSound</a>, <a class="el" href="buffer__dsound_8cpp-source.html#l00078">getDuration</a>, <a class="el" href="buffer__dsound_8h-source.html#l00063">getSize</a>, and <a class="el" href="buffer__dsound_8cpp-source.html#l00100">loadWavFile</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="buffer__dsound_8h-source.html">buffer_dsound.h</a><li><a class="el" href="buffer__dsound_8cpp-source.html">buffer_dsound.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> |