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.
389 Commits
7 Branches
360MB
Tree: 51186ba54a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '51186ba54a'
${ noResults }
DPF/structParameterRanges.html

395 lines
17KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>

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

  8. <title>DISTRHO Plugin Framework: ParameterRanges Struct 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.8.13 -->

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

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

  35. </script>

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

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

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

  39. $(function() {

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

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

  42. });

  43. </script>

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

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

  46. <div id="MSearchSelectWindow"

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

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

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

  50. </div>

  51. 

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

  53. <div id="MSearchResultsWindow">

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

  55.         name="MSearchResults" id="MSearchResults">

  56. </iframe>

  57. </div>

  58. 

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

  60. <div class="header">

  61.   <div class="summary">

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

  63. <a href="#pub-attribs">Public Attributes</a> &#124;

  64. <a href="structParameterRanges-members.html">List of all members</a>  </div>

  65.   <div class="headertitle">

  66. <div class="title">ParameterRanges Struct Reference<div class="ingroups"><a class="el" href="group__BasePluginStructs.html">Base Plugin Structs</a></div></div>  </div>

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

  68. <div class="contents">

  69. 

  70. <p><code>#include &lt;<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a>&gt;</code></p>

  71. <table class="memberdecls">

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

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

  74. <tr class="memitem:adb9b2712df3401eb0c5e11362d865d4e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#adb9b2712df3401eb0c5e11362d865d4e">ParameterRanges</a> () noexcept</td></tr>

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

  76. <tr class="memitem:a75337384c041ef8cd1a1cd2ba57ac205"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a75337384c041ef8cd1a1cd2ba57ac205">ParameterRanges</a> (float df, float mn, float mx) noexcept</td></tr>

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

  78. <tr class="memitem:a17519e584ccc28e87b73bfbd1a81cf10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a17519e584ccc28e87b73bfbd1a81cf10">fixDefault</a> () noexcept</td></tr>

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

  80. <tr class="memitem:a1dac84c100f420bfc529a4d2ea60dc7c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a1dac84c100f420bfc529a4d2ea60dc7c">fixValue</a> (float &amp;value) const noexcept</td></tr>

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

  82. <tr class="memitem:acd3d977c154ddb3138f36c0b6d2b7626"><td class="memItemLeft" align="right" valign="top">const float &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#acd3d977c154ddb3138f36c0b6d2b7626">getFixedValue</a> (const float &amp;value) const noexcept</td></tr>

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

  84. <tr class="memitem:ad16ef939c1caa2f51e9a4041f769f86e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#ad16ef939c1caa2f51e9a4041f769f86e">getNormalizedValue</a> (const float &amp;value) const noexcept</td></tr>

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

  86. <tr class="memitem:a82698a1e07b1b04ccb5df0de4db0d0be"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a82698a1e07b1b04ccb5df0de4db0d0be">getFixedAndNormalizedValue</a> (const float &amp;value) const noexcept</td></tr>

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

  88. <tr class="memitem:a992f75a925b3cd5e66544087708ea3c3"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a992f75a925b3cd5e66544087708ea3c3">getUnnormalizedValue</a> (const float &amp;value) const noexcept</td></tr>

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

  90. </table><table class="memberdecls">

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

  92. Public Attributes</h2></td></tr>

  93. <tr class="memitem:aa0aba68115bcfff25c35b2da2f7aed4c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a></td></tr>

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

  95. <tr class="memitem:a63c40988463a8ace9d0e9e55a00f3c7b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a></td></tr>

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

  97. <tr class="memitem:a175c78c905c598df929a4450e4d2a2a0"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a></td></tr>

  98. <tr class="separator:a175c78c905c598df929a4450e4d2a2a0"><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><a class="el" href="structParameter.html">Parameter</a> ranges.<br />

  102. This is used to set the default, minimum and maximum values of a parameter.</p>

  103. <p>By default a parameter has 0.0 as minimum, 1.0 as maximum and 0.0 as default.<br />

  104. When changing this struct values you must ensure maximum &gt; minimum and default is within range. </p>

  105. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  106. <a id="adb9b2712df3401eb0c5e11362d865d4e"></a>

  107. <h2 class="memtitle"><span class="permalink"><a href="#adb9b2712df3401eb0c5e11362d865d4e">&#9670;&nbsp;</a></span>ParameterRanges() <span class="overload">[1/2]</span></h2>

  108. 

  109. <div class="memitem">

  110. <div class="memproto">

  111. <table class="mlabels">

  112.   <tr>

  113.   <td class="mlabels-left">

  114.       <table class="memname">

  115.         <tr>

  116.           <td class="memname">ParameterRanges::ParameterRanges </td>

  117.           <td>(</td>

  118.           <td class="paramname"></td><td>)</td>

  119.           <td></td>

  120.         </tr>

  121.       </table>

  122.   </td>

  123.   <td class="mlabels-right">

  124. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  125.   </tr>

  126. </table>

  127. </div><div class="memdoc">

  128. <p>Default constructor, using 0.0 as minimum, 1.0 as maximum and 0.0 as default. </p>

  129. 

  130. </div>

  131. </div>

  132. <a id="a75337384c041ef8cd1a1cd2ba57ac205"></a>

  133. <h2 class="memtitle"><span class="permalink"><a href="#a75337384c041ef8cd1a1cd2ba57ac205">&#9670;&nbsp;</a></span>ParameterRanges() <span class="overload">[2/2]</span></h2>

  134. 

  135. <div class="memitem">

  136. <div class="memproto">

  137. <table class="mlabels">

  138.   <tr>

  139.   <td class="mlabels-left">

  140.       <table class="memname">

  141.         <tr>

  142.           <td class="memname">ParameterRanges::ParameterRanges </td>

  143.           <td>(</td>

  144.           <td class="paramtype">float&#160;</td>

  145.           <td class="paramname"><em>df</em>, </td>

  146.         </tr>

  147.         <tr>

  148.           <td class="paramkey"></td>

  149.           <td></td>

  150.           <td class="paramtype">float&#160;</td>

  151.           <td class="paramname"><em>mn</em>, </td>

  152.         </tr>

  153.         <tr>

  154.           <td class="paramkey"></td>

  155.           <td></td>

  156.           <td class="paramtype">float&#160;</td>

  157.           <td class="paramname"><em>mx</em>&#160;</td>

  158.         </tr>

  159.         <tr>

  160.           <td></td>

  161.           <td>)</td>

  162.           <td></td><td></td>

  163.         </tr>

  164.       </table>

  165.   </td>

  166.   <td class="mlabels-right">

  167. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  168.   </tr>

  169. </table>

  170. </div><div class="memdoc">

  171. <p>Constructor using custom values. </p>

  172. 

  173. </div>

  174. </div>

  175. <h2 class="groupheader">Member Function Documentation</h2>

  176. <a id="a17519e584ccc28e87b73bfbd1a81cf10"></a>

  177. <h2 class="memtitle"><span class="permalink"><a href="#a17519e584ccc28e87b73bfbd1a81cf10">&#9670;&nbsp;</a></span>fixDefault()</h2>

  178. 

  179. <div class="memitem">

  180. <div class="memproto">

  181. <table class="mlabels">

  182.   <tr>

  183.   <td class="mlabels-left">

  184.       <table class="memname">

  185.         <tr>

  186.           <td class="memname">void ParameterRanges::fixDefault </td>

  187.           <td>(</td>

  188.           <td class="paramname"></td><td>)</td>

  189.           <td></td>

  190.         </tr>

  191.       </table>

  192.   </td>

  193.   <td class="mlabels-right">

  194. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  195.   </tr>

  196. </table>

  197. </div><div class="memdoc">

  198. <p>Fix the default value within range. </p>

  199. 

  200. </div>

  201. </div>

  202. <a id="a1dac84c100f420bfc529a4d2ea60dc7c"></a>

  203. <h2 class="memtitle"><span class="permalink"><a href="#a1dac84c100f420bfc529a4d2ea60dc7c">&#9670;&nbsp;</a></span>fixValue()</h2>

  204. 

  205. <div class="memitem">

  206. <div class="memproto">

  207. <table class="mlabels">

  208.   <tr>

  209.   <td class="mlabels-left">

  210.       <table class="memname">

  211.         <tr>

  212.           <td class="memname">void ParameterRanges::fixValue </td>

  213.           <td>(</td>

  214.           <td class="paramtype">float &amp;&#160;</td>

  215.           <td class="paramname"><em>value</em></td><td>)</td>

  216.           <td> const</td>

  217.         </tr>

  218.       </table>

  219.   </td>

  220.   <td class="mlabels-right">

  221. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  222.   </tr>

  223. </table>

  224. </div><div class="memdoc">

  225. <p>Fix a value within range. </p>

  226. 

  227. </div>

  228. </div>

  229. <a id="acd3d977c154ddb3138f36c0b6d2b7626"></a>

  230. <h2 class="memtitle"><span class="permalink"><a href="#acd3d977c154ddb3138f36c0b6d2b7626">&#9670;&nbsp;</a></span>getFixedValue()</h2>

  231. 

  232. <div class="memitem">

  233. <div class="memproto">

  234. <table class="mlabels">

  235.   <tr>

  236.   <td class="mlabels-left">

  237.       <table class="memname">

  238.         <tr>

  239.           <td class="memname">const float&amp; ParameterRanges::getFixedValue </td>

  240.           <td>(</td>

  241.           <td class="paramtype">const float &amp;&#160;</td>

  242.           <td class="paramname"><em>value</em></td><td>)</td>

  243.           <td> const</td>

  244.         </tr>

  245.       </table>

  246.   </td>

  247.   <td class="mlabels-right">

  248. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  249.   </tr>

  250. </table>

  251. </div><div class="memdoc">

  252. <p>Get a fixed value within range. </p>

  253. 

  254. </div>

  255. </div>

  256. <a id="ad16ef939c1caa2f51e9a4041f769f86e"></a>

  257. <h2 class="memtitle"><span class="permalink"><a href="#ad16ef939c1caa2f51e9a4041f769f86e">&#9670;&nbsp;</a></span>getNormalizedValue()</h2>

  258. 

  259. <div class="memitem">

  260. <div class="memproto">

  261. <table class="mlabels">

  262.   <tr>

  263.   <td class="mlabels-left">

  264.       <table class="memname">

  265.         <tr>

  266.           <td class="memname">float ParameterRanges::getNormalizedValue </td>

  267.           <td>(</td>

  268.           <td class="paramtype">const float &amp;&#160;</td>

  269.           <td class="paramname"><em>value</em></td><td>)</td>

  270.           <td> const</td>

  271.         </tr>

  272.       </table>

  273.   </td>

  274.   <td class="mlabels-right">

  275. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  276.   </tr>

  277. </table>

  278. </div><div class="memdoc">

  279. <p>Get a value normalized to 0.0&lt;-&gt;1.0. </p>

  280. 

  281. </div>

  282. </div>

  283. <a id="a82698a1e07b1b04ccb5df0de4db0d0be"></a>

  284. <h2 class="memtitle"><span class="permalink"><a href="#a82698a1e07b1b04ccb5df0de4db0d0be">&#9670;&nbsp;</a></span>getFixedAndNormalizedValue()</h2>

  285. 

  286. <div class="memitem">

  287. <div class="memproto">

  288. <table class="mlabels">

  289.   <tr>

  290.   <td class="mlabels-left">

  291.       <table class="memname">

  292.         <tr>

  293.           <td class="memname">float ParameterRanges::getFixedAndNormalizedValue </td>

  294.           <td>(</td>

  295.           <td class="paramtype">const float &amp;&#160;</td>

  296.           <td class="paramname"><em>value</em></td><td>)</td>

  297.           <td> const</td>

  298.         </tr>

  299.       </table>

  300.   </td>

  301.   <td class="mlabels-right">

  302. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  303.   </tr>

  304. </table>

  305. </div><div class="memdoc">

  306. <p>Get a value normalized to 0.0&lt;-&gt;1.0, fixed within range. </p>

  307. 

  308. </div>

  309. </div>

  310. <a id="a992f75a925b3cd5e66544087708ea3c3"></a>

  311. <h2 class="memtitle"><span class="permalink"><a href="#a992f75a925b3cd5e66544087708ea3c3">&#9670;&nbsp;</a></span>getUnnormalizedValue()</h2>

  312. 

  313. <div class="memitem">

  314. <div class="memproto">

  315. <table class="mlabels">

  316.   <tr>

  317.   <td class="mlabels-left">

  318.       <table class="memname">

  319.         <tr>

  320.           <td class="memname">float ParameterRanges::getUnnormalizedValue </td>

  321.           <td>(</td>

  322.           <td class="paramtype">const float &amp;&#160;</td>

  323.           <td class="paramname"><em>value</em></td><td>)</td>

  324.           <td> const</td>

  325.         </tr>

  326.       </table>

  327.   </td>

  328.   <td class="mlabels-right">

  329. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  330.   </tr>

  331. </table>

  332. </div><div class="memdoc">

  333. <p>Get a proper value previously normalized to 0.0&lt;-&gt;1.0. </p>

  334. 

  335. </div>

  336. </div>

  337. <h2 class="groupheader">Member Data Documentation</h2>

  338. <a id="aa0aba68115bcfff25c35b2da2f7aed4c"></a>

  339. <h2 class="memtitle"><span class="permalink"><a href="#aa0aba68115bcfff25c35b2da2f7aed4c">&#9670;&nbsp;</a></span>def</h2>

  340. 

  341. <div class="memitem">

  342. <div class="memproto">

  343.       <table class="memname">

  344.         <tr>

  345.           <td class="memname">float ParameterRanges::def</td>

  346.         </tr>

  347.       </table>

  348. </div><div class="memdoc">

  349. <p>Default value. </p>

  350. 

  351. </div>

  352. </div>

  353. <a id="a63c40988463a8ace9d0e9e55a00f3c7b"></a>

  354. <h2 class="memtitle"><span class="permalink"><a href="#a63c40988463a8ace9d0e9e55a00f3c7b">&#9670;&nbsp;</a></span>min</h2>

  355. 

  356. <div class="memitem">

  357. <div class="memproto">

  358.       <table class="memname">

  359.         <tr>

  360.           <td class="memname">float ParameterRanges::min</td>

  361.         </tr>

  362.       </table>

  363. </div><div class="memdoc">

  364. <p>Minimum value. </p>

  365. 

  366. </div>

  367. </div>

  368. <a id="a175c78c905c598df929a4450e4d2a2a0"></a>

  369. <h2 class="memtitle"><span class="permalink"><a href="#a175c78c905c598df929a4450e4d2a2a0">&#9670;&nbsp;</a></span>max</h2>

  370. 

  371. <div class="memitem">

  372. <div class="memproto">

  373.       <table class="memname">

  374.         <tr>

  375.           <td class="memname">float ParameterRanges::max</td>

  376.         </tr>

  377.       </table>

  378. </div><div class="memdoc">

  379. <p>Maximum value. </p>

  380. 

  381. </div>

  382. </div>

  383. <hr/>The documentation for this struct was generated from the following file:<ul>

  384. <li>distrho/<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a></li>

  385. </ul>

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

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

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

  389. Generated on Sun Apr 7 2019 05:47:58 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  390. <img class="footer" src="doxygen.png" alt="doxygen"/>

  391. </a> 1.8.13

  392. </small></address>

  393. </body>

  394. </html>