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

269 lines
13KB
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:ga6d39267b105c2d8dfc82a810c5e8a061"><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#ga6d39267b105c2d8dfc82a810c5e8a061">kParameterIsAutomatable</a> = 0x01</td></tr>

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

  75. <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> = <a class="el" href="group__ParameterHints.html#ga6d39267b105c2d8dfc82a810c5e8a061">kParameterIsAutomatable</a></td></tr>

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

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

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

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

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

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

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

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

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

  85. <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 | <a class="el" href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">kParameterIsBoolean</a></td></tr>

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

  87. </table>

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

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

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

  91. <a id="ga6d39267b105c2d8dfc82a810c5e8a061"></a>

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

  93. 

  94. <div class="memitem">

  95. <div class="memproto">

  96. <table class="mlabels">

  97.   <tr>

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

  99.       <table class="memname">

  100.         <tr>

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

  102.         </tr>

  103.       </table>

  104.   </td>

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

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

  107.   </tr>

  108. </table>

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

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

  111. 

  112. </div>

  113. </div>

  114. <a id="ga04161ef926442aa08ae7aa6847078ad9"></a>

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

  116. 

  117. <div class="memitem">

  118. <div class="memproto">

  119. <table class="mlabels">

  120.   <tr>

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

  122.       <table class="memname">

  123.         <tr>

  124.           <td class="memname">const uint32_t kParameterIsAutomable = <a class="el" href="group__ParameterHints.html#ga6d39267b105c2d8dfc82a810c5e8a061">kParameterIsAutomatable</a></td>

  125.         </tr>

  126.       </table>

  127.   </td>

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

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

  130.   </tr>

  131. </table>

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

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

  134. 

  135. </div>

  136. </div>

  137. <a id="gaafca30df903781d2e1c2491808e17c8d"></a>

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

  139. 

  140. <div class="memitem">

  141. <div class="memproto">

  142. <table class="mlabels">

  143.   <tr>

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

  145.       <table class="memname">

  146.         <tr>

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

  148.         </tr>

  149.       </table>

  150.   </td>

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

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

  153.   </tr>

  154. </table>

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

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

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

  158. 

  159. </div>

  160. </div>

  161. <a id="ga76a82c93efe6ad728c9f0cb4ef33a2b9"></a>

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

  163. 

  164. <div class="memitem">

  165. <div class="memproto">

  166. <table class="mlabels">

  167.   <tr>

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

  169.       <table class="memname">

  170.         <tr>

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

  172.         </tr>

  173.       </table>

  174.   </td>

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

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

  177.   </tr>

  178. </table>

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

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

  181. 

  182. </div>

  183. </div>

  184. <a id="gabc539ecbfe420246a33f93aed32b8a3b"></a>

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

  186. 

  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 kParameterIsLogarithmic = 0x08</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> value is logarithmic. </p>

  204. 

  205. </div>

  206. </div>

  207. <a id="ga0a3633c93e8589f4b3e6124bb97ad8d4"></a>

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

  209. 

  210. <div class="memitem">

  211. <div class="memproto">

  212. <table class="mlabels">

  213.   <tr>

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

  215.       <table class="memname">

  216.         <tr>

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

  218.         </tr>

  219.       </table>

  220.   </td>

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

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

  223.   </tr>

  224. </table>

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

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

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

  228. <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  />

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

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

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

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

  233. 

  234. </div>

  235. </div>

  236. <a id="ga068de47c587411c9e91ef09f7d800884"></a>

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

  238. 

  239. <div class="memitem">

  240. <div class="memproto">

  241. <table class="mlabels">

  242.   <tr>

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

  244.       <table class="memname">

  245.         <tr>

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

  247.         </tr>

  248.       </table>

  249.   </td>

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

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

  252.   </tr>

  253. </table>

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

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

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

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

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

  259. 

  260. </div>

  261. </div>

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

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

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

  265. Generated on Wed Jul 27 2022 00:46:18 for DISTRHO Plugin Framework 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

  266. </small></address>

  267. </body>

  268. </html>