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.

119 lines
7.0KB

  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: ExponentialValueSmoother 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. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="classExponentialValueSmoother-members.html">List of all members</a> </div>
  65. <div class="headertitle">
  66. <div class="title">ExponentialValueSmoother Class Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>An exponential smoother for control values.
  70. <a href="classExponentialValueSmoother.html#details">More...</a></p>
  71. <p><code>#include &lt;<a class="el" href="ValueSmoother_8hpp_source.html">ValueSmoother.hpp</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74. Public Member Functions</h2></td></tr>
  75. <tr class="memitem:a9ae64506c940fe015b762e7e9c5d3443"><td class="memItemLeft" align="right" valign="top"><a id="a9ae64506c940fe015b762e7e9c5d3443"></a>
  76. void&#160;</td><td class="memItemRight" valign="bottom"><b>setSampleRate</b> (const float newSampleRate) noexcept</td></tr>
  77. <tr class="separator:a9ae64506c940fe015b762e7e9c5d3443"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a3db6214303d589e6a19ffd2134470253"><td class="memItemLeft" align="right" valign="top"><a id="a3db6214303d589e6a19ffd2134470253"></a>
  79. void&#160;</td><td class="memItemRight" valign="bottom"><b>setTimeConstant</b> (const float newT60) noexcept</td></tr>
  80. <tr class="separator:a3db6214303d589e6a19ffd2134470253"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:abfaf559936978af48b3a538faf4b3016"><td class="memItemLeft" align="right" valign="top"><a id="abfaf559936978af48b3a538faf4b3016"></a>
  82. float&#160;</td><td class="memItemRight" valign="bottom"><b>getCurrentValue</b> () const noexcept</td></tr>
  83. <tr class="separator:abfaf559936978af48b3a538faf4b3016"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:af1d0fbca4ae0b8c589efae47b3f776b3"><td class="memItemLeft" align="right" valign="top"><a id="af1d0fbca4ae0b8c589efae47b3f776b3"></a>
  85. float&#160;</td><td class="memItemRight" valign="bottom"><b>getTargetValue</b> () const noexcept</td></tr>
  86. <tr class="separator:af1d0fbca4ae0b8c589efae47b3f776b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a38279bf1df97da4a26d93120aeb033a2"><td class="memItemLeft" align="right" valign="top"><a id="a38279bf1df97da4a26d93120aeb033a2"></a>
  88. void&#160;</td><td class="memItemRight" valign="bottom"><b>setTargetValue</b> (const float newTarget) noexcept</td></tr>
  89. <tr class="separator:a38279bf1df97da4a26d93120aeb033a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ad9b30093ba2e6d4f00425d43d732f4b8"><td class="memItemLeft" align="right" valign="top"><a id="ad9b30093ba2e6d4f00425d43d732f4b8"></a>
  91. void&#160;</td><td class="memItemRight" valign="bottom"><b>clearToTargetValue</b> () noexcept</td></tr>
  92. <tr class="separator:ad9b30093ba2e6d4f00425d43d732f4b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:ab33761a1597c829062a34b77a0d361ec"><td class="memItemLeft" align="right" valign="top"><a id="ab33761a1597c829062a34b77a0d361ec"></a>
  94. float&#160;</td><td class="memItemRight" valign="bottom"><b>peek</b> () const noexcept</td></tr>
  95. <tr class="separator:ab33761a1597c829062a34b77a0d361ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a5c5069770feb43d730771d3d77d20a07"><td class="memItemLeft" align="right" valign="top"><a id="a5c5069770feb43d730771d3d77d20a07"></a>
  97. float&#160;</td><td class="memItemRight" valign="bottom"><b>next</b> () noexcept</td></tr>
  98. <tr class="separator:a5c5069770feb43d730771d3d77d20a07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  101. <div class="textblock"><p>An exponential smoother for control values. </p>
  102. <p>This continually smooths a value towards a defined target, using a low-pass filter of the 1st order, which creates an exponential curve.</p>
  103. <p>The length of the curve is defined by a T60 constant, which is the time it takes for a 1-to-0 smoothing to fall to -60dB.</p>
  104. <p>Note that this smoother has asymptotical behavior, and it must not be assumed that the final target is ever reached. </p>
  105. </div><hr/>The documentation for this class was generated from the following file:<ul>
  106. <li>distrho/extra/<a class="el" href="ValueSmoother_8hpp_source.html">ValueSmoother.hpp</a></li>
  107. </ul>
  108. </div><!-- contents -->
  109. <!-- start footer part -->
  110. <hr class="footer"/><address class="footer"><small>
  111. 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
  112. </small></address>
  113. </body>
  114. </html>