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

247 lines
12KB
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 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.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><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>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>

  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:ga068de47c587411c9e91ef09f7d800884"><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#ga068de47c587411c9e91ef09f7d800884">kParameterIsTrigger</a> = 0x20 | kParameterIsBoolean</td></tr>

  97. <tr class="separator:ga068de47c587411c9e91ef09f7d800884"><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>

  101. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">Parameter::hints</a> </dd></dl>

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

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

  104. <div class="memitem">

  105. <div class="memproto">

  106. <table class="mlabels">

  107.   <tr>

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

  109.       <table class="memname">

  110.         <tr>

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

  112.         </tr>

  113.       </table>

  114.   </td>

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

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

  117.   </tr>

  118. </table>

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

  120. <p><a class="el" href="structParameter.html">Parameter</a> is automable (real-time safe). </p>

  121. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classPlugin.html#a6911a881fabb9eca9daf0eadbaad8599">Plugin::setParameterValue(uint32_t, float)</a> </dd></dl>

  122. 

  123. </div>

  124. </div>

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

  126. <div class="memitem">

  127. <div class="memproto">

  128. <table class="mlabels">

  129.   <tr>

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

  131.       <table class="memname">

  132.         <tr>

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

  134.         </tr>

  135.       </table>

  136.   </td>

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

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

  139.   </tr>

  140. </table>

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

  142. <p><a class="el" href="structParameter.html">Parameter</a> value is boolean.<br/>

  143. It's always at either minimum or maximum value. </p>

  144. 

  145. </div>

  146. </div>

  147. <a class="anchor" id="ga76a82c93efe6ad728c9f0cb4ef33a2b9"></a>

  148. <div class="memitem">

  149. <div class="memproto">

  150. <table class="mlabels">

  151.   <tr>

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

  153.       <table class="memname">

  154.         <tr>

  155.           <td class="memname">const uint32_t kParameterIsInteger = 0x04</td>

  156.         </tr>

  157.       </table>

  158.   </td>

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

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

  161.   </tr>

  162. </table>

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

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

  165. 

  166. </div>

  167. </div>

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

  169. <div class="memitem">

  170. <div class="memproto">

  171. <table class="mlabels">

  172.   <tr>

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

  174.       <table class="memname">

  175.         <tr>

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

  177.         </tr>

  178.       </table>

  179.   </td>

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

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

  182.   </tr>

  183. </table>

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

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

  186. 

  187. </div>

  188. </div>

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

  190. <div class="memitem">

  191. <div class="memproto">

  192. <table class="mlabels">

  193.   <tr>

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

  195.       <table class="memname">

  196.         <tr>

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

  198.         </tr>

  199.       </table>

  200.   </td>

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

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

  203.   </tr>

  204. </table>

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

  206. <p><a class="el" href="structParameter.html">Parameter</a> is of output type.<br/>

  207. When unset, parameter is assumed to be of input type.</p>

  208. <p><a class="el" href="structParameter.html">Parameter</a> inputs are changed by the host and must not be changed by the plugin.<br/>

  209. The only exception being when changing programs, see <a class="el" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">Plugin::loadProgram()</a>.<br/>

  210. Outputs are changed by the plugin and never modified by the host. </p>

  211. 

  212. </div>

  213. </div>

  214. <a class="anchor" id="ga068de47c587411c9e91ef09f7d800884"></a>

  215. <div class="memitem">

  216. <div class="memproto">

  217. <table class="mlabels">

  218.   <tr>

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

  220.       <table class="memname">

  221.         <tr>

  222.           <td class="memname">const uint32_t kParameterIsTrigger = 0x20 | kParameterIsBoolean</td>

  223.         </tr>

  224.       </table>

  225.   </td>

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

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

  228.   </tr>

  229. </table>

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

  231. <p><a class="el" href="structParameter.html">Parameter</a> value is a trigger.<br/>

  232. This means the value resets back to its default after each process/run call.<br/>

  233. Cannot be used for output parameters.</p>

  234. <dl class="section note"><dt>Note</dt><dd>Only officially supported under LV2. For other formats DPF simulates the behaviour. </dd></dl>

  235. 

  236. </div>

  237. </div>

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

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

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

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

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

  243. </a> 1.8.6

  244. </small></address>

  245. </body>

  246. </html>