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

Release 4.0 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:33:56 +02:00
committed by Stephen Sinclair
parent 81475b04c5
commit 43dcd5775a
310 changed files with 60414 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
doc/html/classModulate.html Normal file
View File

@@ -0,0 +1,69 @@
<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.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="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
<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>
<p>
<p>Inheritance diagram for Modulate::
<p><center><img src="classModulate.gif" usemap="#Modulate_map" border="0"></center>
<map name="Modulate_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,64,24">
</map>
<a href="classModulate-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="Modulate::Modulate"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classModulate.html#a0">Modulate</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="Modulate::~Modulate"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classModulate.html#a1">~Modulate</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="Modulate::reset"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classModulate.html#a2">reset</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Reset internal state.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Modulate::setVibratoRate"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classModulate.html#a3">setVibratoRate</a> (MY_FLOAT aRate)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the periodic (vibrato) rate or frequency in Hz.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Modulate::setVibratoGain"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classModulate.html#a4">setVibratoGain</a> (MY_FLOAT aGain)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the periodic (vibrato) gain.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Modulate::setRandomGain"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classModulate.html#a5">setRandomGain</a> (MY_FLOAT aGain)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set the random modulation gain.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Modulate::tick"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classModulate.html#a6">tick</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Compute one output sample.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Modulate::tick"></a>
virtual MY_FLOAT*&nbsp;</td><td valign=bottom><a class="el" href="classModulate.html#a7">tick</a> (MY_FLOAT *vector, unsigned int vectorSize)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return <em>vectorSize</em> outputs in <em>vector</em>.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Modulate::lastOut"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classModulate.html#a8">lastOut</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the last computed output value.</em></font><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>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>&copy;1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>