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

294 lines
13KB
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: 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/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="structParameter-members.html">List of all members</a>  </div>

  90.   <div class="headertitle">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  116. </table>

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

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

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

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

  121. <div class="memitem">

  122. <div class="memproto">

  123. <table class="mlabels">

  124.   <tr>

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

  126.       <table class="memname">

  127.         <tr>

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

  129.           <td>(</td>

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

  131.           <td></td>

  132.         </tr>

  133.       </table>

  134.   </td>

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

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

  137.   </tr>

  138. </table>

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

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

  141. 

  142. </div>

  143. </div>

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

  145. <div class="memitem">

  146. <div class="memproto">

  147. <table class="mlabels">

  148.   <tr>

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

  150.       <table class="memname">

  151.         <tr>

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

  153.           <td>(</td>

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

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

  156.         </tr>

  157.         <tr>

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

  159.           <td></td>

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

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

  162.         </tr>

  163.         <tr>

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

  165.           <td></td>

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

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

  168.         </tr>

  169.         <tr>

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

  171.           <td></td>

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

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

  174.         </tr>

  175.         <tr>

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

  177.           <td></td>

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

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

  180.         </tr>

  181.         <tr>

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

  183.           <td></td>

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

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

  186.         </tr>

  187.         <tr>

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

  189.           <td></td>

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

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

  192.         </tr>

  193.         <tr>

  194.           <td></td>

  195.           <td>)</td>

  196.           <td></td><td></td>

  197.         </tr>

  198.       </table>

  199.   </td>

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

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

  202.   </tr>

  203. </table>

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

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

  206. 

  207. </div>

  208. </div>

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

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

  211. <div class="memitem">

  212. <div class="memproto">

  213.       <table class="memname">

  214.         <tr>

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

  216.         </tr>

  217.       </table>

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

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

  220. 

  221. </div>

  222. </div>

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

  224. <div class="memitem">

  225. <div class="memproto">

  226.       <table class="memname">

  227.         <tr>

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

  229.         </tr>

  230.       </table>

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

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

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

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

  235. 

  236. </div>

  237. </div>

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

  239. <div class="memitem">

  240. <div class="memproto">

  241.       <table class="memname">

  242.         <tr>

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

  244.         </tr>

  245.       </table>

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

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

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

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

  250. 

  251. </div>

  252. </div>

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

  254. <div class="memitem">

  255. <div class="memproto">

  256.       <table class="memname">

  257.         <tr>

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

  259.         </tr>

  260.       </table>

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

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

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

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

  265. 

  266. </div>

  267. </div>

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

  269. <div class="memitem">

  270. <div class="memproto">

  271.       <table class="memname">

  272.         <tr>

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

  274.         </tr>

  275.       </table>

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

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

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

  279. 

  280. </div>

  281. </div>

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

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

  284. </ul>

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

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

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

  288. Generated on Tue Jun 7 2016 14:04:29 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  290. </a> 1.8.11

  291. </small></address>

  292. </body>

  293. </html>