e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-18 15:11:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.1.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:37:27 +02:00
committed by Stephen Sinclair
parent d12ef806ac
commit 5d63b50e85
436 changed files with 17966 additions and 14506 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
doc/html/classReverb.html
View File

@@ -5,17 +5,17 @@
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"><P>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<h1>Reverb Class Reference</h1>STK abstract reverberator parent class.
<!-- Generated by Doxygen 1.3.6 -->
<h1>Reverb Class Reference</h1>STK abstract reverberator parent class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Reverb_8h-source.html">Reverb.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Reverb::
<p><center><img src="classReverb.gif" usemap="#Reverb_map" border="0"></center>
<p>Inheritance diagram for Reverb:
<p><center><img src="classReverb.png" usemap="#Reverb_map" border="0" alt=""></center>
<map name="Reverb_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="69,0,128,24">
<area href="classJCRev.html" alt="JCRev" shape="rect" coords="0,112,59,136">
@@ -23,49 +23,60 @@
<area href="classPRCRev.html" alt="PRCRev" shape="rect" coords="138,112,197,136">
</map>
<a href="classReverb-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><a name="a0" doxytag="Reverb::Reverb"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classReverb.html#a0">Reverb</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class constructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Reverb::~Reverb"></a>
virtual&nbsp;</td><td valign=bottom><a class="el" href="classReverb.html#a1">~Reverb</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="Reverb::clear"></a>
virtual void&nbsp;</td><td valign=bottom><a class="el" href="classReverb.html#a2">clear</a> ()=0</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Reset and clear all internal state.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Reverb::setEffectMix"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classReverb.html#a3">setEffectMix</a> (MY_FLOAT mix)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the mixture of input and "reverberated" levels in the output (0.0 = input only, 1.0 = reverb only).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Reverb::lastOut"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classReverb.html#a4">lastOut</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the last output value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Reverb::lastOutLeft"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classReverb.html#a5">lastOutLeft</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the last left output value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Reverb::lastOutRight"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classReverb.html#a6">lastOutRight</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the last right output value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Reverb::tick"></a>
virtual MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classReverb.html#a7">tick</a> (MY_FLOAT input)=0</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Abstract tick function ... must be implemented in subclasses.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Reverb::tick"></a>
virtual MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classReverb.html#a8">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Take <em>vectorSize</em> inputs, compute the same number of outputs and return them in <em>vector</em>.</em></font><br><br></td></tr>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="Reverb::Reverb" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReverb.html#a0">Reverb</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Reverb::~Reverb" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReverb.html#a1">~Reverb</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="Reverb::clear" ></a>
virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReverb.html#a2">clear</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset and clear all internal state. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Reverb::setEffectMix" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReverb.html#a3">setEffectMix</a> (MY_FLOAT mix)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the mixture of input and "reverberated" levels in the output (0.0 = input only, 1.0 = reverb only). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Reverb::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReverb.html#a4">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Reverb::lastOutLeft" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReverb.html#a5">lastOutLeft</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last left output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Reverb::lastOutRight" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReverb.html#a6">lastOutRight</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last right output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a7" doxytag="Reverb::tick" ></a>
virtual MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReverb.html#a7">tick</a> (MY_FLOAT input)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Abstract tick function ... must be implemented in subclasses. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Reverb::tick" ></a>
virtual MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classReverb.html#a8">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Take <em>vectorSize</em> inputs, compute the same number of outputs and return them in <em>vector</em>. <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK abstract reverberator parent class.
<p>
This class provides common functionality for STK reverberator subclasses.
STK abstract reverberator parent class.
<p>
This class provides common functionality for STK reverberator subclasses.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr>The documentation for this class was generated from the following file:<ul>
<p>
Definition at line <a class="el" href="Reverb_8h-source.html#l00017">17</a> of file <a class="el" href="Reverb_8h-source.html">Reverb.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Reverb_8h-source.html">Reverb.h</a></ul>
<HR>
<table>
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>