mirror of
https://github.com/thestk/stk
synced 2026-01-12 20:41:52 +00:00
76 lines
5.4 KiB
HTML
76 lines
5.4 KiB
HTML
<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"> <img src="ccrma.gif"><P>
|
|
<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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>Simple Class Reference</h1>STK wavetable/noise instrument.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Simple_8h-source.html">Simple.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Simple::
|
|
<p><center><img src="classSimple.gif" usemap="#Simple_map" border="0"></center>
|
|
<map name="Simple_map">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,55,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,55,24">
|
|
</map>
|
|
<a href="classSimple-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="Simple::Simple"></a>
|
|
</td><td valign=bottom><a class="el" href="classSimple.html#a0">Simple</a> ()</td></tr>
|
|
<tr><td> </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="Simple::~Simple"></a>
|
|
virtual </td><td valign=bottom><a class="el" href="classSimple.html#a1">~Simple</a> ()</td></tr>
|
|
<tr><td> </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="Simple::clear"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSimple.html#a2">clear</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Clear internal states.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Simple::setFrequency"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classSimple.html#a3">setFrequency</a> (MY_FLOAT frequency)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set instrument parameters for a particular frequency.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Simple::keyOn"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSimple.html#a4">keyOn</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Start envelope toward "on" target.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Simple::keyOff"></a>
|
|
void </td><td valign=bottom><a class="el" href="classSimple.html#a5">keyOff</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Start envelope toward "off" target.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a6" doxytag="Simple::noteOn"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classSimple.html#a6">noteOn</a> (MY_FLOAT frequency, MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Start a note with the given frequency and amplitude.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Simple::noteOff"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classSimple.html#a7">noteOff</a> (MY_FLOAT amplitude)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Stop a note with the given amplitude (speed of decay).</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Simple::tick"></a>
|
|
virtual MY_FLOAT </td><td valign=bottom><a class="el" href="classSimple.html#a8">tick</a> ()</td></tr>
|
|
<tr><td> </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="a9" doxytag="Simple::controlChange"></a>
|
|
virtual void </td><td valign=bottom><a class="el" href="classSimple.html#a9">controlChange</a> (int number, MY_FLOAT value)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0).</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK wavetable/noise instrument.
|
|
<p>
|
|
This class combines a looped wave, a noise source, a biquad resonance filter, a one-pole filter, and an <a class="el" href="classADSR.html">ADSR</a> envelope to create some interesting sounds.
|
|
<p>
|
|
Control Change Numbers: <ul>
|
|
<li><a class="el" href="classFilter.html">Filter</a> Pole Position = 2<li><a class="el" href="classNoise.html">Noise</a>/Pitched Cross-Fade = 4<li><a class="el" href="classEnvelope.html">Envelope</a> Rate = 11<li>Gain = 128</ul>
|
|
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="Simple_8h-source.html">Simple.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>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|