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

398 lines
17KB
Raw 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.8.17"/>

  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.17 -->

  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');

  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="#pub-attribs">Public Attributes</a> &#124;

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

  68.   <div class="headertitle">

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

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

  71. <div class="contents">

  72. 

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

  74. <table class="memberdecls">

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

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

  77. <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>

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

  79. <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>

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

  81. <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>

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

  83. <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>

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

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

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

  87. <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>

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

  89. <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>

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

  91. <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>

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

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

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

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

  96. <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>

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

  98. <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>

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

  100. <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>

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

  102. </table>

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

  104. <div class="textblock"><p><a class="el" href="structParameter.html">Parameter</a> ranges.<br  />

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

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

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

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

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

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

  111. 

  112. <div class="memitem">

  113. <div class="memproto">

  114. <table class="mlabels">

  115.   <tr>

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

  117.       <table class="memname">

  118.         <tr>

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

  120.           <td>(</td>

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

  122.           <td></td>

  123.         </tr>

  124.       </table>

  125.   </td>

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

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

  128.   </tr>

  129. </table>

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

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

  132. 

  133. </div>

  134. </div>

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

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

  137. 

  138. <div class="memitem">

  139. <div class="memproto">

  140. <table class="mlabels">

  141.   <tr>

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

  143.       <table class="memname">

  144.         <tr>

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

  146.           <td>(</td>

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

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

  149.         </tr>

  150.         <tr>

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

  152.           <td></td>

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

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

  155.         </tr>

  156.         <tr>

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

  158.           <td></td>

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

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

  161.         </tr>

  162.         <tr>

  163.           <td></td>

  164.           <td>)</td>

  165.           <td></td><td></td>

  166.         </tr>

  167.       </table>

  168.   </td>

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

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

  171.   </tr>

  172. </table>

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

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

  175. 

  176. </div>

  177. </div>

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

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

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

  181. 

  182. <div class="memitem">

  183. <div class="memproto">

  184. <table class="mlabels">

  185.   <tr>

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

  187.       <table class="memname">

  188.         <tr>

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

  190.           <td>(</td>

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

  192.           <td></td>

  193.         </tr>

  194.       </table>

  195.   </td>

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

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

  198.   </tr>

  199. </table>

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

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

  202. 

  203. </div>

  204. </div>

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

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

  207. 

  208. <div class="memitem">

  209. <div class="memproto">

  210. <table class="mlabels">

  211.   <tr>

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

  213.       <table class="memname">

  214.         <tr>

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

  216.           <td>(</td>

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

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

  219.           <td> const</td>

  220.         </tr>

  221.       </table>

  222.   </td>

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

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

  225.   </tr>

  226. </table>

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

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

  229. 

  230. </div>

  231. </div>

  232. <a id="a983383b2b3ce5d049802a7f0a12cee0c"></a>

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

  234. 

  235. <div class="memitem">

  236. <div class="memproto">

  237. <table class="mlabels">

  238.   <tr>

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

  240.       <table class="memname">

  241.         <tr>

  242.           <td class="memname">float ParameterRanges::getFixedValue </td>

  243.           <td>(</td>

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

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

  246.           <td> const</td>

  247.         </tr>

  248.       </table>

  249.   </td>

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

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

  252.   </tr>

  253. </table>

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

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

  256. 

  257. </div>

  258. </div>

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

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

  261. 

  262. <div class="memitem">

  263. <div class="memproto">

  264. <table class="mlabels">

  265.   <tr>

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

  267.       <table class="memname">

  268.         <tr>

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

  270.           <td>(</td>

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

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

  273.           <td> const</td>

  274.         </tr>

  275.       </table>

  276.   </td>

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

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

  279.   </tr>

  280. </table>

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

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

  283. 

  284. </div>

  285. </div>

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

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

  288. 

  289. <div class="memitem">

  290. <div class="memproto">

  291. <table class="mlabels">

  292.   <tr>

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

  294.       <table class="memname">

  295.         <tr>

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

  297.           <td>(</td>

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

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

  300.           <td> const</td>

  301.         </tr>

  302.       </table>

  303.   </td>

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

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

  306.   </tr>

  307. </table>

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

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

  310. 

  311. </div>

  312. </div>

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

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

  315. 

  316. <div class="memitem">

  317. <div class="memproto">

  318. <table class="mlabels">

  319.   <tr>

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

  321.       <table class="memname">

  322.         <tr>

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

  324.           <td>(</td>

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

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

  327.           <td> const</td>

  328.         </tr>

  329.       </table>

  330.   </td>

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

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

  333.   </tr>

  334. </table>

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

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

  337. 

  338. </div>

  339. </div>

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

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

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

  343. 

  344. <div class="memitem">

  345. <div class="memproto">

  346.       <table class="memname">

  347.         <tr>

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

  349.         </tr>

  350.       </table>

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

  352. <p>Default value. </p>

  353. 

  354. </div>

  355. </div>

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

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

  358. 

  359. <div class="memitem">

  360. <div class="memproto">

  361.       <table class="memname">

  362.         <tr>

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

  364.         </tr>

  365.       </table>

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

  367. <p>Minimum value. </p>

  368. 

  369. </div>

  370. </div>

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

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

  373. 

  374. <div class="memitem">

  375. <div class="memproto">

  376.       <table class="memname">

  377.         <tr>

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

  379.         </tr>

  380.       </table>

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

  382. <p>Maximum value. </p>

  383. 

  384. </div>

  385. </div>

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

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

  388. </ul>

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

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

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

  392. Generated on Mon Jun 14 2021 12:30:38 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  394. </a> 1.8.17

  395. </small></address>

  396. </body>

  397. </html>