forked from pschatzmann/arduino-stk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGenerator_8h_source.html
88 lines (88 loc) · 10.2 KB
/
Generator_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arduino STK: Generator.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino STK
 <span id="projectnumber">4.6.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Generator.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef STK_GENERATOR_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define STK_GENERATOR_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "Stk.h"</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="keyword">namespace </span><a class="code" href="namespacestk.html">stk</a> {</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/***************************************************/</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classstk_1_1Generator.html"> 20</a></span> <span class="keyword">class </span><a class="code" href="classstk_1_1Generator.html">Generator</a> : <span class="keyword">public</span> <a class="code" href="classstk_1_1Stk.html">Stk</a></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classstk_1_1Generator.html#ac7f11d287fb903b04985c2f81dbf9a5d"> 25</a></span>  <a class="code" href="classstk_1_1Generator.html#ac7f11d287fb903b04985c2f81dbf9a5d">Generator</a>( <span class="keywordtype">void</span> ) { lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#a386e1b86cf48f7a8117313f9e41fc0fe">resize</a>( 1, 1, 0.0 ); };</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classstk_1_1Generator.html#ade296275a459b23c2cb97a6884929589"> 28</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classstk_1_1Generator.html#ade296275a459b23c2cb97a6884929589">channelsOut</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> lastFrame_.<a class="code" href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">channels</a>(); };</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classstk_1_1Generator.html#a57f4d954b55e454c48efc5915649d4be"> 31</a></span>  <span class="keyword">const</span> <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& <a class="code" href="classstk_1_1Generator.html#a57f4d954b55e454c48efc5915649d4be">lastFrame</a>( <span class="keywordtype">void</span> )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> lastFrame_; };</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classstk_1_1Generator.html#a86bb0421223cf27e25704d5f27b97425"> 41</a></span>  <span class="keyword">virtual</span> <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& <a class="code" href="classstk_1_1Generator.html#a86bb0421223cf27e25704d5f27b97425">tick</a>( <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a>& frames, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> channel = 0 ) = 0;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classstk_1_1StkFrames.html">StkFrames</a> lastFrame_;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> };</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> } <span class="comment">// stk namespace</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassstk_1_1Generator_html"><div class="ttname"><a href="classstk_1_1Generator.html">stk::Generator</a></div><div class="ttdoc">STK abstract unit generator parent class.</div><div class="ttdef"><b>Definition:</b> Generator.h:21</div></div>
<div class="ttc" id="aclassstk_1_1Generator_html_a57f4d954b55e454c48efc5915649d4be"><div class="ttname"><a href="classstk_1_1Generator.html#a57f4d954b55e454c48efc5915649d4be">stk::Generator::lastFrame</a></div><div class="ttdeci">const StkFrames & lastFrame(void) const</div><div class="ttdoc">Return an StkFrames reference to the last output sample frame.</div><div class="ttdef"><b>Definition:</b> Generator.h:31</div></div>
<div class="ttc" id="aclassstk_1_1Generator_html_a86bb0421223cf27e25704d5f27b97425"><div class="ttname"><a href="classstk_1_1Generator.html#a86bb0421223cf27e25704d5f27b97425">stk::Generator::tick</a></div><div class="ttdeci">virtual StkFrames & tick(StkFrames &frames, unsigned int channel=0)=0</div><div class="ttdoc">Fill the StkFrames object with computed sample frames, starting at the specified channel.</div></div>
<div class="ttc" id="aclassstk_1_1Generator_html_ac7f11d287fb903b04985c2f81dbf9a5d"><div class="ttname"><a href="classstk_1_1Generator.html#ac7f11d287fb903b04985c2f81dbf9a5d">stk::Generator::Generator</a></div><div class="ttdeci">Generator(void)</div><div class="ttdoc">Class constructor.</div><div class="ttdef"><b>Definition:</b> Generator.h:25</div></div>
<div class="ttc" id="aclassstk_1_1Generator_html_ade296275a459b23c2cb97a6884929589"><div class="ttname"><a href="classstk_1_1Generator.html#ade296275a459b23c2cb97a6884929589">stk::Generator::channelsOut</a></div><div class="ttdeci">unsigned int channelsOut(void) const</div><div class="ttdoc">Return the number of output channels for the class.</div><div class="ttdef"><b>Definition:</b> Generator.h:28</div></div>
<div class="ttc" id="aclassstk_1_1StkFrames_html"><div class="ttname"><a href="classstk_1_1StkFrames.html">stk::StkFrames</a></div><div class="ttdoc">An STK class to handle vectorized audio data.</div><div class="ttdef"><b>Definition:</b> Stk.h:287</div></div>
<div class="ttc" id="aclassstk_1_1StkFrames_html_a0340d9e76707282658e49509a568f60e"><div class="ttname"><a href="classstk_1_1StkFrames.html#a0340d9e76707282658e49509a568f60e">stk::StkFrames::channels</a></div><div class="ttdeci">unsigned int channels(void) const</div><div class="ttdoc">Return the number of channels represented by the data.</div><div class="ttdef"><b>Definition:</b> Stk.h:415</div></div>
<div class="ttc" id="aclassstk_1_1StkFrames_html_a386e1b86cf48f7a8117313f9e41fc0fe"><div class="ttname"><a href="classstk_1_1StkFrames.html#a386e1b86cf48f7a8117313f9e41fc0fe">stk::StkFrames::resize</a></div><div class="ttdeci">void resize(size_t nFrames, unsigned int nChannels=1)</div><div class="ttdoc">Resize self to represent the specified number of channels and frames.</div></div>
<div class="ttc" id="aclassstk_1_1Stk_html"><div class="ttname"><a href="classstk_1_1Stk.html">stk::Stk</a></div><div class="ttdoc">STK base class.</div><div class="ttdef"><b>Definition:</b> Stk.h:144</div></div>
<div class="ttc" id="anamespacestk_html"><div class="ttname"><a href="namespacestk.html">stk</a></div><div class="ttdoc">The STK namespace.</div><div class="ttdef"><b>Definition:</b> ADSR.h:8</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>