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

Release 4.2.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:39:37 +02:00
committed by Stephen Sinclair
parent fe20fe92a2
commit de344668dd
347 changed files with 16972 additions and 8538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
doc/html/classModulate.html
View File

@@ -9,23 +9,28 @@
<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.3.4 -->
<h1>Modulate Class Reference</h1>STK periodic/random modulator.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Modulate_8h-source.html">Modulate.h</a>&gt;</code>
<h1>Modulate Class Reference</h1><code>#include &lt;<a class="el" href="Modulate_8h-source.html">Modulate.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Modulate:
<p><center><img src="classModulate.png" usemap="#Modulate_map" border="0" alt=""></center>
<map name="Modulate_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,64,24">
<area href="classGenerator.html" alt="Generator" shape="rect" coords="0,56,69,80">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,69,24">
</map>
<a href="classModulate-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<a href="classModulate-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
STK periodic/random modulator.
<p>
This class combines random and periodic modulations to give a nice, natural human modulation function.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
<p>
<p>
Definition at line <a class="el" href="Modulate_8h-source.html#l00021">21</a> of file <a class="el" href="Modulate_8h-source.html">Modulate.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="Modulate::Modulate" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a0">Modulate</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a0">Modulate</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. </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="Modulate::~Modulate" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a1">~Modulate</a> ()</td></tr>
@@ -35,44 +40,109 @@ void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classM
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset internal state. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="Modulate::setVibratoRate" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a3">setVibratoRate</a> (MY_FLOAT aRate)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a3">setVibratoRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the periodic (vibrato) rate or frequency in Hz. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="Modulate::setVibratoGain" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a4">setVibratoGain</a> (MY_FLOAT aGain)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a4">setVibratoGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the periodic (vibrato) gain. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="Modulate::setRandomGain" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a5">setRandomGain</a> (MY_FLOAT aGain)</td></tr>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a5">setRandomGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the random modulation gain. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a6" doxytag="Modulate::tick" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a6">tick</a> ()</td></tr>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a6">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="a7" doxytag="Modulate::tick" ></a>
virtual MY_FLOAT *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a7">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a7">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return <em>vectorSize</em> outputs in <em>vector</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a8" doxytag="Modulate::lastOut" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a8">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute <em>vectorSize</em> 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> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModulate.html#a8">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last computed output value. <br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. </em> <a href="#a8"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK periodic/random modulator.
<p>
This class combines random and periodic modulations to give a nice, natural human modulation function.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="Modulate::Modulate" ></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"> Modulate::Modulate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Definition at line <a class="el" href="Modulate_8h-source.html#l00021">21</a> of file <a class="el" href="Modulate_8h-source.html">Modulate.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
Class constructor.
<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="a8" doxytag="Modulate::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>&amp; Modulate::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed 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="classGenerator.html#a5">Generator</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Modulate_8h-source.html">Modulate.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>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>