ref: c39e469c76573e0fd129e7f65c7286af82d7702b
dir: /docs/leaf/group__tslide.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: tSlide</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">tSlide<div class="ingroups"><a class="el" href="group__envelopes.html">Envelopes</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Based on Max/MSP's slide~. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga8288a16662a7fa082c4fcad3cea0ab04"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tslide.html#ga8288a16662a7fa082c4fcad3cea0ab04">tSlide_init</a> (tSlide *const, float upSlide, float downSlide, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr> <tr class="memdesc:ga8288a16662a7fa082c4fcad3cea0ab04"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tSlide 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__tslide.html#ga8288a16662a7fa082c4fcad3cea0ab04">More...</a><br /></td></tr> <tr class="separator:ga8288a16662a7fa082c4fcad3cea0ab04"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga42a348c9028053e0ad3a22f1ac731430"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tslide.html#ga42a348c9028053e0ad3a22f1ac731430">tSlide_initToPool</a> (tSlide *const, float upSlide, float downSlide, tMempool *const)</td></tr> <tr class="memdesc:ga42a348c9028053e0ad3a22f1ac731430"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a tSlide to a specified mempool. <a href="group__tslide.html#ga42a348c9028053e0ad3a22f1ac731430">More...</a><br /></td></tr> <tr class="separator:ga42a348c9028053e0ad3a22f1ac731430"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga57ba71883af607aaf28f0292e0cee901"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tslide.html#ga57ba71883af607aaf28f0292e0cee901">tSlide_free</a> (tSlide *const)</td></tr> <tr class="memdesc:ga57ba71883af607aaf28f0292e0cee901"><td class="mdescLeft"> </td><td class="mdescRight">Free a tSlide from its mempool. <a href="group__tslide.html#ga57ba71883af607aaf28f0292e0cee901">More...</a><br /></td></tr> <tr class="separator:ga57ba71883af607aaf28f0292e0cee901"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gacdddc23733eda912f51d57cc944062b0"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tslide.html#gacdddc23733eda912f51d57cc944062b0">tSlide_tick</a> (tSlide *const, float in)</td></tr> <tr class="separator:gacdddc23733eda912f51d57cc944062b0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0ba5fda0ed766d03ac97ad8d0f068ba1"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tslide.html#ga0ba5fda0ed766d03ac97ad8d0f068ba1">tSlide_tickNoInput</a> (tSlide *const sl)</td></tr> <tr class="separator:ga0ba5fda0ed766d03ac97ad8d0f068ba1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaac39af0df494460bbc7170a2a34dd7e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tslide.html#gaac39af0df494460bbc7170a2a34dd7e1">tSlide_setUpSlide</a> (tSlide *const sl, float upSlide)</td></tr> <tr class="separator:gaac39af0df494460bbc7170a2a34dd7e1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga86d8efa014a6428b1338d70603f1eb95"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tslide.html#ga86d8efa014a6428b1338d70603f1eb95">tSlide_setDownSlide</a> (tSlide *const sl, float downSlide)</td></tr> <tr class="separator:ga86d8efa014a6428b1338d70603f1eb95"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga381e81d6bcb9cba92acfe9a68df8c193"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tslide.html#ga381e81d6bcb9cba92acfe9a68df8c193">tSlide_setDest</a> (tSlide *const sl, float dest)</td></tr> <tr class="separator:ga381e81d6bcb9cba92acfe9a68df8c193"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Based on Max/MSP's slide~. </p> <h2 class="groupheader">Function Documentation</h2> <a id="ga8288a16662a7fa082c4fcad3cea0ab04"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga8288a16662a7fa082c4fcad3cea0ab04">◆ </a></span>tSlide_init()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tSlide_init </td> <td>(</td> <td class="paramtype">tSlide * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>upSlide</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>downSlide</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 tSlide 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">slide</td><td>A pointer to the tSlide 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="ga42a348c9028053e0ad3a22f1ac731430"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga42a348c9028053e0ad3a22f1ac731430">◆ </a></span>tSlide_initToPool()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tSlide_initToPool </td> <td>(</td> <td class="paramtype">tSlide * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>upSlide</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>downSlide</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 tSlide to a specified mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">slide</td><td>A pointer to the tSlide 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="ga57ba71883af607aaf28f0292e0cee901"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga57ba71883af607aaf28f0292e0cee901">◆ </a></span>tSlide_free()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tSlide_free </td> <td>(</td> <td class="paramtype">tSlide * const </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free a tSlide from its mempool. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">slide</td><td>A pointer to the tSlide to free. </td></tr> </table> </dd> </dl> </div> </div> <a id="gacdddc23733eda912f51d57cc944062b0"></a> <h2 class="memtitle"><span class="permalink"><a href="#gacdddc23733eda912f51d57cc944062b0">◆ </a></span>tSlide_tick()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tSlide_tick </td> <td>(</td> <td class="paramtype">tSlide * const </td> <td class="paramname">, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>in</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">slide</td><td>A pointer to the relevant tSlide. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga0ba5fda0ed766d03ac97ad8d0f068ba1"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga0ba5fda0ed766d03ac97ad8d0f068ba1">◆ </a></span>tSlide_tickNoInput()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float tSlide_tickNoInput </td> <td>(</td> <td class="paramtype">tSlide *const </td> <td class="paramname"><em>sl</em></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">slide</td><td>A pointer to the relevant tSlide. </td></tr> </table> </dd> </dl> </div> </div> <a id="gaac39af0df494460bbc7170a2a34dd7e1"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaac39af0df494460bbc7170a2a34dd7e1">◆ </a></span>tSlide_setUpSlide()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tSlide_setUpSlide </td> <td>(</td> <td class="paramtype">tSlide *const </td> <td class="paramname"><em>sl</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>upSlide</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">slide</td><td>A pointer to the relevant tSlide. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga86d8efa014a6428b1338d70603f1eb95"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga86d8efa014a6428b1338d70603f1eb95">◆ </a></span>tSlide_setDownSlide()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tSlide_setDownSlide </td> <td>(</td> <td class="paramtype">tSlide *const </td> <td class="paramname"><em>sl</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>downSlide</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">slide</td><td>A pointer to the relevant tSlide. </td></tr> </table> </dd> </dl> </div> </div> <a id="ga381e81d6bcb9cba92acfe9a68df8c193"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga381e81d6bcb9cba92acfe9a68df8c193">◆ </a></span>tSlide_setDest()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void tSlide_setDest </td> <td>(</td> <td class="paramtype">tSlide *const </td> <td class="paramname"><em>sl</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>dest</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">slide</td><td>A pointer to the relevant tSlide. </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- HTML footer for doxygen 1.8.18--> <!-- start footer part --> </body> </html>