DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DISTRHO Plugin Framework: Parameter 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.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structParameter-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Parameter 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 &lt;<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a>&gt;</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:a12ced87d6d832deccb6c8ce2c8313b2e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a12ced87d6d832deccb6c8ce2c8313b2e">Parameter</a> () noexcept</td></tr>
<tr class="separator:a12ced87d6d832deccb6c8ce2c8313b2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0c5eeebedfe0058775a7ff4d904b6ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#af0c5eeebedfe0058775a7ff4d904b6ab">Parameter</a> (uint32_t h, const char *n, const char *s, const char *u, float def, float min, float max) noexcept</td></tr>
<tr class="separator:af0c5eeebedfe0058775a7ff4d904b6ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad959d31bcfaa056908406bbf37c134bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#ad959d31bcfaa056908406bbf37c134bf">initDesignation</a> (<a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> d) noexcept</td></tr>
<tr class="separator:ad959d31bcfaa056908406bbf37c134bf"><td class="memSeparator" colspan="2">&#160;</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:a397fb977f0c6cbec31df4f141ca3f5b3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a></td></tr>
<tr class="separator:a397fb977f0c6cbec31df4f141ca3f5b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae63c1fcfb20e320bada1f58c04ff18da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a></td></tr>
<tr class="separator:ae63c1fcfb20e320bada1f58c04ff18da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e546efd8dbd0d77351208b670719468"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a></td></tr>
<tr class="separator:a3e546efd8dbd0d77351208b670719468"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f79574998d34504e3a694163b4599a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a2f79574998d34504e3a694163b4599a1">unit</a></td></tr>
<tr class="separator:a2f79574998d34504e3a694163b4599a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d0c81e4fb8fad18d920ef6ecd4a64db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structParameterRanges.html">ParameterRanges</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a></td></tr>
<tr class="separator:a2d0c81e4fb8fad18d920ef6ecd4a64db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab94ec79aad8e8f6e4bc33d046f029358"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#ab94ec79aad8e8f6e4bc33d046f029358">enumValues</a></td></tr>
<tr class="separator:ab94ec79aad8e8f6e4bc33d046f029358"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bbf6f7d5ccea9a13504bd6ee3713986"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a3bbf6f7d5ccea9a13504bd6ee3713986">designation</a></td></tr>
<tr class="separator:a3bbf6f7d5ccea9a13504bd6ee3713986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5389731e4cd95cac10af9aec9aa7b202"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a5389731e4cd95cac10af9aec9aa7b202">midiCC</a></td></tr>
<tr class="separator:a5389731e4cd95cac10af9aec9aa7b202"><td class="memSeparator" colspan="2">&#160;</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>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a12ced87d6d832deccb6c8ce2c8313b2e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12ced87d6d832deccb6c8ce2c8313b2e">&#9670;&nbsp;</a></span>Parameter() <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">Parameter::Parameter </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>Default constructor for a null parameter. </p>

</div>
</div>
<a id="af0c5eeebedfe0058775a7ff4d904b6ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0c5eeebedfe0058775a7ff4d904b6ab">&#9670;&nbsp;</a></span>Parameter() <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">Parameter::Parameter </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>h</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>u</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>def</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>min</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>max</em>&#160;</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">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="ad959d31bcfaa056908406bbf37c134bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad959d31bcfaa056908406bbf37c134bf">&#9670;&nbsp;</a></span>initDesignation()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void Parameter::initDesignation </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a>&#160;</td>
          <td class="paramname"><em>d</em></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>Initialize a parameter for a specific designation. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a397fb977f0c6cbec31df4f141ca3f5b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a397fb977f0c6cbec31df4f141ca3f5b3">&#9670;&nbsp;</a></span>hints</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Parameter::hints</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Hints describing this parameter. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ParameterHints.html">Parameter Hints</a> </dd></dl>

</div>
</div>
<a id="ae63c1fcfb20e320bada1f58c04ff18da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae63c1fcfb20e320bada1f58c04ff18da">&#9670;&nbsp;</a></span>name</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classString.html">String</a> Parameter::name</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The name of this parameter.<br />
A parameter name can contain any character, but hosts might have a hard time with non-ascii ones.<br />
The name doesn't have to be unique within a plugin instance, but it's recommended. </p>

</div>
</div>
<a id="a3e546efd8dbd0d77351208b670719468"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e546efd8dbd0d77351208b670719468">&#9670;&nbsp;</a></span>symbol</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classString.html">String</a> Parameter::symbol</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The symbol of this parameter.<br />
A parameter symbol is a short restricted name used as a machine and human readable identifier.<br />
The first character must be one of _, a-z or A-Z and subsequent characters can be from _, a-z, A-Z and 0-9. </p><dl class="section note"><dt>Note</dt><dd><a class="el" href="structParameter.html">Parameter</a> symbols MUST be unique within a plugin instance. </dd></dl>

</div>
</div>
<a id="a2f79574998d34504e3a694163b4599a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f79574998d34504e3a694163b4599a1">&#9670;&nbsp;</a></span>unit</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classString.html">String</a> Parameter::unit</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The unit of this parameter.<br />
This means something like "dB", "kHz" and "ms".<br />
Can be left blank if a unit does not apply to this parameter. </p>

</div>
</div>
<a id="a2d0c81e4fb8fad18d920ef6ecd4a64db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d0c81e4fb8fad18d920ef6ecd4a64db">&#9670;&nbsp;</a></span>ranges</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structParameterRanges.html">ParameterRanges</a> Parameter::ranges</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Ranges of this parameter.<br />
The ranges describe the default, minimum and maximum values. </p>

</div>
</div>
<a id="ab94ec79aad8e8f6e4bc33d046f029358"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab94ec79aad8e8f6e4bc33d046f029358">&#9670;&nbsp;</a></span>enumValues</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a> Parameter::enumValues</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Enumeration values.<br />
Can be used to give meaning to parameter values, working as an enumeration. </p>

</div>
</div>
<a id="a3bbf6f7d5ccea9a13504bd6ee3713986"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bbf6f7d5ccea9a13504bd6ee3713986">&#9670;&nbsp;</a></span>designation</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> Parameter::designation</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Designation for this parameter. </p>

</div>
</div>
<a id="a5389731e4cd95cac10af9aec9aa7b202"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5389731e4cd95cac10af9aec9aa7b202">&#9670;&nbsp;</a></span>midiCC</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t Parameter::midiCC</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>MIDI CC to use by default on this parameter.<br />
A value of 0 or 32 (bank change) is considered invalid.<br />
Must also be less or equal to 120. </p><dl class="section note"><dt>Note</dt><dd>This value is only a hint! Hosts might map it automatically or completely ignore it. </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>distrho/<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Apr 7 2019 05:47:58 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>