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

250 lines
11KB
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.8.17"/>

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

  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');

  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. 

  71. <p>Various parameter hints.  

  72. <a href="#details">More...</a></p>

  73. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  88. </table>

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

  90. <p>Various parameter hints. </p>

  91. <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="ga04161ef926442aa08ae7aa6847078ad9"></a>

  94. <h2 class="memtitle"><span class="permalink"><a href="#ga04161ef926442aa08ae7aa6847078ad9">&#9670;&nbsp;</a></span>kParameterIsAutomable</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">const uint32_t kParameterIsAutomable = 0x01</td>

  104.         </tr>

  105.       </table>

  106.   </td>

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

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

  109.   </tr>

  110. </table>

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

  112. <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#a6911a881fabb9eca9daf0eadbaad8599">Plugin::setParameterValue(uint32_t, float)</a> </dd></dl>

  113. 

  114. </div>

  115. </div>

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

  117. <h2 class="memtitle"><span class="permalink"><a href="#gaafca30df903781d2e1c2491808e17c8d">&#9670;&nbsp;</a></span>kParameterIsBoolean</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">const uint32_t kParameterIsBoolean = 0x02</td>

  127.         </tr>

  128.       </table>

  129.   </td>

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

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

  132.   </tr>

  133. </table>

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

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

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

  137. 

  138. </div>

  139. </div>

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

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

  142. 

  143. <div class="memitem">

  144. <div class="memproto">

  145. <table class="mlabels">

  146.   <tr>

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

  148.       <table class="memname">

  149.         <tr>

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

  151.         </tr>

  152.       </table>

  153.   </td>

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

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

  156.   </tr>

  157. </table>

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

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

  160. 

  161. </div>

  162. </div>

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

  164. <h2 class="memtitle"><span class="permalink"><a href="#gabc539ecbfe420246a33f93aed32b8a3b">&#9670;&nbsp;</a></span>kParameterIsLogarithmic</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">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 id="ga0a3633c93e8589f4b3e6124bb97ad8d4"></a>

  187. <h2 class="memtitle"><span class="permalink"><a href="#ga0a3633c93e8589f4b3e6124bb97ad8d4">&#9670;&nbsp;</a></span>kParameterIsOutput</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">const uint32_t kParameterIsOutput = 0x10</td>

  197.         </tr>

  198.       </table>

  199.   </td>

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

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

  202.   </tr>

  203. </table>

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

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

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

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

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

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

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

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

  212. 

  213. </div>

  214. </div>

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

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

  217. 

  218. <div class="memitem">

  219. <div class="memproto">

  220. <table class="mlabels">

  221.   <tr>

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

  223.       <table class="memname">

  224.         <tr>

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

  226.         </tr>

  227.       </table>

  228.   </td>

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

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

  231.   </tr>

  232. </table>

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

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

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

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

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

  238. 

  239. </div>

  240. </div>

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

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

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

  244. Generated on Mon Jun 14 2021 12:30:38 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  246. </a> 1.8.17

  247. </small></address>

  248. </body>

  249. </html>