diff options
| author | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
|---|---|---|
| committer | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
| commit | 0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch) | |
| tree | 2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/classNLSOUND_1_1CSourceAL.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CSourceAL.html | 1351 |
1 files changed, 1351 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CSourceAL.html b/docs/doxygen/nel/classNLSOUND_1_1CSourceAL.html new file mode 100644 index 00000000..628acc0c --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CSourceAL.html @@ -0,0 +1,1351 @@ +<!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::CSourceAL Class Reference</h1>OpenAL sound source. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="source__al_8h-source.html">source_al.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::CSourceAL: +<p><center><img src="classNLSOUND_1_1CSourceAL.gif" usemap="#NLSOUND::CSourceAL_map" border="0"></center> +<map name="NLSOUND::CSourceAL_map"> +<area href="classNLSOUND_1_1ISource.html" alt="NLSOUND::ISource" shape="rect" coords="0,0,144,24"> +</map> +<a href="classNLSOUND_1_1CSourceAL-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_1CSourceAL.html#a0">CSourceAL</a> (ALuint sourcename=AL_NONE)</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_1CSourceAL.html#a1">~CSourceAL</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>ALuint </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceAL.html#a2">sourceName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the OpenAL source name.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Initialization</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceAL.html#z975_0">setStaticBuffer</a> (<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>Set the buffer that will be played (no streaming) If the buffer is stereo, the source mode becomes stereo and the source relative mode is on, otherwise the source is considered as a 3D source.</em> <a href="#z975_0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Playback control</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceAL.html#z976_0">setLooping</a> (bool l)</td></tr> +<tr><td> </td><td><font size=-1><em>Set looping on/off for future playbacks (default: off).</em> <a href="#z976_0">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_1CSourceAL.html#z976_1">getLooping</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the looping state.</em> <a href="#z976_1">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_1CSourceAL.html#z976_2">play</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Play the static buffer (or stream in and play).</em> <a href="#z976_2">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_1CSourceAL.html#z976_3">stop</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing.</em> <a href="#z976_3">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_1CSourceAL.html#z976_4">pause</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Pause. Call <a class="el" href="classNLSOUND_1_1CSourceAL.html#z976_2">play</a>() to resume.</em> <a href="#z976_4">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_1CSourceAL.html#z976_5">isPlaying</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the playing state.</em> <a href="#z976_5">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_1CSourceAL.html#z976_6">isStopped</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if playing is finished or <a class="el" href="classNLSOUND_1_1CSourceAL.html#z976_3">stop</a>() has been called.</em> <a href="#z976_6">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_1CSourceAL.html#z976_7">update</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Update the source (e.g. continue to stream the data in).</em> <a href="#z976_7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Source properties</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceAL.html#z977_0">setPos</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &pos)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the position vector (default: (0,0,0)).</em> <a href="#z977_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceAL.html#z977_1">getPos</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the position vector.</em> <a href="#z977_1">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_1CSourceAL.html#z977_2">setVelocity</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel, bool deferred)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the velocity vector (3D mode only) (default: (0,0,0)).</em> <a href="#z977_2">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_1CSourceAL.html#z977_3">getVelocity</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel) const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the velocity vector.</em> <a href="#z977_3">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_1CSourceAL.html#z977_4">setDirection</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &dir)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the direction vector (3D mode only) (default: (0,0,0) as non-directional).</em> <a href="#z977_4">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_1CSourceAL.html#z977_5">getDirection</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &dir) const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the direction vector.</em> <a href="#z977_5">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_1CSourceAL.html#z977_6">setGain</a> (float gain)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the gain (volume value inside [0 , 1]) (default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers.</em> <a href="#z977_6">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_1CSourceAL.html#z977_7">getGain</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the gain.</em> <a href="#z977_7">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_1CSourceAL.html#z977_8">setPitch</a> (float pitch)</td></tr> +<tr><td> </td><td><font size=-1><em>Shift the frequency.</em> <a href="#z977_8">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_1CSourceAL.html#z977_9">getPitch</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the pitch.</em> <a href="#z977_9">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_1CSourceAL.html#z977_10">setSourceRelativeMode</a> (bool mode)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the source relative mode. If true, positions are interpreted relative to the listener position (default: false).</em> <a href="#z977_10">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_1CSourceAL.html#z977_11">getSourceRelativeMode</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the source relative mode.</em> <a href="#z977_11">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_1CSourceAL.html#z977_12">setMinMaxDistances</a> (float mindist, float maxdist, bool deferred)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the min and max distances (default: 1, MAX_FLOAT) (3D mode only).</em> <a href="#z977_12">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_1CSourceAL.html#z977_13">getMinMaxDistances</a> (float &mindist, float &maxdist) const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the min and max distances.</em> <a href="#z977_13">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_1CSourceAL.html#z977_14">setCone</a> (float innerAngle, float outerAngle, float outerGain)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the cone angles (in radian) and gain (in [0 , 1]) (default: 2PI, 2PI, 0) (3D mode only).</em> <a href="#z977_14">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_1CSourceAL.html#z977_15">getCone</a> (float &innerAngle, float &outerAngle, float &outerGain) const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the cone angles (in radian).</em> <a href="#z977_15">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_1CSourceAL.html#z977_16">setEAXProperty</a> (<a class="el" href="memory__common_8h.html#a15">uint</a> prop, void *<a class="el" href="driver__opengl__extension__def_8h.html#a415">value</a>, <a class="el" href="memory__common_8h.html#a15">uint</a> valuesize)</td></tr> +<tr><td> </td><td><font size=-1><em>Set any EAX source property if EAX available.</em> <a href="#z977_16">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>ALuint </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceAL.html#o0">_SourceName</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSourceAL.html#o1">_Pos</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +OpenAL sound source. +<p> +Note: the creation/deletion of sources and the setting of their rolloff factor are done in <a class="el" href="classNLSOUND_1_1CSoundDriverAL.html">CSoundDriverAL</a>. +<p> +The EAX extensions are not available on all sound cards, and currently not at all on Linux. +<p> +For arguments as 3D vectors, use the NeL vector coordinate system (not OpenAL/OpenGL's one). +<p> +<dl compact><dt><b> +Author: </b><dd> +Olivier Cado , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="source__al_8h-source.html#l00053">53</a> of file <a class="el" href="source__al_8h-source.html">source_al.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CSourceAL::CSourceAL"></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::CSourceAL::CSourceAL </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">ALuint </td> + <td class="mdname1" valign="top" nowrap> <em>sourcename</em> = AL_NONE </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="source__al_8cpp-source.html#l00046">46</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CSourceAL::~CSourceAL"></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::CSourceAL::~CSourceAL </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="source__al_8cpp-source.html#l00053">53</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="z977_15" doxytag="NLSOUND::CSourceAL::getCone"></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::CSourceAL::getCone </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float & </td> + <td class="mdname" nowrap> <em>innerAngle</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float & </td> + <td class="mdname" nowrap> <em>outerAngle</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float & </td> + <td class="mdname" nowrap> <em>outerGain</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the cone angles (in radian). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_15">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00396">396</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="common_8h-source.html#l00206">NLMISC::degToRad</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_5" doxytag="NLSOUND::CSourceAL::getDirection"></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::CSourceAL::getDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>dir</em> </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> +Get the direction vector. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_5">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00276">276</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="vector__inline_8h-source.html#l00136">NLMISC::CVector::set</a>, <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00234">v</a>. </td> + </tr> +</table> +<a name="z977_7" doxytag="NLSOUND::CSourceAL::getGain"></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::CSourceAL::getGain </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> +Get the gain. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_7">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00303">303</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z976_1" doxytag="NLSOUND::CSourceAL::getLooping"></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::CSourceAL::getLooping </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 looping state. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z979_1">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00103">103</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_13" doxytag="NLSOUND::CSourceAL::getMinMaxDistances"></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::CSourceAL::getMinMaxDistances </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float & </td> + <td class="mdname" nowrap> <em>mindist</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float & </td> + <td class="mdname" nowrap> <em>maxdist</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the min and max distances. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_13">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00372">372</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_9" doxytag="NLSOUND::CSourceAL::getPitch"></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::CSourceAL::getPitch </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> +Get the pitch. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_9">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00326">326</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_1" doxytag="NLSOUND::CSourceAL::getPos"></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"> const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & NLSOUND::CSourceAL::getPos </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> +Get the position vector. +<p> +See <a class="el" href="classNLSOUND_1_1CSourceAL.html#z977_0">setPos</a>() for details. +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_1">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00225">225</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00156">_Pos</a>. </td> + </tr> +</table> +<a name="z977_11" doxytag="NLSOUND::CSourceAL::getSourceRelativeMode"></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::CSourceAL::getSourceRelativeMode </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> +Get the source relative mode. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_11">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00348">348</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_3" doxytag="NLSOUND::CSourceAL::getVelocity"></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::CSourceAL::getVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>vel</em> </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> +Get the velocity vector. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_3">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00252">252</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="vector__inline_8h-source.html#l00136">NLMISC::CVector::set</a>, <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00234">v</a>. </td> + </tr> +</table> +<a name="z976_5" doxytag="NLSOUND::CSourceAL::isPlaying"></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::CSourceAL::isPlaying </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 playing state. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z979_5">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00178">178</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z976_6" doxytag="NLSOUND::CSourceAL::isStopped"></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::CSourceAL::isStopped </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 true if playing is finished or <a class="el" href="classNLSOUND_1_1CSourceAL.html#z976_3">stop</a>() has been called. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z979_6">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00190">190</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z976_4" doxytag="NLSOUND::CSourceAL::pause"></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::CSourceAL::pause </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> +Pause. Call <a class="el" href="classNLSOUND_1_1CSourceAL.html#z976_2">play</a>() to resume. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z979_4">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00158">158</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source_8h-source.html#l00167">NLSOUND::ISource::_Buffer</a>, <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="debug_8h-source.html#l00374">nlstop</a>, <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z976_2" doxytag="NLSOUND::CSourceAL::play"></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::CSourceAL::play </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> +Play the static buffer (or stream in and play). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z979_2">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00115">115</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source_8h-source.html#l00167">NLSOUND::ISource::_Buffer</a>, <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="debug_8h-source.html#l00374">nlstop</a>, <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_14" doxytag="NLSOUND::CSourceAL::setCone"></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::CSourceAL::setCone </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname" nowrap> <em>innerAngle</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>outerAngle</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>outerGain</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 cone angles (in radian) and gain (in [0 , 1]) (default: 2PI, 2PI, 0) (3D mode only). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_14">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00383">383</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="common_8h-source.html#l00214">NLMISC::radToDeg</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_4" doxytag="NLSOUND::CSourceAL::setDirection"></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::CSourceAL::setDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>dir</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> +Set the direction vector (3D mode only) (default: (0,0,0) as non-directional). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_4">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00265">265</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::x</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::y</a>, and <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::z</a>. </td> + </tr> +</table> +<a name="z977_16" doxytag="NLSOUND::CSourceAL::setEAXProperty"></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::CSourceAL::setEAXProperty </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>prop</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>value</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>valuesize</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 any EAX source property if EAX available. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_16">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00411">411</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00828">value</a>. </td> + </tr> +</table> +<a name="z977_6" doxytag="NLSOUND::CSourceAL::setGain"></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::CSourceAL::setGain </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>gain</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> +Set the gain (volume value inside [0 , 1]) (default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_6">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00292">292</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z976_0" doxytag="NLSOUND::CSourceAL::setLooping"></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::CSourceAL::setLooping </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>l</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> +Set looping on/off for future playbacks (default: off). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z979_0">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00093">93</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="opcode__register_8cpp-source.html#l00036">NLAISCRIPT::l</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_12" doxytag="NLSOUND::CSourceAL::setMinMaxDistances"></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::CSourceAL::setMinMaxDistances </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname" nowrap> <em>mindist</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>maxdist</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>deferred</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 min and max distances (default: 1, MAX_FLOAT) (3D mode only). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_12">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00360">360</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_8" doxytag="NLSOUND::CSourceAL::setPitch"></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::CSourceAL::setPitch </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>pitch</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> +Shift the frequency. +<p> +1.0f equals identity, each reduction of 50% equals a pitch shift of one octave. 0 is not a legal value. +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_8">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00315">315</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_0" doxytag="NLSOUND::CSourceAL::setPos"></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::CSourceAL::setPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</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> +Set the position vector (default: (0,0,0)). +<p> +3D mode -> 3D position st mode -> x is the pan value (from left (-1) to right (1)), set y and z to 0 +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00213">213</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00156">_Pos</a>, <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::x</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::y</a>, and <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::z</a>. </td> + </tr> +</table> +<a name="z977_10" doxytag="NLSOUND::CSourceAL::setSourceRelativeMode"></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::CSourceAL::setSourceRelativeMode </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>mode</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> +Set the source relative mode. If true, positions are interpreted relative to the listener position (default: false). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_10">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00338">338</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. +<p> +Referenced by <a class="el" href="source__al_8cpp-source.html#l00064">setStaticBuffer</a>. </td> + </tr> +</table> +<a name="z975_0" doxytag="NLSOUND::CSourceAL::setStaticBuffer"></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::CSourceAL::setStaticBuffer </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>buffer</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> +Set the buffer that will be played (no streaming) If the buffer is stereo, the source mode becomes stereo and the source relative mode is on, otherwise the source is considered as a 3D source. +<p> +Set NULL to set "no buffer" +<p> +Reimplemented from <a class="el" href="classNLSOUND_1_1ISource.html#z978_0">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00064">64</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="source__al_8cpp-source.html#l00338">setSourceRelativeMode</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z977_2" doxytag="NLSOUND::CSourceAL::setVelocity"></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::CSourceAL::setVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>vel</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>deferred</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 velocity vector (3D mode only) (default: (0,0,0)). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z980_2">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00241">241</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::x</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::y</a>, and <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::z</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::CSourceAL::sourceName"></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"> ALuint NLSOUND::CSourceAL::sourceName </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]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the OpenAL source name. +<p> + +<p> +Definition at line <a class="el" href="source__al_8h-source.html#l00149">149</a> of file <a class="el" href="source__al_8h-source.html">source_al.h</a>. +<p> +References <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>. </td> + </tr> +</table> +<a name="z976_3" doxytag="NLSOUND::CSourceAL::stop"></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::CSourceAL::stop </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> +Stop playing. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z979_3">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00138">138</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. +<p> +References <a class="el" href="source_8h-source.html#l00167">NLSOUND::ISource::_Buffer</a>, <a class="el" href="source__al_8h-source.html#l00154">_SourceName</a>, <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>, and <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z976_7" doxytag="NLSOUND::CSourceAL::update"></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::CSourceAL::update </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> +Update the source (e.g. continue to stream the data in). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1ISource.html#z979_7">NLSOUND::ISource</a>. +<p> +Definition at line <a class="el" href="source__al_8cpp-source.html#l00202">202</a> of file <a class="el" href="source__al_8cpp-source.html">source_al.cpp</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o1" doxytag="NLSOUND::CSourceAL::_Pos"></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="classNLMISC_1_1CVector.html">NLMISC::CVector</a> NLSOUND::CSourceAL::_Pos<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="source__al_8h-source.html#l00156">156</a> of file <a class="el" href="source__al_8h-source.html">source_al.h</a>. +<p> +Referenced by <a class="el" href="source__al_8cpp-source.html#l00225">getPos</a>, and <a class="el" href="source__al_8cpp-source.html#l00213">setPos</a>. </td> + </tr> +</table> +<a name="o0" doxytag="NLSOUND::CSourceAL::_SourceName"></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"> ALuint NLSOUND::CSourceAL::_SourceName<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="source__al_8h-source.html#l00154">154</a> of file <a class="el" href="source__al_8h-source.html">source_al.h</a>. +<p> +Referenced by <a class="el" href="source__al_8cpp-source.html#l00396">getCone</a>, <a class="el" href="source__al_8cpp-source.html#l00276">getDirection</a>, <a class="el" href="source__al_8cpp-source.html#l00303">getGain</a>, <a class="el" href="source__al_8cpp-source.html#l00103">getLooping</a>, <a class="el" href="source__al_8cpp-source.html#l00372">getMinMaxDistances</a>, <a class="el" href="source__al_8cpp-source.html#l00326">getPitch</a>, <a class="el" href="source__al_8cpp-source.html#l00348">getSourceRelativeMode</a>, <a class="el" href="source__al_8cpp-source.html#l00252">getVelocity</a>, <a class="el" href="source__al_8cpp-source.html#l00178">isPlaying</a>, <a class="el" href="source__al_8cpp-source.html#l00190">isStopped</a>, <a class="el" href="source__al_8cpp-source.html#l00158">pause</a>, <a class="el" href="source__al_8cpp-source.html#l00115">play</a>, <a class="el" href="source__al_8cpp-source.html#l00383">setCone</a>, <a class="el" href="source__al_8cpp-source.html#l00265">setDirection</a>, <a class="el" href="source__al_8cpp-source.html#l00411">setEAXProperty</a>, <a class="el" href="source__al_8cpp-source.html#l00292">setGain</a>, <a class="el" href="source__al_8cpp-source.html#l00093">setLooping</a>, <a class="el" href="source__al_8cpp-source.html#l00360">setMinMaxDistances</a>, <a class="el" href="source__al_8cpp-source.html#l00315">setPitch</a>, <a class="el" href="source__al_8cpp-source.html#l00213">setPos</a>, <a class="el" href="source__al_8cpp-source.html#l00338">setSourceRelativeMode</a>, <a class="el" href="source__al_8cpp-source.html#l00064">setStaticBuffer</a>, <a class="el" href="source__al_8cpp-source.html#l00241">setVelocity</a>, <a class="el" href="source__al_8h-source.html#l00149">sourceName</a>, and <a class="el" href="source__al_8cpp-source.html#l00138">stop</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="source__al_8h-source.html">source_al.h</a><li><a class="el" href="source__al_8cpp-source.html">source_al.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> |