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

Release 4.4.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:48:48 +02:00
committed by Stephen Sinclair
parent c37de52787
commit 7fcf920d3e
711 changed files with 28790 additions and 16452 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
doc/html/classstk_1_1Generator.html
View File

@@ -8,67 +8,63 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.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="links.html">Links</a> &nbsp; <a class="qindex" href="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.5.8 -->
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Generator.html">Generator</a>
</div>
<div class="contents">
<h1>stk::Generator Class Reference</h1><!-- doxytag: class="stk::Generator" --><!-- doxytag: inherits="stk::Stk" -->STK abstract unit generator parent class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Generator_8h-source.html">Generator.h</a>&gt;</code>
<p>
<h1>stk::Generator Class Reference</h1><!-- doxytag: class="stk::Generator" --><!-- doxytag: inherits="stk::Stk" -->
<p>STK abstract unit generator parent class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Generator_8h_source.html">Generator.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::Generator:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1Generator.png" usemap="#stk::Generator_map" border="0" alt=""></center>
<map name="stk::Generator_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,90,24">
<area href="classstk_1_1ADSR.html" alt="stk::ADSR" shape="rect" coords="100,112,190,136">
<area href="classstk_1_1Asymp.html" alt="stk::Asymp" shape="rect" coords="100,168,190,192">
<area href="classstk_1_1Blit.html" alt="stk::Blit" shape="rect" coords="100,224,190,248">
<area href="classstk_1_1BlitSaw.html" alt="stk::BlitSaw" shape="rect" coords="100,280,190,304">
<area href="classstk_1_1BlitSquare.html" alt="stk::BlitSquare" shape="rect" coords="100,336,190,360">
<area href="classstk_1_1Envelope.html" alt="stk::Envelope" shape="rect" coords="100,392,190,416">
<area href="classstk_1_1Granulate.html" alt="stk::Granulate" shape="rect" coords="100,448,190,472">
<area href="classstk_1_1Modulate.html" alt="stk::Modulate" shape="rect" coords="100,504,190,528">
<area href="classstk_1_1Noise.html" alt="stk::Noise" shape="rect" coords="100,560,190,584">
<area href="classstk_1_1SineWave.html" alt="stk::SineWave" shape="rect" coords="100,616,190,640">
<area href="classstk_1_1SingWave.html" alt="stk::SingWave" shape="rect" coords="100,672,190,696">
<div class="center">
<img src="classstk_1_1Generator.png" usemap="#stk::Generator_map" alt=""/>
<map id="stk::Generator_map" name="stk::Generator_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,90,24"/>
<area href="classstk_1_1ADSR.html" alt="stk::ADSR" shape="rect" coords="100,112,190,136"/>
<area href="classstk_1_1Asymp.html" alt="stk::Asymp" shape="rect" coords="100,168,190,192"/>
<area href="classstk_1_1Blit.html" alt="stk::Blit" shape="rect" coords="100,224,190,248"/>
<area href="classstk_1_1BlitSaw.html" alt="stk::BlitSaw" shape="rect" coords="100,280,190,304"/>
<area href="classstk_1_1BlitSquare.html" alt="stk::BlitSquare" shape="rect" coords="100,336,190,360"/>
<area href="classstk_1_1Envelope.html" alt="stk::Envelope" shape="rect" coords="100,392,190,416"/>
<area href="classstk_1_1Granulate.html" alt="stk::Granulate" shape="rect" coords="100,448,190,472"/>
<area href="classstk_1_1Modulate.html" alt="stk::Modulate" shape="rect" coords="100,504,190,528"/>
<area href="classstk_1_1Noise.html" alt="stk::Noise" shape="rect" coords="100,560,190,584"/>
<area href="classstk_1_1SineWave.html" alt="stk::SineWave" shape="rect" coords="100,616,190,640"/>
<area href="classstk_1_1SingWave.html" alt="stk::SingWave" shape="rect" coords="100,672,190,696"/>
</map>
</div>
</div>
<p>
<a href="classstk_1_1Generator-members.html">List of all members.</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="c7f11d287fb903b04985c2f81dbf9a5d"></a><!-- doxytag: member="stk::Generator::Generator" ref="c7f11d287fb903b04985c2f81dbf9a5d" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Generator.html#c7f11d287fb903b04985c2f81dbf9a5d">Generator</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9f9de4c495217ef8490a9d2d1fdabe11"></a><!-- doxytag: member="stk::Generator::channelsOut" ref="9f9de4c495217ef8490a9d2d1fdabe11" args="(void) const " -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Generator.html#9f9de4c495217ef8490a9d2d1fdabe11">channelsOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of output channels for the class. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="499ad65aa6d939983863ffb922008654"></a><!-- doxytag: member="stk::Generator::lastFrame" ref="499ad65aa6d939983863ffb922008654" args="(void) const " -->
const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Generator.html#499ad65aa6d939983863ffb922008654">lastFrame</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> reference to the last output sample frame. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Generator.html#86bb0421223cf27e25704d5f27b97425">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed sample frames, starting at the specified channel. <a href="#86bb0421223cf27e25704d5f27b97425"></a><br></td></tr>
<p><a href="classstk_1_1Generator-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7f11d287fb903b04985c2f81dbf9a5d"></a><!-- doxytag: member="stk::Generator::Generator" ref="ac7f11d287fb903b04985c2f81dbf9a5d" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Generator.html#ac7f11d287fb903b04985c2f81dbf9a5d">Generator</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f9de4c495217ef8490a9d2d1fdabe11"></a><!-- doxytag: member="stk::Generator::channelsOut" ref="a9f9de4c495217ef8490a9d2d1fdabe11" args="(void) const " -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Generator.html#a9f9de4c495217ef8490a9d2d1fdabe11">channelsOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of output channels for the class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a499ad65aa6d939983863ffb922008654"></a><!-- doxytag: member="stk::Generator::lastFrame" ref="a499ad65aa6d939983863ffb922008654" args="(void) const " -->
const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Generator.html#a499ad65aa6d939983863ffb922008654">lastFrame</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> reference to the last output sample frame. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Generator.html#a86bb0421223cf27e25704d5f27b97425">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed sample frames, starting at the specified channel. <a href="#a86bb0421223cf27e25704d5f27b97425"></a><br/></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK abstract unit generator parent class.
<p>
This class provides limited common functionality for STK unit generator sample-source subclasses. It is general enough to support both monophonic and polyphonic output classes.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="86bb0421223cf27e25704d5f27b97425"></a><!-- doxytag: member="stk::Generator::tick" ref="86bb0421223cf27e25704d5f27b97425" args="(StkFrames &amp;frames, unsigned int channel=0)=0" -->
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK abstract unit generator parent class. </p>
<p>This class provides limited common functionality for STK unit generator sample-source subclasses. It is general enough to support both monophonic and polyphonic output classes.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a86bb0421223cf27e25704d5f27b97425"></a><!-- doxytag: member="stk::Generator::tick" ref="a86bb0421223cf27e25704d5f27b97425" args="(StkFrames &amp;frames, unsigned int channel=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a>&amp; stk::Generator::tick </td>
<td class="memname">virtual <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a>&amp; stk::Generator::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>frames</em>, </td>
@@ -88,22 +84,22 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Docum
</div>
<div class="memdoc">
<p>
Fill the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed sample frames, starting at the specified channel.
<p>
The <code>channel</code> argument plus the number of output channels must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception.
<p>Implemented in <a class="el" href="classstk_1_1ADSR.html#97a617c65e62aadb4f88bd10cf437a6a">stk::ADSR</a>, <a class="el" href="classstk_1_1Asymp.html#2647bc013816f026915b1e92ddd6a322">stk::Asymp</a>, <a class="el" href="classstk_1_1Blit.html#20a3634131ff890641931c1d04df19ad">stk::Blit</a>, <a class="el" href="classstk_1_1BlitSaw.html#b53f6ba99ef5c4f8982f6c0f07bf2e1d">stk::BlitSaw</a>, <a class="el" href="classstk_1_1BlitSquare.html#7df894d40b3d6effbb2a09819356258d">stk::BlitSquare</a>, <a class="el" href="classstk_1_1Envelope.html#9341c9dea4fd54c360a4a23254319cf7">stk::Envelope</a>, <a class="el" href="classstk_1_1Granulate.html#a9cc119b1515c5596a95d72f4b65b0c0">stk::Granulate</a>, <a class="el" href="classstk_1_1Modulate.html#942eee1bb78318e1b59afeb311748b2d">stk::Modulate</a>, <a class="el" href="classstk_1_1Noise.html#2f92e91787dc19309305cf246632cd50">stk::Noise</a>, <a class="el" href="classstk_1_1SineWave.html#f205d7029046af8a392341cabd58f9de">stk::SineWave</a>, and <a class="el" href="classstk_1_1SingWave.html#b74d7a305510eec92a9aa1a26bcb5e94">stk::SingWave</a>.</p>
<p>Fill the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed sample frames, starting at the specified channel. </p>
<p>The <code>channel</code> argument plus the number of output channels must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
<p>Implemented in <a class="el" href="classstk_1_1ADSR.html#a97a617c65e62aadb4f88bd10cf437a6a">stk::ADSR</a>, <a class="el" href="classstk_1_1Asymp.html#a2647bc013816f026915b1e92ddd6a322">stk::Asymp</a>, <a class="el" href="classstk_1_1Blit.html#a20a3634131ff890641931c1d04df19ad">stk::Blit</a>, <a class="el" href="classstk_1_1BlitSaw.html#ab53f6ba99ef5c4f8982f6c0f07bf2e1d">stk::BlitSaw</a>, <a class="el" href="classstk_1_1BlitSquare.html#a7df894d40b3d6effbb2a09819356258d">stk::BlitSquare</a>, <a class="el" href="classstk_1_1Envelope.html#a9341c9dea4fd54c360a4a23254319cf7">stk::Envelope</a>, <a class="el" href="classstk_1_1Granulate.html#aa9cc119b1515c5596a95d72f4b65b0c0">stk::Granulate</a>, <a class="el" href="classstk_1_1Modulate.html#a942eee1bb78318e1b59afeb311748b2d">stk::Modulate</a>, <a class="el" href="classstk_1_1Noise.html#a2f92e91787dc19309305cf246632cd50">stk::Noise</a>, <a class="el" href="classstk_1_1SineWave.html#af205d7029046af8a392341cabd58f9de">stk::SineWave</a>, and <a class="el" href="classstk_1_1SingWave.html#ab74d7a305510eec92a9aa1a26bcb5e94">stk::SingWave</a>.</p>
</div>
</div><p>
<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>
</div>
<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></li>
</ul>
</div>
<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>&copy;1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>