mirror of
https://github.com/thestk/stk
synced 2026-01-12 12:31:53 +00:00
130 lines
8.4 KiB
HTML
130 lines
8.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"> <img src="mcgill.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="links.html">Links</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.3.4 -->
|
|
<h1>Effect Class Reference</h1><code>#include <<a class="el" href="Effect_8h-source.html">Effect.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Effect:
|
|
<p><center><img src="classEffect.png" usemap="#Effect_map" border="0" alt=""></center>
|
|
<map name="Effect_map">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="172,0,231,24">
|
|
<area href="classChorus.html" alt="Chorus" shape="rect" coords="0,112,59,136">
|
|
<area href="classEcho.html" alt="Echo" shape="rect" coords="69,112,128,136">
|
|
<area href="classJCRev.html" alt="JCRev" shape="rect" coords="138,112,197,136">
|
|
<area href="classNRev.html" alt="NRev" shape="rect" coords="207,112,266,136">
|
|
<area href="classPitShift.html" alt="PitShift" shape="rect" coords="276,112,335,136">
|
|
<area href="classPRCRev.html" alt="PRCRev" shape="rect" coords="345,112,404,136">
|
|
</map>
|
|
<a href="classEffect-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK abstract effects parent class.
|
|
<p>
|
|
This class provides common functionality for STK effects subclasses.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
|
|
<p>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="Effect_8h-source.html#l00017">17</a> of file <a class="el" href="Effect_8h-source.html">Effect.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="Effect::Effect" ></a>
|
|
</td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a0">Effect</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="Effect::~Effect" ></a>
|
|
virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a1">~Effect</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="Effect::clear" ></a>
|
|
virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a2">clear</a> ()=0</td></tr>
|
|
|
|
<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="Effect::setEffectMix" ></a>
|
|
void </td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a3">setEffectMix</a> (StkFloat mix)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mixture of input and "effected" 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="Effect::lastOut" ></a>
|
|
StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a4">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="a5" doxytag="Effect::lastOutLeft" ></a>
|
|
StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a5">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="a6" doxytag="Effect::lastOutRight" ></a>
|
|
StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a6">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="a7" doxytag="Effect::tick" ></a>
|
|
virtual StkFloat </td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a7">tick</a> (StkFloat input)=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </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="Effect::tick" ></a>
|
|
virtual StkFloat * </td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a8">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>virtual <a class="el" href="classStkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classEffect.html#a9">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="#a9"></a><em><br><br></td></tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="a9" doxytag="Effect::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"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>& Effect::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 in <a class="el" href="classChorus.html#a7">Chorus</a>, <a class="el" href="classEcho.html#a7">Echo</a>, <a class="el" href="classJCRev.html#a6">JCRev</a>, <a class="el" href="classNRev.html#a6">NRev</a>, <a class="el" href="classPitShift.html#a6">PitShift</a>, and <a class="el" href="classPRCRev.html#a6">PRCRev</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Effect_8h-source.html">Effect.h</a></ul>
|
|
<HR>
|
|
|
|
<table>
|
|
<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>
|
|
|
|
</BODY>
|
|
</HTML>
|