diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1ISource.html | 1381 |
1 files changed, 1381 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1ISource.html b/docs/doxygen/nel/classNLSOUND_1_1ISource.html new file mode 100644 index 00000000..66c41c9e --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1ISource.html @@ -0,0 +1,1381 @@ +<!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::ISource Class Reference</h1>Sound source interface (implemented in sound driver dynamic library). +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="source_8h-source.html">source.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::ISource: +<p><center><img src="classNLSOUND_1_1ISource.gif" usemap="#NLSOUND::ISource_map" border="0"></center> +<map name="NLSOUND::ISource_map"> +<area href="classNLSOUND_1_1CSourceAL.html" alt="NLSOUND::CSourceAL" shape="rect" coords="0,56,173,80"> +<area href="classNLSOUND_1_1CSourceDSound.html" alt="NLSOUND::CSourceDSound" shape="rect" coords="183,56,356,80"> +</map> +<a href="classNLSOUND_1_1ISource-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_1ISource.html#a0">ISource</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_1ISource.html#a1">~ISource</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 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_1ISource.html#z978_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="#z978_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1ISource.html#z978_1">getStaticBuffer</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the buffer, or NULL if streaming is used.</em> <a href="#z978_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_1ISource.html#z978_2">setStreamLoader</a> (<a class="el" href="classNLSOUND_1_1ILoader.html">ILoader</a> *loader)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the sound loader that will be used to stream in the data to play 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="#z978_2">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_1ISource.html#z979_0">setLooping</a> (bool l)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set looping on/off for future playbacks (default: off).</em> <a href="#z979_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_1ISource.html#z979_1">getLooping</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the looping state.</em> <a href="#z979_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_1ISource.html#z979_2">play</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Play the static buffer (or stream in and play).</em> <a href="#z979_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_1ISource.html#z979_3">stop</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing.</em> <a href="#z979_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_1ISource.html#z979_4">pause</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Pause. Call <a class="el" href="classNLSOUND_1_1ISource.html#z979_2">play</a>() to resume.</em> <a href="#z979_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_1ISource.html#z979_5">isPlaying</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the playing state.</em> <a href="#z979_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_1ISource.html#z979_6">isStopped</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if playing is finished or <a class="el" href="classNLSOUND_1_1ISource.html#z979_3">stop</a>() has been called.</em> <a href="#z979_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_1ISource.html#z979_7">update</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Update the source (e.g. continue to stream the data in).</em> <a href="#z979_7">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_1ISource.html#z979_8">getTime</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the number of milliseconds the source has been playing.</em> <a href="#z979_8">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_1ISource.html#z980_0">setPos</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &pos, bool deffered=true)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the position vector (default: (0,0,0)).</em> <a href="#z980_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_1ISource.html#z980_1">getPos</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the position vector.</em> <a href="#z980_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_1ISource.html#z980_2">setVelocity</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel, bool deferred=true)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)).</em> <a href="#z980_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_1ISource.html#z980_3">getVelocity</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the velocity vector.</em> <a href="#z980_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_1ISource.html#z980_4">setDirection</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &dir)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the direction vector (3D mode only, ignored in stereo mode) (default: (0,0,0) as non-directional).</em> <a href="#z980_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_1ISource.html#z980_5">getDirection</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &dir) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the direction vector.</em> <a href="#z980_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_1ISource.html#z980_6">setGain</a> (float gain)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the gain (volume value inside [0 , 1]).</em> <a href="#z980_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_1ISource.html#z980_7">getGain</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the gain.</em> <a href="#z980_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_1ISource.html#z980_8">setPitch</a> (float pitch)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Shift the frequency.</em> <a href="#z980_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_1ISource.html#z980_9">getPitch</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the pitch.</em> <a href="#z980_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_1ISource.html#z980_10">setSourceRelativeMode</a> (bool mode)=0</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.</em> <a href="#z980_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_1ISource.html#z980_11">getSourceRelativeMode</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the source relative mode.</em> <a href="#z980_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_1ISource.html#z980_12">setMinMaxDistances</a> (float mindist, float maxdist, bool deferred=true)=0</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="#z980_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_1ISource.html#z980_13">getMinMaxDistances</a> (float &mindist, float &maxdist) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the min and max distances.</em> <a href="#z980_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_1ISource.html#z980_14">setCone</a> (float innerAngle, float outerAngle, float outerGain)=0</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).</em> <a href="#z980_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_1ISource.html#z980_15">getCone</a> (float &innerAngle, float &outerAngle, float &outerGain) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the cone angles (in radian).</em> <a href="#z980_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_1ISource.html#z980_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)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set any EAX source property if EAX available.</em> <a href="#z980_16">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_1ISource.html#z980_17">setAlpha</a> (double a)</td></tr> +<tr><td> </td><td><font size=-1><em>Testing.</em> <a href="#z980_17">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1ISource.html#n0">_Buffer</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1ILoader.html">ILoader</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1ISource.html#n1">_Loader</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Sound source interface (implemented in sound driver dynamic library). +<p> +<ul> +<li>If the buffer is mono, the source is played in 3D mode. For arguments as 3D vectors, use the NeL vector coordinate system: <div class="fragment"><pre> + * (top) + * z + * | y (front) + * | / + * -----x (right) + * </pre></div></ul> +<ul> +<li>If the buffer is stereo, the source is played in stereo mode.</ul> +<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_8h-source.html#l00059">59</a> of file <a class="el" href="source_8h-source.html">source.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::ISource::ISource"></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::ISource::ISource </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> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="source_8h-source.html#l00159">159</a> of file <a class="el" href="source_8h-source.html">source.h</a>. +<p> +References <a class="el" href="source_8h-source.html#l00167">_Buffer</a>, and <a class="el" href="source_8h-source.html#l00170">_Loader</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::ISource::~ISource"></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 NLSOUND::ISource::~ISource </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> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="source_8h-source.html#l00162">162</a> of file <a class="el" href="source_8h-source.html">source.h</a>. +<p> +References <a class="el" href="source_8h-source.html#l00167">_Buffer</a>, and <a class="el" href="source_8h-source.html#l00170">_Loader</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="z980_15" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_15">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_5" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_5">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_7" doxytag="NLSOUND::ISource::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"> virtual float NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_7">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z979_1" doxytag="NLSOUND::ISource::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"> virtual bool NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z969_1">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_13" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_13">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_9" doxytag="NLSOUND::ISource::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"> virtual float NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_9">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_1" doxytag="NLSOUND::ISource::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"> virtual const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& NLSOUND::ISource::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> [pure 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_1ISource.html#z980_0">setPos</a>() for details. +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_1">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_11" doxytag="NLSOUND::ISource::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"> virtual bool NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_11">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z978_1" doxytag="NLSOUND::ISource::getStaticBuffer"></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="classNLSOUND_1_1IBuffer.html">IBuffer</a>* NLSOUND::ISource::getStaticBuffer </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 the buffer, or NULL if streaming is used. +<p> + +<p> +Definition at line <a class="el" href="source_8h-source.html#l00071">71</a> of file <a class="el" href="source_8h-source.html">source.h</a>. +<p> +References <a class="el" href="source_8h-source.html#l00167">_Buffer</a>. </td> + </tr> +</table> +<a name="z979_8" doxytag="NLSOUND::ISource::getTime"></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::ISource::getTime </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> +Returns the number of milliseconds the source has been playing. +<p> + +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z969_10">NLSOUND::CSourceDSound</a>. +<p> +Definition at line <a class="el" href="source_8h-source.html#l00101">101</a> of file <a class="el" href="source_8h-source.html">source.h</a>. </td> + </tr> +</table> +<a name="z980_3" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_3">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z979_5" doxytag="NLSOUND::ISource::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"> virtual bool NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z969_5">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z979_6" doxytag="NLSOUND::ISource::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"> virtual bool NLSOUND::ISource::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> [pure 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_1ISource.html#z979_3">stop</a>() has been called. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z969_6">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z979_4" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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_1ISource.html#z979_2">play</a>() to resume. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z969_4">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z979_2" doxytag="NLSOUND::ISource::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"> virtual bool NLSOUND::ISource::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> [pure 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> +This method can return false if the sample for this sound is unloaded. +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z969_2">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_17" doxytag="NLSOUND::ISource::setAlpha"></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::ISource::setAlpha </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">double </td> + <td class="mdname1" valign="top" nowrap> <em>a</em> </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> +Testing. +<p> + +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#a7">NLSOUND::CSourceDSound</a>. +<p> +Definition at line <a class="el" href="source_8h-source.html#l00154">154</a> of file <a class="el" href="source_8h-source.html">source.h</a>. </td> + </tr> +</table> +<a name="z980_14" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_14">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_4" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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, ignored in stereo mode) (default: (0,0,0) as non-directional). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_4">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_16" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_16">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_6" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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]). +<p> +(default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_6">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z979_0" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z969_0">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_12" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_12">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_8" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_8">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_0" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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="mdname" nowrap> <em>pos</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>deffered</em> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_0">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z980_10" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_10">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z978_0" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [inline, 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> + +<p> +Reimplemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z968_0">NLSOUND::CSourceDSound</a>. +<p> +Definition at line <a class="el" href="source_8h-source.html#l00069">69</a> of file <a class="el" href="source_8h-source.html">source.h</a>. +<p> +References <a class="el" href="source_8h-source.html#l00167">_Buffer</a>. </td> + </tr> +</table> +<a name="z978_2" doxytag="NLSOUND::ISource::setStreamLoader"></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::ISource::setStreamLoader </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1ILoader.html">ILoader</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>loader</em> </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> +Set the sound loader that will be used to stream in the data to play 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> + +<p> +Definition at line <a class="el" href="source_8h-source.html#l00076">76</a> of file <a class="el" href="source_8h-source.html">source.h</a>. +<p> +References <a class="el" href="source_8h-source.html#l00170">_Loader</a>. </td> + </tr> +</table> +<a name="z980_2" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure 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, ignored in stereo mode) (default: (0,0,0)). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z970_2">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z979_3" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Stop playing. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z969_3">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<a name="z979_7" doxytag="NLSOUND::ISource::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"> virtual void NLSOUND::ISource::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> [pure 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> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceDSound.html#z969_8">NLSOUND::CSourceDSound</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n0" doxytag="NLSOUND::ISource::_Buffer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a>* NLSOUND::ISource::_Buffer<code> [protected]</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_8h-source.html#l00167">167</a> of file <a class="el" href="source_8h-source.html">source.h</a>. +<p> +Referenced by <a class="el" href="source__dsound_8cpp-source.html#l01618">NLSOUND::CSourceDSound::crossFade</a>, <a class="el" href="source__dsound_8cpp-source.html#l02065">NLSOUND::CSourceDSound::fadeIn</a>, <a class="el" href="source__dsound_8cpp-source.html#l01881">NLSOUND::CSourceDSound::fadeOut</a>, <a class="el" href="source__dsound_8cpp-source.html#l01186">NLSOUND::CSourceDSound::fill</a>, <a class="el" href="source__dsound_8cpp-source.html#l01088">NLSOUND::CSourceDSound::getBuffer</a>, <a class="el" href="source__dsound_8cpp-source.html#l01524">NLSOUND::CSourceDSound::getFadeOutSize</a>, <a class="el" href="source__dsound_8cpp-source.html#l00778">NLSOUND::CSourceDSound::getPitch</a>, <a class="el" href="source_8h-source.html#l00071">getStaticBuffer</a>, <a class="el" href="source_8h-source.html#l00159">ISource</a>, <a class="el" href="source__al_8cpp-source.html#l00158">NLSOUND::CSourceAL::pause</a>, <a class="el" href="source__dsound_8cpp-source.html#l00335">NLSOUND::CSourceDSound::play</a>, <a class="el" href="source__al_8cpp-source.html#l00115">NLSOUND::CSourceAL::play</a>, <a class="el" href="source__dsound_8cpp-source.html#l00143">NLSOUND::CSourceDSound::release</a>, <a class="el" href="source__dsound_8cpp-source.html#l00752">NLSOUND::CSourceDSound::setPitch</a>, <a class="el" href="source__dsound_8cpp-source.html#l00283">NLSOUND::CSourceDSound::setStaticBuffer</a>, <a class="el" href="source_8h-source.html#l00069">setStaticBuffer</a>, <a class="el" href="source__al_8cpp-source.html#l00138">NLSOUND::CSourceAL::stop</a>, <a class="el" href="source__dsound_8cpp-source.html#l00325">NLSOUND::CSourceDSound::swap</a>, and <a class="el" href="source_8h-source.html#l00162">~ISource</a>. </td> + </tr> +</table> +<a name="n1" doxytag="NLSOUND::ISource::_Loader"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLSOUND_1_1ILoader.html">ILoader</a>* NLSOUND::ISource::_Loader<code> [protected]</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_8h-source.html#l00170">170</a> of file <a class="el" href="source_8h-source.html">source.h</a>. +<p> +Referenced by <a class="el" href="source_8h-source.html#l00159">ISource</a>, <a class="el" href="source_8h-source.html#l00076">setStreamLoader</a>, and <a class="el" href="source_8h-source.html#l00162">~ISource</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="source_8h-source.html">source.h</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> |