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.
417 Commits
6 Branches
58MB
Tree: 3b225396b3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '3b225396b3'
${ noResults }
DPF/group__ParameterHints.html

295 lines
14KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: Parameter Hints</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">DISTRHO Plugin Framework

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.9.1 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. </div><!-- top -->

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

  50. <div id="MSearchSelectWindow"

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

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

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

  54. </div>

  55. 

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

  57. <div id="MSearchResultsWindow">

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

  59.         name="MSearchResults" id="MSearchResults">

  60. </iframe>

  61. </div>

  62. 

  63. <div class="header">

  64.   <div class="summary">

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

  66.   <div class="headertitle">

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

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

  69. <div class="contents">

  70. <table class="memberdecls">

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

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

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

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

  75. <tr class="memitem:ga93539c9797820bb5fd7a28d2152711fc"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#ga93539c9797820bb5fd7a28d2152711fc">kParameterIsAutomable</a> = <a class="el" href="group__ParameterHints.html#gaf82d83a105dc418877ef91e84ac6efd3">kParameterIsAutomatable</a></td></tr>

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

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

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

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

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

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

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

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

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

  85. <tr class="memitem:gaa347318fd978d909d6f247377413f871"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#gaa347318fd978d909d6f247377413f871">kParameterIsTrigger</a> = 0x20 | <a class="el" href="group__ParameterHints.html#gae7bfe085cc1ce2d56488254946846dd7">kParameterIsBoolean</a></td></tr>

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

  87. <tr class="memitem:ga8b5cde9360d1f54acfa8d7b6c2d3560d"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#ga8b5cde9360d1f54acfa8d7b6c2d3560d">kParameterIsHidden</a> = 0x40</td></tr>

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

  89. </table>

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

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

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

  93. <a id="gaf82d83a105dc418877ef91e84ac6efd3"></a>

  94. <h2 class="memtitle"><span class="permalink"><a href="#gaf82d83a105dc418877ef91e84ac6efd3">&#9670;&nbsp;</a></span>kParameterIsAutomatable</h2>

  95. 

  96. <div class="memitem">

  97. <div class="memproto">

  98. <table class="mlabels">

  99.   <tr>

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

  101.       <table class="memname">

  102.         <tr>

  103.           <td class="memname">constexpr const uint32_t kParameterIsAutomatable = 0x01</td>

  104.         </tr>

  105.       </table>

  106.   </td>

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

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

  109.   </tr>

  110. </table>

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

  112. <p><a class="el" href="structParameter.html">Parameter</a> is automatable (real-time safe). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a7e9e26ceafc7603ef6163483a9dc39be">Plugin::setParameterValue(uint32_t, float)</a> </dd></dl>

  113. 

  114. </div>

  115. </div>

  116. <a id="ga93539c9797820bb5fd7a28d2152711fc"></a>

  117. <h2 class="memtitle"><span class="permalink"><a href="#ga93539c9797820bb5fd7a28d2152711fc">&#9670;&nbsp;</a></span>kParameterIsAutomable</h2>

  118. 

  119. <div class="memitem">

  120. <div class="memproto">

  121. <table class="mlabels">

  122.   <tr>

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

  124.       <table class="memname">

  125.         <tr>

  126.           <td class="memname">constexpr const uint32_t kParameterIsAutomable = <a class="el" href="group__ParameterHints.html#gaf82d83a105dc418877ef91e84ac6efd3">kParameterIsAutomatable</a></td>

  127.         </tr>

  128.       </table>

  129.   </td>

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

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

  132.   </tr>

  133. </table>

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

  135. <p>It was a typo, sorry.. </p>

  136. 

  137. </div>

  138. </div>

  139. <a id="gae7bfe085cc1ce2d56488254946846dd7"></a>

  140. <h2 class="memtitle"><span class="permalink"><a href="#gae7bfe085cc1ce2d56488254946846dd7">&#9670;&nbsp;</a></span>kParameterIsBoolean</h2>

  141. 

  142. <div class="memitem">

  143. <div class="memproto">

  144. <table class="mlabels">

  145.   <tr>

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

  147.       <table class="memname">

  148.         <tr>

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

  150.         </tr>

  151.       </table>

  152.   </td>

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

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

  155.   </tr>

  156. </table>

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

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

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

  160. 

  161. </div>

  162. </div>

  163. <a id="ga9588f46e0b10f8b690aa8290e9fa7959"></a>

  164. <h2 class="memtitle"><span class="permalink"><a href="#ga9588f46e0b10f8b690aa8290e9fa7959">&#9670;&nbsp;</a></span>kParameterIsInteger</h2>

  165. 

  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">constexpr const uint32_t kParameterIsInteger = 0x04</td>

  174.         </tr>

  175.       </table>

  176.   </td>

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

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

  179.   </tr>

  180. </table>

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

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

  183. 

  184. </div>

  185. </div>

  186. <a id="gaa37037e8977495866d0ea58a2d804f3b"></a>

  187. <h2 class="memtitle"><span class="permalink"><a href="#gaa37037e8977495866d0ea58a2d804f3b">&#9670;&nbsp;</a></span>kParameterIsLogarithmic</h2>

  188. 

  189. <div class="memitem">

  190. <div class="memproto">

  191. <table class="mlabels">

  192.   <tr>

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

  194.       <table class="memname">

  195.         <tr>

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

  197.         </tr>

  198.       </table>

  199.   </td>

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

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

  202.   </tr>

  203. </table>

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

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

  206. 

  207. </div>

  208. </div>

  209. <a id="ga2fecc56e672626c98bdbc004c581101b"></a>

  210. <h2 class="memtitle"><span class="permalink"><a href="#ga2fecc56e672626c98bdbc004c581101b">&#9670;&nbsp;</a></span>kParameterIsOutput</h2>

  211. 

  212. <div class="memitem">

  213. <div class="memproto">

  214. <table class="mlabels">

  215.   <tr>

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

  217.       <table class="memname">

  218.         <tr>

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

  220.         </tr>

  221.       </table>

  222.   </td>

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

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

  225.   </tr>

  226. </table>

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

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

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

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

  231. One exception is when changing programs, see <a class="el" href="classPlugin.html#a44eb1bfcc3a3e5949ad053fc9ce55ce8">Plugin::loadProgram()</a>.<br  />

  232. The other exception is with parameter change requests, see <a class="el" href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">Plugin::requestParameterValueChange()</a>.<br  />

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

  234. <p>If you are targetting VST2, make sure to order your parameters so that all inputs are before any outputs. </p>

  235. 

  236. </div>

  237. </div>

  238. <a id="gaa347318fd978d909d6f247377413f871"></a>

  239. <h2 class="memtitle"><span class="permalink"><a href="#gaa347318fd978d909d6f247377413f871">&#9670;&nbsp;</a></span>kParameterIsTrigger</h2>

  240. 

  241. <div class="memitem">

  242. <div class="memproto">

  243. <table class="mlabels">

  244.   <tr>

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

  246.       <table class="memname">

  247.         <tr>

  248.           <td class="memname">constexpr const uint32_t kParameterIsTrigger = 0x20 | <a class="el" href="group__ParameterHints.html#gae7bfe085cc1ce2d56488254946846dd7">kParameterIsBoolean</a></td>

  249.         </tr>

  250.       </table>

  251.   </td>

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

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

  254.   </tr>

  255. </table>

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

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

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

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

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

  261. 

  262. </div>

  263. </div>

  264. <a id="ga8b5cde9360d1f54acfa8d7b6c2d3560d"></a>

  265. <h2 class="memtitle"><span class="permalink"><a href="#ga8b5cde9360d1f54acfa8d7b6c2d3560d">&#9670;&nbsp;</a></span>kParameterIsHidden</h2>

  266. 

  267. <div class="memitem">

  268. <div class="memproto">

  269. <table class="mlabels">

  270.   <tr>

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

  272.       <table class="memname">

  273.         <tr>

  274.           <td class="memname">constexpr const uint32_t kParameterIsHidden = 0x40</td>

  275.         </tr>

  276.       </table>

  277.   </td>

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

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

  280.   </tr>

  281. </table>

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

  283. <p><a class="el" href="structParameter.html">Parameter</a> should be hidden from the host and user-visible GUIs.<br  />

  284. It is still saved and handled as any regular parameter, just not visible to the user (for example in a host generated GUI) </p>

  285. 

  286. </div>

  287. </div>

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

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

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

  291. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  292. </small></address>

  293. </body>

  294. </html>