|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.9.1"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>DISTRHO Plugin Framework: ParameterRanges Struct Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">DISTRHO Plugin Framework
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.1 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-attribs">Public Attributes</a> |
- <a href="structParameterRanges-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">ParameterRanges Struct Reference<div class="ingroups"><a class="el" href="group__BasePluginStructs.html">Base Plugin Structs</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
-
- <p><code>#include <<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a9b41c9c726cd92c7c1cc8501b36ad9b6"><td class="memItemLeft" align="right" valign="top">constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a9b41c9c726cd92c7c1cc8501b36ad9b6">ParameterRanges</a> () noexcept</td></tr>
- <tr class="separator:a9b41c9c726cd92c7c1cc8501b36ad9b6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6ba24c6e129e37975fa7afcc15fd48e4"><td class="memItemLeft" align="right" valign="top">constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a6ba24c6e129e37975fa7afcc15fd48e4">ParameterRanges</a> (const float df, const float mn, const float mx) noexcept</td></tr>
- <tr class="separator:a6ba24c6e129e37975fa7afcc15fd48e4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a17519e584ccc28e87b73bfbd1a81cf10"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a17519e584ccc28e87b73bfbd1a81cf10">fixDefault</a> () noexcept</td></tr>
- <tr class="separator:a17519e584ccc28e87b73bfbd1a81cf10"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1dac84c100f420bfc529a4d2ea60dc7c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a1dac84c100f420bfc529a4d2ea60dc7c">fixValue</a> (float &value) const noexcept</td></tr>
- <tr class="separator:a1dac84c100f420bfc529a4d2ea60dc7c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85687844ae66f199015e14e6b9973f34"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a85687844ae66f199015e14e6b9973f34">getFixedValue</a> (const float value) const noexcept</td></tr>
- <tr class="separator:a85687844ae66f199015e14e6b9973f34"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a215512088b0d0d8f7755bfe35c218602"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a215512088b0d0d8f7755bfe35c218602">getNormalizedValue</a> (const float value) const noexcept</td></tr>
- <tr class="separator:a215512088b0d0d8f7755bfe35c218602"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acabe1b8a99a2859b5fe751de18ddcdd7"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#acabe1b8a99a2859b5fe751de18ddcdd7">getNormalizedValue</a> (const double &value) const noexcept</td></tr>
- <tr class="separator:acabe1b8a99a2859b5fe751de18ddcdd7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0faba98afd9f9c580acc54abe4ddeab5"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a0faba98afd9f9c580acc54abe4ddeab5">getFixedAndNormalizedValue</a> (const float value) const noexcept</td></tr>
- <tr class="separator:a0faba98afd9f9c580acc54abe4ddeab5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a71929d241eb5ff5b5bb061a3142845ff"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a71929d241eb5ff5b5bb061a3142845ff">getFixedAndNormalizedValue</a> (const double value) const noexcept</td></tr>
- <tr class="separator:a71929d241eb5ff5b5bb061a3142845ff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a05eb5f161319811b6e18863b72e3b453"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a05eb5f161319811b6e18863b72e3b453">getUnnormalizedValue</a> (const float value) const noexcept</td></tr>
- <tr class="separator:a05eb5f161319811b6e18863b72e3b453"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad3aaf320e0f5e19bbca00bf0919e5b21"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#ad3aaf320e0f5e19bbca00bf0919e5b21">getUnnormalizedValue</a> (const double value) const noexcept</td></tr>
- <tr class="separator:ad3aaf320e0f5e19bbca00bf0919e5b21"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
- Public Attributes</h2></td></tr>
- <tr class="memitem:aa0aba68115bcfff25c35b2da2f7aed4c"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">def</a></td></tr>
- <tr class="separator:aa0aba68115bcfff25c35b2da2f7aed4c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a63c40988463a8ace9d0e9e55a00f3c7b"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a63c40988463a8ace9d0e9e55a00f3c7b">min</a></td></tr>
- <tr class="separator:a63c40988463a8ace9d0e9e55a00f3c7b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a175c78c905c598df929a4450e4d2a2a0"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html#a175c78c905c598df929a4450e4d2a2a0">max</a></td></tr>
- <tr class="separator:a175c78c905c598df929a4450e4d2a2a0"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p><a class="el" href="structParameter.html">Parameter</a> ranges.<br />
- This is used to set the default, minimum and maximum values of a parameter.</p>
- <p>By default a parameter has 0.0 as minimum, 1.0 as maximum and 0.0 as default.<br />
- When changing this struct values you must ensure maximum > minimum and default is within range. </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a9b41c9c726cd92c7c1cc8501b36ad9b6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9b41c9c726cd92c7c1cc8501b36ad9b6">◆ </a></span>ParameterRanges() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">constexpr ParameterRanges::ParameterRanges </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Default constructor, using 0.0 as default, 0.0 as minimum, 1.0 as maximum. </p>
-
- </div>
- </div>
- <a id="a6ba24c6e129e37975fa7afcc15fd48e4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6ba24c6e129e37975fa7afcc15fd48e4">◆ </a></span>ParameterRanges() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">constexpr ParameterRanges::ParameterRanges </td>
- <td>(</td>
- <td class="paramtype">const float </td>
- <td class="paramname"><em>df</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const float </td>
- <td class="paramname"><em>mn</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const float </td>
- <td class="paramname"><em>mx</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Constructor using custom values. </p>
-
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a17519e584ccc28e87b73bfbd1a81cf10"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a17519e584ccc28e87b73bfbd1a81cf10">◆ </a></span>fixDefault()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ParameterRanges::fixDefault </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Fix the default value within range. </p>
-
- </div>
- </div>
- <a id="a1dac84c100f420bfc529a4d2ea60dc7c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1dac84c100f420bfc529a4d2ea60dc7c">◆ </a></span>fixValue()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ParameterRanges::fixValue </td>
- <td>(</td>
- <td class="paramtype">float & </td>
- <td class="paramname"><em>value</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Fix a value within range. </p>
-
- </div>
- </div>
- <a id="a85687844ae66f199015e14e6b9973f34"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a85687844ae66f199015e14e6b9973f34">◆ </a></span>getFixedValue()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">float ParameterRanges::getFixedValue </td>
- <td>(</td>
- <td class="paramtype">const float </td>
- <td class="paramname"><em>value</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a fixed value within range. </p>
-
- </div>
- </div>
- <a id="a215512088b0d0d8f7755bfe35c218602"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a215512088b0d0d8f7755bfe35c218602">◆ </a></span>getNormalizedValue() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">float ParameterRanges::getNormalizedValue </td>
- <td>(</td>
- <td class="paramtype">const float </td>
- <td class="paramname"><em>value</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a value normalized to 0.0<->1.0. </p>
-
- </div>
- </div>
- <a id="acabe1b8a99a2859b5fe751de18ddcdd7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acabe1b8a99a2859b5fe751de18ddcdd7">◆ </a></span>getNormalizedValue() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">double ParameterRanges::getNormalizedValue </td>
- <td>(</td>
- <td class="paramtype">const double & </td>
- <td class="paramname"><em>value</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a value normalized to 0.0<->1.0. Overloaded function using double precision values. </p>
-
- </div>
- </div>
- <a id="a0faba98afd9f9c580acc54abe4ddeab5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0faba98afd9f9c580acc54abe4ddeab5">◆ </a></span>getFixedAndNormalizedValue() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">float ParameterRanges::getFixedAndNormalizedValue </td>
- <td>(</td>
- <td class="paramtype">const float </td>
- <td class="paramname"><em>value</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a value normalized to 0.0<->1.0, fixed within range. </p>
-
- </div>
- </div>
- <a id="a71929d241eb5ff5b5bb061a3142845ff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a71929d241eb5ff5b5bb061a3142845ff">◆ </a></span>getFixedAndNormalizedValue() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">double ParameterRanges::getFixedAndNormalizedValue </td>
- <td>(</td>
- <td class="paramtype">const double </td>
- <td class="paramname"><em>value</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a value normalized to 0.0<->1.0, fixed within range. Overloaded function using double precision values. </p>
-
- </div>
- </div>
- <a id="a05eb5f161319811b6e18863b72e3b453"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a05eb5f161319811b6e18863b72e3b453">◆ </a></span>getUnnormalizedValue() <span class="overload">[1/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">float ParameterRanges::getUnnormalizedValue </td>
- <td>(</td>
- <td class="paramtype">const float </td>
- <td class="paramname"><em>value</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a proper value previously normalized to 0.0<->1.0. </p>
-
- </div>
- </div>
- <a id="ad3aaf320e0f5e19bbca00bf0919e5b21"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad3aaf320e0f5e19bbca00bf0919e5b21">◆ </a></span>getUnnormalizedValue() <span class="overload">[2/2]</span></h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">double ParameterRanges::getUnnormalizedValue </td>
- <td>(</td>
- <td class="paramtype">const double </td>
- <td class="paramname"><em>value</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a proper value previously normalized to 0.0<->1.0. Overloaded function using double precision values. </p>
-
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="aa0aba68115bcfff25c35b2da2f7aed4c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa0aba68115bcfff25c35b2da2f7aed4c">◆ </a></span>def</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float ParameterRanges::def</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Default value. </p>
-
- </div>
- </div>
- <a id="a63c40988463a8ace9d0e9e55a00f3c7b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a63c40988463a8ace9d0e9e55a00f3c7b">◆ </a></span>min</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float ParameterRanges::min</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Minimum value. </p>
-
- </div>
- </div>
- <a id="a175c78c905c598df929a4450e4d2a2a0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a175c78c905c598df929a4450e4d2a2a0">◆ </a></span>max</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">float ParameterRanges::max</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Maximum value. </p>
-
- </div>
- </div>
- <hr/>The documentation for this struct was generated from the following file:<ul>
- <li>distrho/<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
- </small></address>
- </body>
- </html>
|