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

398 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.11"/>

  7. <title>DISTRHO Plugin Framework: ParameterRanges Struct Reference</title>

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

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

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

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

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

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

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

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

  34. <!-- Generated by Doxygen 1.8.11 -->

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

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

  37. </script>

  38.   <div id="navrow1" class="tabs">

  39.     <ul class="tablist">

  40.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  41.       <li><a href="modules.html"><span>Modules</span></a></li>

  42.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  43.       <li><a href="files.html"><span>Files</span></a></li>

  44.       <li>

  45.         <div id="MSearchBox" class="MSearchBoxInactive">

  46.         <span class="left">

  47.           <img id="MSearchSelect" src="search/mag_sel.png"

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

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

  50.                alt=""/>

  51.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  52.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  53.                onblur="searchBox.OnSearchFieldFocus(false)" 

  54.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  55.           </span><span class="right">

  56.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

  62.   <div id="navrow2" class="tabs2">

  63.     <ul class="tablist">

  64.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  65.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>

  66.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>

  67.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  68.     </ul>

  69.   </div>

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

  71. <div id="MSearchSelectWindow"

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

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

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

  75. </div>

  76. 

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

  78. <div id="MSearchResultsWindow">

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

  80.         name="MSearchResults" id="MSearchResults">

  81. </iframe>

  82. </div>

  83. 

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

  85. <div class="header">

  86.   <div class="summary">

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

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

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

  90.   <div class="headertitle">

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

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

  93. <div class="contents">

  94. 

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

  96. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  124. </table>

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

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

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

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

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

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

  131. <a class="anchor" id="adb9b2712df3401eb0c5e11362d865d4e"></a>

  132. <div class="memitem">

  133. <div class="memproto">

  134. <table class="mlabels">

  135.   <tr>

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

  137.       <table class="memname">

  138.         <tr>

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

  140.           <td>(</td>

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

  142.           <td></td>

  143.         </tr>

  144.       </table>

  145.   </td>

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

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

  148.   </tr>

  149. </table>

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

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

  152. 

  153. </div>

  154. </div>

  155. <a class="anchor" id="a75337384c041ef8cd1a1cd2ba57ac205"></a>

  156. <div class="memitem">

  157. <div class="memproto">

  158. <table class="mlabels">

  159.   <tr>

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

  161.       <table class="memname">

  162.         <tr>

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

  164.           <td>(</td>

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

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

  167.         </tr>

  168.         <tr>

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

  170.           <td></td>

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

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

  173.         </tr>

  174.         <tr>

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

  176.           <td></td>

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

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

  179.         </tr>

  180.         <tr>

  181.           <td></td>

  182.           <td>)</td>

  183.           <td></td><td></td>

  184.         </tr>

  185.       </table>

  186.   </td>

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

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

  189.   </tr>

  190. </table>

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

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

  193. 

  194. </div>

  195. </div>

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

  197. <a class="anchor" id="a17519e584ccc28e87b73bfbd1a81cf10"></a>

  198. <div class="memitem">

  199. <div class="memproto">

  200. <table class="mlabels">

  201.   <tr>

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

  203.       <table class="memname">

  204.         <tr>

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

  206.           <td>(</td>

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

  208.           <td></td>

  209.         </tr>

  210.       </table>

  211.   </td>

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

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

  214.   </tr>

  215. </table>

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

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

  218. 

  219. </div>

  220. </div>

  221. <a class="anchor" id="a1dac84c100f420bfc529a4d2ea60dc7c"></a>

  222. <div class="memitem">

  223. <div class="memproto">

  224. <table class="mlabels">

  225.   <tr>

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

  227.       <table class="memname">

  228.         <tr>

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

  230.           <td>(</td>

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

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

  233.           <td> const</td>

  234.         </tr>

  235.       </table>

  236.   </td>

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

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

  239.   </tr>

  240. </table>

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

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

  243. 

  244. </div>

  245. </div>

  246. <a class="anchor" id="acd3d977c154ddb3138f36c0b6d2b7626"></a>

  247. <div class="memitem">

  248. <div class="memproto">

  249. <table class="mlabels">

  250.   <tr>

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

  252.       <table class="memname">

  253.         <tr>

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

  255.           <td>(</td>

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

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

  258.           <td> const</td>

  259.         </tr>

  260.       </table>

  261.   </td>

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

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

  264.   </tr>

  265. </table>

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

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

  268. 

  269. </div>

  270. </div>

  271. <a class="anchor" id="ad16ef939c1caa2f51e9a4041f769f86e"></a>

  272. <div class="memitem">

  273. <div class="memproto">

  274. <table class="mlabels">

  275.   <tr>

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

  277.       <table class="memname">

  278.         <tr>

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

  280.           <td>(</td>

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

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

  283.           <td> const</td>

  284.         </tr>

  285.       </table>

  286.   </td>

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

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

  289.   </tr>

  290. </table>

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

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

  293. 

  294. </div>

  295. </div>

  296. <a class="anchor" id="a82698a1e07b1b04ccb5df0de4db0d0be"></a>

  297. <div class="memitem">

  298. <div class="memproto">

  299. <table class="mlabels">

  300.   <tr>

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

  302.       <table class="memname">

  303.         <tr>

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

  305.           <td>(</td>

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

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

  308.           <td> const</td>

  309.         </tr>

  310.       </table>

  311.   </td>

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

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

  314.   </tr>

  315. </table>

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

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

  318. 

  319. </div>

  320. </div>

  321. <a class="anchor" id="a992f75a925b3cd5e66544087708ea3c3"></a>

  322. <div class="memitem">

  323. <div class="memproto">

  324. <table class="mlabels">

  325.   <tr>

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

  327.       <table class="memname">

  328.         <tr>

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

  330.           <td>(</td>

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

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

  333.           <td> const</td>

  334.         </tr>

  335.       </table>

  336.   </td>

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

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

  339.   </tr>

  340. </table>

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

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

  343. 

  344. </div>

  345. </div>

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

  347. <a class="anchor" id="aa0aba68115bcfff25c35b2da2f7aed4c"></a>

  348. <div class="memitem">

  349. <div class="memproto">

  350.       <table class="memname">

  351.         <tr>

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

  353.         </tr>

  354.       </table>

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

  356. <p>Default value. </p>

  357. 

  358. </div>

  359. </div>

  360. <a class="anchor" id="a63c40988463a8ace9d0e9e55a00f3c7b"></a>

  361. <div class="memitem">

  362. <div class="memproto">

  363.       <table class="memname">

  364.         <tr>

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

  366.         </tr>

  367.       </table>

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

  369. <p>Minimum value. </p>

  370. 

  371. </div>

  372. </div>

  373. <a class="anchor" id="a175c78c905c598df929a4450e4d2a2a0"></a>

  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 Tue Jun 7 2016 14:04:29 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.11

  395. </small></address>

  396. </body>

  397. </html>