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.
391 Commits
7 Branches
270MB
Tree: e20bc6408d
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e20bc6408d'
${ noResults }
DPF/structParameter.html

372 lines
18KB
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.6"/>

  7. <title>DISTRHO Plugin Framework: Parameter 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.6 -->

  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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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="structParameter-members.html">List of all members</a>  </div>

  89.   <div class="headertitle">

  90. <div class="title">Parameter 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: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  122. <tr class="separator:a5389731e4cd95cac10af9aec9aa7b202"><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>. </p>

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

  127. <a class="anchor" id="a12ced87d6d832deccb6c8ce2c8313b2e"></a>

  128. <div class="memitem">

  129. <div class="memproto">

  130. <table class="mlabels">

  131.   <tr>

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

  133.       <table class="memname">

  134.         <tr>

  135.           <td class="memname">Parameter::Parameter </td>

  136.           <td>(</td>

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

  138.           <td></td>

  139.         </tr>

  140.       </table>

  141.   </td>

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

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

  144.   </tr>

  145. </table>

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

  147. <p>Default constructor for a null parameter. </p>

  148. 

  149. </div>

  150. </div>

  151. <a class="anchor" id="af0c5eeebedfe0058775a7ff4d904b6ab"></a>

  152. <div class="memitem">

  153. <div class="memproto">

  154. <table class="mlabels">

  155.   <tr>

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

  157.       <table class="memname">

  158.         <tr>

  159.           <td class="memname">Parameter::Parameter </td>

  160.           <td>(</td>

  161.           <td class="paramtype">uint32_t&#160;</td>

  162.           <td class="paramname"><em>h</em>, </td>

  163.         </tr>

  164.         <tr>

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

  166.           <td></td>

  167.           <td class="paramtype">const char *&#160;</td>

  168.           <td class="paramname"><em>n</em>, </td>

  169.         </tr>

  170.         <tr>

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

  172.           <td></td>

  173.           <td class="paramtype">const char *&#160;</td>

  174.           <td class="paramname"><em>s</em>, </td>

  175.         </tr>

  176.         <tr>

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

  178.           <td></td>

  179.           <td class="paramtype">const char *&#160;</td>

  180.           <td class="paramname"><em>u</em>, </td>

  181.         </tr>

  182.         <tr>

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

  184.           <td></td>

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

  186.           <td class="paramname"><em>def</em>, </td>

  187.         </tr>

  188.         <tr>

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

  190.           <td></td>

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

  192.           <td class="paramname"><em>min</em>, </td>

  193.         </tr>

  194.         <tr>

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

  196.           <td></td>

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

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

  199.         </tr>

  200.         <tr>

  201.           <td></td>

  202.           <td>)</td>

  203.           <td></td><td></td>

  204.         </tr>

  205.       </table>

  206.   </td>

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

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

  209.   </tr>

  210. </table>

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

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

  213. 

  214. </div>

  215. </div>

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

  217. <a class="anchor" id="ad959d31bcfaa056908406bbf37c134bf"></a>

  218. <div class="memitem">

  219. <div class="memproto">

  220. <table class="mlabels">

  221.   <tr>

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

  223.       <table class="memname">

  224.         <tr>

  225.           <td class="memname">void Parameter::initDesignation </td>

  226.           <td>(</td>

  227.           <td class="paramtype"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a>&#160;</td>

  228.           <td class="paramname"><em>d</em></td><td>)</td>

  229.           <td></td>

  230.         </tr>

  231.       </table>

  232.   </td>

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

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

  235.   </tr>

  236. </table>

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

  238. <p>Initialize a parameter for a specific designation. </p>

  239. 

  240. </div>

  241. </div>

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

  243. <a class="anchor" id="a397fb977f0c6cbec31df4f141ca3f5b3"></a>

  244. <div class="memitem">

  245. <div class="memproto">

  246.       <table class="memname">

  247.         <tr>

  248.           <td class="memname">uint32_t Parameter::hints</td>

  249.         </tr>

  250.       </table>

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

  252. <p>Hints describing this parameter. </p>

  253. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__ParameterHints.html">Parameter Hints</a> </dd></dl>

  254. 

  255. </div>

  256. </div>

  257. <a class="anchor" id="ae63c1fcfb20e320bada1f58c04ff18da"></a>

  258. <div class="memitem">

  259. <div class="memproto">

  260.       <table class="memname">

  261.         <tr>

  262.           <td class="memname"><a class="el" href="classString.html">String</a> Parameter::name</td>

  263.         </tr>

  264.       </table>

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

  266. <p>The name of this parameter.<br/>

  267. A parameter name can contain any character, but hosts might have a hard time with non-ascii ones.<br/>

  268. The name doesn't have to be unique within a plugin instance, but it's recommended. </p>

  269. 

  270. </div>

  271. </div>

  272. <a class="anchor" id="a3e546efd8dbd0d77351208b670719468"></a>

  273. <div class="memitem">

  274. <div class="memproto">

  275.       <table class="memname">

  276.         <tr>

  277.           <td class="memname"><a class="el" href="classString.html">String</a> Parameter::symbol</td>

  278.         </tr>

  279.       </table>

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

  281. <p>The symbol of this parameter.<br/>

  282. A parameter symbol is a short restricted name used as a machine and human readable identifier.<br/>

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

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

  285. 

  286. </div>

  287. </div>

  288. <a class="anchor" id="a2f79574998d34504e3a694163b4599a1"></a>

  289. <div class="memitem">

  290. <div class="memproto">

  291.       <table class="memname">

  292.         <tr>

  293.           <td class="memname"><a class="el" href="classString.html">String</a> Parameter::unit</td>

  294.         </tr>

  295.       </table>

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

  297. <p>The unit of this parameter.<br/>

  298. This means something like "dB", "kHz" and "ms".<br/>

  299. Can be left blank if a unit does not apply to this parameter. </p>

  300. 

  301. </div>

  302. </div>

  303. <a class="anchor" id="a2d0c81e4fb8fad18d920ef6ecd4a64db"></a>

  304. <div class="memitem">

  305. <div class="memproto">

  306.       <table class="memname">

  307.         <tr>

  308.           <td class="memname"><a class="el" href="structParameterRanges.html">ParameterRanges</a> Parameter::ranges</td>

  309.         </tr>

  310.       </table>

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

  312. <p>Ranges of this parameter.<br/>

  313. The ranges describe the default, minimum and maximum values. </p>

  314. 

  315. </div>

  316. </div>

  317. <a class="anchor" id="ab94ec79aad8e8f6e4bc33d046f029358"></a>

  318. <div class="memitem">

  319. <div class="memproto">

  320.       <table class="memname">

  321.         <tr>

  322.           <td class="memname"><a class="el" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a> Parameter::enumValues</td>

  323.         </tr>

  324.       </table>

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

  326. <p>Enumeration values.<br/>

  327. Can be used to give meaning to parameter values, working as an enumeration. </p>

  328. 

  329. </div>

  330. </div>

  331. <a class="anchor" id="a3bbf6f7d5ccea9a13504bd6ee3713986"></a>

  332. <div class="memitem">

  333. <div class="memproto">

  334.       <table class="memname">

  335.         <tr>

  336.           <td class="memname"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> Parameter::designation</td>

  337.         </tr>

  338.       </table>

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

  340. <p>Designation for this parameter. </p>

  341. 

  342. </div>

  343. </div>

  344. <a class="anchor" id="a5389731e4cd95cac10af9aec9aa7b202"></a>

  345. <div class="memitem">

  346. <div class="memproto">

  347.       <table class="memname">

  348.         <tr>

  349.           <td class="memname">uint8_t Parameter::midiCC</td>

  350.         </tr>

  351.       </table>

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

  353. <p>MIDI CC to use by default on this parameter.<br/>

  354. A value of 0 or 32 (bank change) is considered invalid.<br/>

  355. Must also be less or equal to 120. </p>

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

  357. 

  358. </div>

  359. </div>

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

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

  362. </ul>

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

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

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

  366. Generated on Mon Jun 24 2019 11:54:44 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  368. </a> 1.8.6

  369. </small></address>

  370. </body>

  371. </html>