DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/classLinearValueSmoother.html

119 lines
7.0KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.9.1"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: LinearValueSmoother Class Reference</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">DISTRHO Plugin Framework

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.9.1 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. <!-- window showing the filter options -->

  49. <div id="MSearchSelectWindow"

  50.      onmouseover="return searchBox.OnSearchSelectShow()"

  51.      onmouseout="return searchBox.OnSearchSelectHide()"

  52.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  53. </div>

  54. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. </div><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="classLinearValueSmoother-members.html">List of all members</a>  </div>

  67.   <div class="headertitle">

  68. <div class="title">LinearValueSmoother Class Reference</div>  </div>

  69. </div><!--header-->

  70. <div class="contents">

  71. 

  72. <p>A linear smoother for control values.  

  73.  <a href="classLinearValueSmoother.html#details">More...</a></p>

  74. 

  75. <p><code>#include &lt;<a class="el" href="ValueSmoother_8hpp_source.html">ValueSmoother.hpp</a>&gt;</code></p>

  76. <table class="memberdecls">

  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  78. Public Member Functions</h2></td></tr>

  79. <tr class="memitem:acc3619c5547893428cecb709cdbf713e"><td class="memItemLeft" align="right" valign="top"><a id="acc3619c5547893428cecb709cdbf713e"></a>

  80. void&#160;</td><td class="memItemRight" valign="bottom"><b>setSampleRate</b> (const float newSampleRate) noexcept</td></tr>

  81. <tr class="separator:acc3619c5547893428cecb709cdbf713e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  82. <tr class="memitem:ab7abd3cde53953209dc6233cb24020ae"><td class="memItemLeft" align="right" valign="top"><a id="ab7abd3cde53953209dc6233cb24020ae"></a>

  83. void&#160;</td><td class="memItemRight" valign="bottom"><b>setTimeConstant</b> (const float newTau) noexcept</td></tr>

  84. <tr class="separator:ab7abd3cde53953209dc6233cb24020ae"><td class="memSeparator" colspan="2">&#160;</td></tr>

  85. <tr class="memitem:a599056e7a8ec77dffe8329ae9353d105"><td class="memItemLeft" align="right" valign="top"><a id="a599056e7a8ec77dffe8329ae9353d105"></a>

  86. float&#160;</td><td class="memItemRight" valign="bottom"><b>getCurrentValue</b> () const noexcept</td></tr>

  87. <tr class="separator:a599056e7a8ec77dffe8329ae9353d105"><td class="memSeparator" colspan="2">&#160;</td></tr>

  88. <tr class="memitem:a88796d5813a53f369f4252264cbea896"><td class="memItemLeft" align="right" valign="top"><a id="a88796d5813a53f369f4252264cbea896"></a>

  89. float&#160;</td><td class="memItemRight" valign="bottom"><b>getTargetValue</b> () const noexcept</td></tr>

  90. <tr class="separator:a88796d5813a53f369f4252264cbea896"><td class="memSeparator" colspan="2">&#160;</td></tr>

  91. <tr class="memitem:abcc1dcba5cbce58d77149083a7285963"><td class="memItemLeft" align="right" valign="top"><a id="abcc1dcba5cbce58d77149083a7285963"></a>

  92. void&#160;</td><td class="memItemRight" valign="bottom"><b>setTargetValue</b> (const float newTarget) noexcept</td></tr>

  93. <tr class="separator:abcc1dcba5cbce58d77149083a7285963"><td class="memSeparator" colspan="2">&#160;</td></tr>

  94. <tr class="memitem:a135e5fd99f26ab3ae0962fd00fb65b50"><td class="memItemLeft" align="right" valign="top"><a id="a135e5fd99f26ab3ae0962fd00fb65b50"></a>

  95. void&#160;</td><td class="memItemRight" valign="bottom"><b>clearToTargetValue</b> () noexcept</td></tr>

  96. <tr class="separator:a135e5fd99f26ab3ae0962fd00fb65b50"><td class="memSeparator" colspan="2">&#160;</td></tr>

  97. <tr class="memitem:ad2be483d43ec42c1906adfcc77ba3903"><td class="memItemLeft" align="right" valign="top"><a id="ad2be483d43ec42c1906adfcc77ba3903"></a>

  98. float&#160;</td><td class="memItemRight" valign="bottom"><b>peek</b> () const noexcept</td></tr>

  99. <tr class="separator:ad2be483d43ec42c1906adfcc77ba3903"><td class="memSeparator" colspan="2">&#160;</td></tr>

  100. <tr class="memitem:a24f44ec350f22cbd47003340c3425ae6"><td class="memItemLeft" align="right" valign="top"><a id="a24f44ec350f22cbd47003340c3425ae6"></a>

  101. float&#160;</td><td class="memItemRight" valign="bottom"><b>next</b> () noexcept</td></tr>

  102. <tr class="separator:a24f44ec350f22cbd47003340c3425ae6"><td class="memSeparator" colspan="2">&#160;</td></tr>

  103. </table>

  104. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  105. <div class="textblock"><p>A linear smoother for control values. </p>

  106. <p>This continually smooths a value towards a defined target, using linear segments.</p>

  107. <p>The duration of the smoothing segment is defined by the given time constant. Every time the target changes, a new segment restarts for the whole duration of the time constant.</p>

  108. <p>Note that this smoother, unlike an exponential smoother, eventually should converge to its target value. </p>

  109. </div><hr/>The documentation for this class was generated from the following file:<ul>

  110. <li>distrho/extra/<a class="el" href="ValueSmoother_8hpp_source.html">ValueSmoother.hpp</a></li>

  111. </ul>

  112. </div><!-- contents -->

  113. <!-- start footer part -->

  114. <hr class="footer"/><address class="footer"><small>

  115. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  116. </small></address>

  117. </body>

  118. </html>