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

397 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.8"/>

  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/search.js"></script>

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

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

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

  17. </head>

  18. <body>

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

  20. <div id="titlearea">

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

  22.  <tbody>

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

  24.   <td style="padding-left: 0.5em;">

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

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

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

  33. <!-- Generated by Doxygen 1.8.8 -->

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

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

  36. </script>

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

  38.     <ul class="tablist">

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

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

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

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

  43.       <li>

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

  45.         <span class="left">

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

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

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

  49.                alt=""/>

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

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

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

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

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

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

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

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

  62.     <ul class="tablist">

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

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

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

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

  67.     </ul>

  68.   </div>

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

  70. <div id="MSearchSelectWindow"

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

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

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

  74. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  75. 

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

  77. <div id="MSearchResultsWindow">

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

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

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

  84. <div class="header">

  85.   <div class="summary">

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

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

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

  89.   <div class="headertitle">

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

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

  92. <div class="contents">

  93. 

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

  95. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  123. </table>

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

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

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

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

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

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

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

  131. <div class="memitem">

  132. <div class="memproto">

  133. <table class="mlabels">

  134.   <tr>

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

  136.       <table class="memname">

  137.         <tr>

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

  139.           <td>(</td>

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

  141.           <td></td>

  142.         </tr>

  143.       </table>

  144.   </td>

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

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

  147.   </tr>

  148. </table>

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

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

  151. 

  152. </div>

  153. </div>

  154. <a class="anchor" id="aad2afc730bee791aab1811744a48f99d"></a>

  155. <div class="memitem">

  156. <div class="memproto">

  157. <table class="mlabels">

  158.   <tr>

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

  160.       <table class="memname">

  161.         <tr>

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

  163.           <td>(</td>

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

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

  166.         </tr>

  167.         <tr>

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

  169.           <td></td>

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

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

  172.         </tr>

  173.         <tr>

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

  175.           <td></td>

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

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

  178.         </tr>

  179.         <tr>

  180.           <td></td>

  181.           <td>)</td>

  182.           <td></td><td></td>

  183.         </tr>

  184.       </table>

  185.   </td>

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

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

  188.   </tr>

  189. </table>

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

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

  192. 

  193. </div>

  194. </div>

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

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

  197. <div class="memitem">

  198. <div class="memproto">

  199. <table class="mlabels">

  200.   <tr>

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

  202.       <table class="memname">

  203.         <tr>

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

  205.           <td>(</td>

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

  207.           <td></td>

  208.         </tr>

  209.       </table>

  210.   </td>

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

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

  213.   </tr>

  214. </table>

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

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

  217. 

  218. </div>

  219. </div>

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

  221. <div class="memitem">

  222. <div class="memproto">

  223. <table class="mlabels">

  224.   <tr>

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

  226.       <table class="memname">

  227.         <tr>

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

  229.           <td>(</td>

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

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

  232.           <td> const</td>

  233.         </tr>

  234.       </table>

  235.   </td>

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

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

  238.   </tr>

  239. </table>

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

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

  242. 

  243. </div>

  244. </div>

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

  246. <div class="memitem">

  247. <div class="memproto">

  248. <table class="mlabels">

  249.   <tr>

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

  251.       <table class="memname">

  252.         <tr>

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

  254.           <td>(</td>

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

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

  257.           <td> const</td>

  258.         </tr>

  259.       </table>

  260.   </td>

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

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

  263.   </tr>

  264. </table>

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

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

  267. 

  268. </div>

  269. </div>

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

  271. <div class="memitem">

  272. <div class="memproto">

  273. <table class="mlabels">

  274.   <tr>

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

  276.       <table class="memname">

  277.         <tr>

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

  279.           <td>(</td>

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

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

  282.           <td> const</td>

  283.         </tr>

  284.       </table>

  285.   </td>

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

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

  288.   </tr>

  289. </table>

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

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

  292. 

  293. </div>

  294. </div>

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

  296. <div class="memitem">

  297. <div class="memproto">

  298. <table class="mlabels">

  299.   <tr>

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

  301.       <table class="memname">

  302.         <tr>

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

  304.           <td>(</td>

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

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

  307.           <td> const</td>

  308.         </tr>

  309.       </table>

  310.   </td>

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

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

  313.   </tr>

  314. </table>

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

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

  317. 

  318. </div>

  319. </div>

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

  321. <div class="memitem">

  322. <div class="memproto">

  323. <table class="mlabels">

  324.   <tr>

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

  326.       <table class="memname">

  327.         <tr>

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

  329.           <td>(</td>

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

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

  332.           <td> const</td>

  333.         </tr>

  334.       </table>

  335.   </td>

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

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

  338.   </tr>

  339. </table>

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

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

  342. 

  343. </div>

  344. </div>

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

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

  347. <div class="memitem">

  348. <div class="memproto">

  349.       <table class="memname">

  350.         <tr>

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

  352.         </tr>

  353.       </table>

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

  355. <p>Default value. </p>

  356. 

  357. </div>

  358. </div>

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

  360. <div class="memitem">

  361. <div class="memproto">

  362.       <table class="memname">

  363.         <tr>

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

  365.         </tr>

  366.       </table>

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

  368. <p>Minimum value. </p>

  369. 

  370. </div>

  371. </div>

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

  373. <div class="memitem">

  374. <div class="memproto">

  375.       <table class="memname">

  376.         <tr>

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

  378.         </tr>

  379.       </table>

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

  381. <p>Maximum value. </p>

  382. 

  383. </div>

  384. </div>

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

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

  387. </ul>

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

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

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

  391. Generated on Sun Apr 26 2015 16:30:13 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  393. </a> 1.8.8

  394. </small></address>

  395. </body>

  396. </html>