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.
373 Commits
7 Branches
295MB
Tree: 1bf6b55edf
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1bf6b55edf'
${ noResults }
DPF/group__ParameterHints.html

238 lines
11KB
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: Parameter Hints</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><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><!-- top -->

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

  63. <div id="MSearchSelectWindow"

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

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

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

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

  68. 

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

  70. <div id="MSearchResultsWindow">

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

  72.         name="MSearchResults" id="MSearchResults">

  73. </iframe>

  74. </div>

  75. 

  76. <div class="header">

  77.   <div class="summary">

  78. <a href="#var-members">Variables</a>  </div>

  79.   <div class="headertitle">

  80. <div class="title">Parameter Hints</div>  </div>

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

  82. <div class="contents">

  83. <table class="memberdecls">

  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>

  85. Variables</h2></td></tr>

  86. <tr class="memitem:ga04161ef926442aa08ae7aa6847078ad9"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a> = 0x01</td></tr>

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

  88. <tr class="memitem:gaafca30df903781d2e1c2491808e17c8d"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">kParameterIsBoolean</a> = 0x02</td></tr>

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

  90. <tr class="memitem:ga76a82c93efe6ad728c9f0cb4ef33a2b9"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#ga76a82c93efe6ad728c9f0cb4ef33a2b9">kParameterIsInteger</a> = 0x04</td></tr>

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

  92. <tr class="memitem:gabc539ecbfe420246a33f93aed32b8a3b"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#gabc539ecbfe420246a33f93aed32b8a3b">kParameterIsLogarithmic</a> = 0x08</td></tr>

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

  94. <tr class="memitem:ga0a3633c93e8589f4b3e6124bb97ad8d4"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#ga0a3633c93e8589f4b3e6124bb97ad8d4">kParameterIsOutput</a> = 0x10</td></tr>

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

  96. <tr class="memitem:ga1eae4d034f2ff1bc14035d87c4b63b14"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#ga1eae4d034f2ff1bc14035d87c4b63b14">kParameterIsCV</a> = 0x20</td></tr>

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

  98. </table>

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

  100. <p>Various parameter hints. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">Parameter::hints</a> </dd></dl>

  101. <h2 class="groupheader">Variable Documentation</h2>

  102. <a class="anchor" id="ga04161ef926442aa08ae7aa6847078ad9"></a>

  103. <div class="memitem">

  104. <div class="memproto">

  105. <table class="mlabels">

  106.   <tr>

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

  108.       <table class="memname">

  109.         <tr>

  110.           <td class="memname">const uint32_t kParameterIsAutomable = 0x01</td>

  111.         </tr>

  112.       </table>

  113.   </td>

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

  115. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  116.   </tr>

  117. </table>

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

  119. <p><a class="el" href="structParameter.html">Parameter</a> is automable (real-time safe). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a4cdd613f58a013429094700f3d83904a">Plugin::d_setParameterValue()</a> </dd></dl>

  120. 

  121. </div>

  122. </div>

  123. <a class="anchor" id="gaafca30df903781d2e1c2491808e17c8d"></a>

  124. <div class="memitem">

  125. <div class="memproto">

  126. <table class="mlabels">

  127.   <tr>

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

  129.       <table class="memname">

  130.         <tr>

  131.           <td class="memname">const uint32_t kParameterIsBoolean = 0x02</td>

  132.         </tr>

  133.       </table>

  134.   </td>

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

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

  137.   </tr>

  138. </table>

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

  140. <p><a class="el" href="structParameter.html">Parameter</a> value is boolean. It's always at either minimum or maximum value. </p>

  141. 

  142. </div>

  143. </div>

  144. <a class="anchor" id="ga76a82c93efe6ad728c9f0cb4ef33a2b9"></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">const uint32_t kParameterIsInteger = 0x04</td>

  153.         </tr>

  154.       </table>

  155.   </td>

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

  157. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  158.   </tr>

  159. </table>

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

  161. <p><a class="el" href="structParameter.html">Parameter</a> value is integer. </p>

  162. 

  163. </div>

  164. </div>

  165. <a class="anchor" id="gabc539ecbfe420246a33f93aed32b8a3b"></a>

  166. <div class="memitem">

  167. <div class="memproto">

  168. <table class="mlabels">

  169.   <tr>

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

  171.       <table class="memname">

  172.         <tr>

  173.           <td class="memname">const uint32_t kParameterIsLogarithmic = 0x08</td>

  174.         </tr>

  175.       </table>

  176.   </td>

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

  178. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  179.   </tr>

  180. </table>

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

  182. <p><a class="el" href="structParameter.html">Parameter</a> value is logarithmic. </p>

  183. 

  184. </div>

  185. </div>

  186. <a class="anchor" id="ga0a3633c93e8589f4b3e6124bb97ad8d4"></a>

  187. <div class="memitem">

  188. <div class="memproto">

  189. <table class="mlabels">

  190.   <tr>

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

  192.       <table class="memname">

  193.         <tr>

  194.           <td class="memname">const uint32_t kParameterIsOutput = 0x10</td>

  195.         </tr>

  196.       </table>

  197.   </td>

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

  199. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  200.   </tr>

  201. </table>

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

  203. <p><a class="el" href="structParameter.html">Parameter</a> is of output type. When unset, parameter is assumed to be of input type.</p>

  204. <p><a class="el" href="structParameter.html">Parameter</a> inputs are changed by the host and must not be changed by the plugin. The only exception being when changing programs, see <a class="el" href="classPlugin.html#a1d001e50781b35df23f6d9a218f5f804">Plugin::d_setProgram()</a>. Outputs are changed by the plugin and never modified by the host. </p>

  205. 

  206. </div>

  207. </div>

  208. <a class="anchor" id="ga1eae4d034f2ff1bc14035d87c4b63b14"></a>

  209. <div class="memitem">

  210. <div class="memproto">

  211. <table class="mlabels">

  212.   <tr>

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

  214.       <table class="memname">

  215.         <tr>

  216.           <td class="memname">const uint32_t kParameterIsCV = 0x20</td>

  217.         </tr>

  218.       </table>

  219.   </td>

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

  221. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  222.   </tr>

  223. </table>

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

  225. <p><a class="el" href="structParameter.html">Parameter</a> can be used as control voltage (LV2 only). </p>

  226. 

  227. </div>

  228. </div>

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

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

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

  232. Generated on Tue Apr 21 2015 15:18:54 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  234. </a> 1.8.8

  235. </small></address>

  236. </body>

  237. </html>