mirror of
https://github.com/thestk/stk
synced 2026-01-15 22:11:52 +00:00
Release 4.2.0 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
fe20fe92a2
commit
de344668dd
@@ -9,23 +9,28 @@
|
||||
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.3.4 -->
|
||||
<h1>Chorus Class Reference</h1>STK chorus effect class.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="Chorus_8h-source.html">Chorus.h</a>></code>
|
||||
<h1>Chorus Class Reference</h1><code>#include <<a class="el" href="Chorus_8h-source.html">Chorus.h</a>></code>
|
||||
<p>
|
||||
<p>Inheritance diagram for Chorus:
|
||||
<p><center><img src="classChorus.png" usemap="#Chorus_map" border="0" alt=""></center>
|
||||
<map name="Chorus_map">
|
||||
<area href="classEffect.html" alt="Effect" shape="rect" coords="0,56,53,80">
|
||||
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,53,24">
|
||||
</map>
|
||||
<a href="classChorus-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<a href="classChorus-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
STK chorus effect class.
|
||||
<p>
|
||||
This class implements a chorus effect.<p>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
|
||||
<p>
|
||||
|
||||
<p>
|
||||
Definition at line <a class="el" href="Chorus_8h-source.html#l00018">18</a> of file <a class="el" href="Chorus_8h-source.html">Chorus.h</a>.<table border=0 cellpadding=0 cellspacing=0>
|
||||
<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="Chorus::Chorus" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a0">Chorus</a> (MY_FLOAT baseDelay)</td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a0">Chorus</a> (StkFloat baseDelay=6000)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the longest desired delay length. <br><br></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the median desired delay length. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Chorus::~Chorus" ></a>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a1">~Chorus</a> ()</td></tr>
|
||||
|
||||
@@ -35,52 +40,106 @@ void </td><td class="memItemRight" valign=bottom><a class="el" href="classC
|
||||
|
||||
<tr><td class="mdescLeft"> </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="Chorus::setModDepth" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a3">setModDepth</a> (MY_FLOAT depth)</td></tr>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a3">setModDepth</a> (StkFloat depth)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set modulation depth. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Chorus::setModFrequency" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a4">setModFrequency</a> (MY_FLOAT frequency)</td></tr>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a4">setModFrequency</a> (StkFloat frequency)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set modulation frequency. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Chorus::setEffectMix" ></a>
|
||||
void </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a5">setEffectMix</a> (MY_FLOAT mix)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mixture of input and processed levels in the output (0.0 = input only, 1.0 = processed only). <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Chorus::lastOut" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a6">lastOut</a> () const </td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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="a7" doxytag="Chorus::lastOutLeft" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a7">lastOutLeft</a> () const </td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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="a8" doxytag="Chorus::lastOutRight" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a8">lastOutRight</a> () const </td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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="a9" doxytag="Chorus::tick" ></a>
|
||||
MY_FLOAT </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a9">tick</a> (MY_FLOAT input)</td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Chorus::tick" ></a>
|
||||
StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a5">tick</a> (StkFloat input)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute one output sample. <br><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="Chorus::tick" ></a>
|
||||
MY_FLOAT * </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a10">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Chorus::tick" ></a>
|
||||
StkFloat * </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a6">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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>
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classStkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classChorus.html#a7">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &frames, unsigned int channel=1)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the effect and replace with corresponding outputs. </em> <a href="#a7"></a><em><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
STK chorus effect class.
|
||||
<p>
|
||||
This class implements a chorus effect.<p>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
||||
<p>
|
||||
<hr><h2>Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" name="a0" doxytag="Chorus::Chorus" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> Chorus::Chorus </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">StkFloat </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>baseDelay</em> = 6000 </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>
|
||||
Definition at line <a class="el" href="Chorus_8h-source.html#l00018">18</a> of file <a class="el" href="Chorus_8h-source.html">Chorus.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
|
||||
Class constructor, taking the median desired delay length.
|
||||
<p>
|
||||
An <a class="el" href="classStkError.html">StkError</a> can be thrown if the rawwave path is incorrect. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" name="a7" doxytag="Chorus::tick" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<tr>
|
||||
<td class="mdRow">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md" nowrap valign="top"> <a class="el" href="classStkFrames.html">StkFrames</a>& Chorus::tick </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> & </td>
|
||||
<td class="mdname" nowrap> <em>frames</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td class="md" nowrap>unsigned int </td>
|
||||
<td class="mdname" nowrap> <em>channel</em> = 1</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>
|
||||
Take a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object as inputs to the effect and replace with corresponding outputs.
|
||||
<p>
|
||||
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object.
|
||||
<p>
|
||||
Reimplemented from <a class="el" href="classEffect.html#a9">Effect</a>. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="Chorus_8h-source.html">Chorus.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><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
<tr><td>©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user