mirror of
https://github.com/thestk/stk
synced 2026-01-13 21:11:53 +00:00
108 lines
6.6 KiB
HTML
108 lines
6.6 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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.4.4 -->
|
|
<h1>Generator Class Reference</h1><!-- doxytag: class="Generator" --><!-- doxytag: inherits="Stk" --><code>#include <<a class="el" href="Generator_8h-source.html">Generator.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Generator:
|
|
<p><center><img src="classGenerator.png" usemap="#Generator_map" border="0" alt=""></center>
|
|
<map name="Generator_map">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,69,24">
|
|
<area href="classBlit.html" alt="Blit" shape="rect" coords="79,112,148,136">
|
|
<area href="classBlitSaw.html" alt="BlitSaw" shape="rect" coords="79,168,148,192">
|
|
<area href="classBlitSquare.html" alt="BlitSquare" shape="rect" coords="79,224,148,248">
|
|
<area href="classEnvelope.html" alt="Envelope" shape="rect" coords="79,280,148,304">
|
|
<area href="classGranulate.html" alt="Granulate" shape="rect" coords="79,336,148,360">
|
|
<area href="classModulate.html" alt="Modulate" shape="rect" coords="79,392,148,416">
|
|
<area href="classNoise.html" alt="Noise" shape="rect" coords="79,448,148,472">
|
|
<area href="classSineWave.html" alt="SineWave" shape="rect" coords="79,504,148,528">
|
|
<area href="classSingWave.html" alt="SingWave" shape="rect" coords="79,560,148,584">
|
|
</map>
|
|
<a href="classGenerator-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK abstract unit generator parent class.
|
|
<p>
|
|
This class provides common functionality for STK unit generator sample-source subclasses.<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2007.
|
|
<p>
|
|
<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"></a><!-- doxytag: member="Generator::Generator" ref="a0" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classGenerator.html#a0">Generator</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Generator::~Generator" ref="a1" args="(void)" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGenerator.html#a1">~Generator</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="Generator::lastOut" ref="a2" args="(void) const " -->
|
|
virtual StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classGenerator.html#a2">lastOut</a> (void) const </td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the last output value. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Generator::tick" ref="a3" args="(void)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classGenerator.html#a3">tick</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute one sample and output. <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="classGenerator.html#a4">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &frames, unsigned int channel=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. <a href="#a4"></a><br></td></tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="a4"></a><!-- doxytag: member="Generator::tick" ref="a4" args="(StkFrames &frames, unsigned int channel=0)" --><p>
|
|
<table class="mdTable" 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>& Generator::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 class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>unsigned int </td>
|
|
<td class="mdname" nowrap> <em>channel</em> = <code>0</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</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 zero or greater (the first channel is specified by 0). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is equal to or greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Generator_8h-source.html">Generator.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-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|