ref: c9f87b8761155abf2cab26cb809bcf89016697f3
dir: /docs/leaf/group__tadsr3.html/
<!-- HTML header for doxygen 1.8.18-->
<!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.8.16" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>LEAF: tADSR3</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>
<script type="text/javascript" src="../js/iframeResizer.contentWindow.min.js"></script>
<!-- <script src="/js/template.js"></script> -->
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<!-- <link rel="stylesheet" href="/css/tachyons.css" type="text/css" /> -->
</head>
<body class="bg-washed-green black-70 ph0 sans-serif" onload="iframeResizePipe()">
<div>
<!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
</div>
</body>
</html><!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">tADSR3<div class="ingroups"><a class="el" href="group__envelopes.html">Envelopes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga61f1fd529df0d97a9a74b9523024b1fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#ga61f1fd529df0d97a9a74b9523024b1fe">tADSR3_init</a> (tADSR3 *const, float attack, float decay, float sustain, float release, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:ga61f1fd529df0d97a9a74b9523024b1fe"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tADSR3 to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. <a href="group__tadsr3.html#ga61f1fd529df0d97a9a74b9523024b1fe">More...</a><br /></td></tr>
<tr class="separator:ga61f1fd529df0d97a9a74b9523024b1fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e0784b34c2fef54de2ed993d68f9b7c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#ga7e0784b34c2fef54de2ed993d68f9b7c">tADSR3_initToPool</a> (tADSR3 *const, float attack, float decay, float sustain, float release, tMempool *const)</td></tr>
<tr class="memdesc:ga7e0784b34c2fef54de2ed993d68f9b7c"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tADSR3 to a specified mempool. <a href="group__tadsr3.html#ga7e0784b34c2fef54de2ed993d68f9b7c">More...</a><br /></td></tr>
<tr class="separator:ga7e0784b34c2fef54de2ed993d68f9b7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf633a93865d4a9d4ba4840624f2b41bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#gaf633a93865d4a9d4ba4840624f2b41bf">tADSR3_free</a> (tADSR3 *const)</td></tr>
<tr class="memdesc:gaf633a93865d4a9d4ba4840624f2b41bf"><td class="mdescLeft"> </td><td class="mdescRight">Free a tADSR3 from its mempool. <a href="group__tadsr3.html#gaf633a93865d4a9d4ba4840624f2b41bf">More...</a><br /></td></tr>
<tr class="separator:gaf633a93865d4a9d4ba4840624f2b41bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3b959e263e7322d7876bdf5e9b633a16"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#ga3b959e263e7322d7876bdf5e9b633a16">tADSR3_tick</a> (tADSR3 *const)</td></tr>
<tr class="separator:ga3b959e263e7322d7876bdf5e9b633a16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a6a119590346ee356f486d8af00567a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#ga0a6a119590346ee356f486d8af00567a">tADSR3_setAttack</a> (tADSR3 *const, float attack)</td></tr>
<tr class="separator:ga0a6a119590346ee356f486d8af00567a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga325386ad4640ec898971fdedf87b3b49"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#ga325386ad4640ec898971fdedf87b3b49">tADSR3_setDecay</a> (tADSR3 *const, float decay)</td></tr>
<tr class="separator:ga325386ad4640ec898971fdedf87b3b49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae5695ee654846bf4f3f092c3f2136ca8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#gae5695ee654846bf4f3f092c3f2136ca8">tADSR3_setSustain</a> (tADSR3 *const, float sustain)</td></tr>
<tr class="separator:gae5695ee654846bf4f3f092c3f2136ca8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3ac9763101f9e3b5338ea92cc02a6032"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#ga3ac9763101f9e3b5338ea92cc02a6032">tADSR3_setRelease</a> (tADSR3 *const, float release)</td></tr>
<tr class="separator:ga3ac9763101f9e3b5338ea92cc02a6032"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga589972bef8fca1a6a99064b92968c9fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#ga589972bef8fca1a6a99064b92968c9fc">tADSR3_setLeakFactor</a> (tADSR3 *const, float leakFactor)</td></tr>
<tr class="separator:ga589972bef8fca1a6a99064b92968c9fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6054295d933bb2d27898664f4b6f067e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#ga6054295d933bb2d27898664f4b6f067e">tADSR3_on</a> (tADSR3 *const, float velocity)</td></tr>
<tr class="separator:ga6054295d933bb2d27898664f4b6f067e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad48b26429b4224b199b26690a0d480f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tadsr3.html#gad48b26429b4224b199b26690a0d480f1">tADSR3_off</a> (tADSR3 *const)</td></tr>
<tr class="separator:gad48b26429b4224b199b26690a0d480f1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga61f1fd529df0d97a9a74b9523024b1fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga61f1fd529df0d97a9a74b9523024b1fe">◆ </a></span>tADSR3_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_init </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>attack</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>decay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>sustain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>release</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_l_e_a_f.html">LEAF</a> *const </td>
<td class="paramname"><em>leaf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a tADSR3 to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the tADSR3 to initialize. </td></tr>
<tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga7e0784b34c2fef54de2ed993d68f9b7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7e0784b34c2fef54de2ed993d68f9b7c">◆ </a></span>tADSR3_initToPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_initToPool </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>attack</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>decay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>sustain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>release</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">tMempool * const </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a tADSR3 to a specified mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the tADSR3 to initialize. </td></tr>
<tr><td class="paramname">mempool</td><td>A pointer to the tMempool to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf633a93865d4a9d4ba4840624f2b41bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf633a93865d4a9d4ba4840624f2b41bf">◆ </a></span>tADSR3_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_free </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a tADSR3 from its mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the tADSR3 to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3b959e263e7322d7876bdf5e9b633a16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3b959e263e7322d7876bdf5e9b633a16">◆ </a></span>tADSR3_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float tADSR3_tick </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the relevant tADSR3. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga0a6a119590346ee356f486d8af00567a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a6a119590346ee356f486d8af00567a">◆ </a></span>tADSR3_setAttack()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_setAttack </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>attack</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the relevant tADSR3. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga325386ad4640ec898971fdedf87b3b49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga325386ad4640ec898971fdedf87b3b49">◆ </a></span>tADSR3_setDecay()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_setDecay </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>decay</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the relevant tADSR3. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae5695ee654846bf4f3f092c3f2136ca8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae5695ee654846bf4f3f092c3f2136ca8">◆ </a></span>tADSR3_setSustain()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_setSustain </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>sustain</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the relevant tADSR3. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3ac9763101f9e3b5338ea92cc02a6032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3ac9763101f9e3b5338ea92cc02a6032">◆ </a></span>tADSR3_setRelease()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_setRelease </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>release</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the relevant tADSR3. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga589972bef8fca1a6a99064b92968c9fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga589972bef8fca1a6a99064b92968c9fc">◆ </a></span>tADSR3_setLeakFactor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_setLeakFactor </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>leakFactor</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the relevant tADSR3. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6054295d933bb2d27898664f4b6f067e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6054295d933bb2d27898664f4b6f067e">◆ </a></span>tADSR3_on()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_on </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>velocity</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the relevant tADSR3. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gad48b26429b4224b199b26690a0d480f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad48b26429b4224b199b26690a0d480f1">◆ </a></span>tADSR3_off()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tADSR3_off </td>
<td>(</td>
<td class="paramtype">tADSR3 * const </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adsr</td><td>A pointer to the relevant tADSR3. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>