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.

637 lines
35KB

  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: Plugin Macros</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. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#define-members">Macros</a> </div>
  64. <div class="headertitle">
  65. <div class="title">Plugin Macros</div> </div>
  66. </div><!--header-->
  67. <div class="contents">
  68. <table class="memberdecls">
  69. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  70. Macros</h2></td></tr>
  71. <tr class="memitem:ga888482a9f695c2ca2f433e5f3172dcc4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a>&#160;&#160;&#160;&quot;Plugin Name&quot;</td></tr>
  72. <tr class="separator:ga888482a9f695c2ca2f433e5f3172dcc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ga5f4f3d9a5dc3c23882d158e636319998"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga5f4f3d9a5dc3c23882d158e636319998">DISTRHO_PLUGIN_NUM_INPUTS</a>&#160;&#160;&#160;2</td></tr>
  74. <tr class="separator:ga5f4f3d9a5dc3c23882d158e636319998"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:ga917195804ebcb2bb48c9fad52b20b3ca"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca">DISTRHO_PLUGIN_NUM_OUTPUTS</a>&#160;&#160;&#160;2</td></tr>
  76. <tr class="separator:ga917195804ebcb2bb48c9fad52b20b3ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ga9cc186448134e6a1956474b3878c97a8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">DISTRHO_PLUGIN_URI</a>&#160;&#160;&#160;&quot;urn:distrho:name&quot;</td></tr>
  78. <tr class="separator:ga9cc186448134e6a1956474b3878c97a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:gacf8a1af679c09637ba0bdc5f4f8e37dd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gacf8a1af679c09637ba0bdc5f4f8e37dd">DISTRHO_PLUGIN_HAS_UI</a>&#160;&#160;&#160;1</td></tr>
  80. <tr class="separator:gacf8a1af679c09637ba0bdc5f4f8e37dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ga82546dd199fcea338b113f2f6da84ced"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga82546dd199fcea338b113f2f6da84ced">DISTRHO_PLUGIN_IS_RT_SAFE</a>&#160;&#160;&#160;1</td></tr>
  82. <tr class="separator:ga82546dd199fcea338b113f2f6da84ced"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ga854bde6b6fdb0d47182149dbab0fed72"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga854bde6b6fdb0d47182149dbab0fed72">DISTRHO_PLUGIN_IS_SYNTH</a>&#160;&#160;&#160;1</td></tr>
  84. <tr class="separator:ga854bde6b6fdb0d47182149dbab0fed72"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ga9e0277ebff0b0a05047439532ff216d5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga9e0277ebff0b0a05047439532ff216d5">DISTRHO_PLUGIN_MINIMUM_BUFFER_SIZE</a>&#160;&#160;&#160;2048</td></tr>
  86. <tr class="separator:ga9e0277ebff0b0a05047439532ff216d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:gaf75c327526ca8508c8968e43b6c1e49b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gaf75c327526ca8508c8968e43b6c1e49b">DISTRHO_PLUGIN_USES_MODGUI</a>&#160;&#160;&#160;0</td></tr>
  88. <tr class="separator:gaf75c327526ca8508c8968e43b6c1e49b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:gac6873a3950f52f3fde8e386af63b69a1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gac6873a3950f52f3fde8e386af63b69a1">DISTRHO_PLUGIN_WANT_DIRECT_ACCESS</a>&#160;&#160;&#160;0</td></tr>
  90. <tr class="separator:gac6873a3950f52f3fde8e386af63b69a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:gad6b0ebf10e048f4742f29735da4d4930"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gad6b0ebf10e048f4742f29735da4d4930">DISTRHO_PLUGIN_WANT_LATENCY</a>&#160;&#160;&#160;1</td></tr>
  92. <tr class="separator:gad6b0ebf10e048f4742f29735da4d4930"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:gadf2e2eb7550e4116001c816adfb04a70"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gadf2e2eb7550e4116001c816adfb04a70">DISTRHO_PLUGIN_WANT_MIDI_INPUT</a>&#160;&#160;&#160;1</td></tr>
  94. <tr class="separator:gadf2e2eb7550e4116001c816adfb04a70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ga548522eb91344a45841a5a95ff4f8073"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga548522eb91344a45841a5a95ff4f8073">DISTRHO_PLUGIN_WANT_MIDI_OUTPUT</a>&#160;&#160;&#160;1</td></tr>
  96. <tr class="separator:ga548522eb91344a45841a5a95ff4f8073"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:ga5a33bc5567795bdbbaab32313fabc652"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga5a33bc5567795bdbbaab32313fabc652">DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST</a>&#160;&#160;&#160;1</td></tr>
  98. <tr class="separator:ga5a33bc5567795bdbbaab32313fabc652"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:gad95e24b17f196260cee15255fdb5b677"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gad95e24b17f196260cee15255fdb5b677">DISTRHO_PLUGIN_WANT_PROGRAMS</a>&#160;&#160;&#160;1</td></tr>
  100. <tr class="separator:gad95e24b17f196260cee15255fdb5b677"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ga255f43cc0997af8b56abcca260c875e0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga255f43cc0997af8b56abcca260c875e0">DISTRHO_PLUGIN_WANT_STATE</a>&#160;&#160;&#160;1</td></tr>
  102. <tr class="separator:ga255f43cc0997af8b56abcca260c875e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:gac022d3d0a8782d632d7a801bc9cf721e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gac022d3d0a8782d632d7a801bc9cf721e">DISTRHO_PLUGIN_WANT_FULL_STATE</a>&#160;&#160;&#160;1</td></tr>
  104. <tr class="separator:gac022d3d0a8782d632d7a801bc9cf721e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ga496610b956d931b1940d07da48d123f2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga496610b956d931b1940d07da48d123f2">DISTRHO_PLUGIN_WANT_TIMEPOS</a>&#160;&#160;&#160;1</td></tr>
  106. <tr class="separator:ga496610b956d931b1940d07da48d123f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ga5bcd1ce31e47a617de4c32fbf85e44ca"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga5bcd1ce31e47a617de4c32fbf85e44ca">DISTRHO_UI_USE_CUSTOM</a>&#160;&#160;&#160;1</td></tr>
  108. <tr class="separator:ga5bcd1ce31e47a617de4c32fbf85e44ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:gaf978778ddb34e3663a5c0bd128067e10"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gaf978778ddb34e3663a5c0bd128067e10">DISTRHO_UI_CUSTOM_INCLUDE_PATH</a></td></tr>
  110. <tr class="separator:gaf978778ddb34e3663a5c0bd128067e10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:gaf6377f757b9796bd37f7be4e605ccd4a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gaf6377f757b9796bd37f7be4e605ccd4a">DISTRHO_UI_CUSTOM_WIDGET_TYPE</a></td></tr>
  112. <tr class="separator:gaf6377f757b9796bd37f7be4e605ccd4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:gad49e79936a2aa5afa089cbc051426ccd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gad49e79936a2aa5afa089cbc051426ccd">DISTRHO_UI_USE_NANOVG</a>&#160;&#160;&#160;1</td></tr>
  114. <tr class="separator:gad49e79936a2aa5afa089cbc051426ccd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:gabadb9d9ba7f479df39b3963ee60b7a4b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gabadb9d9ba7f479df39b3963ee60b7a4b">DISTRHO_UI_USER_RESIZABLE</a>&#160;&#160;&#160;1</td></tr>
  116. <tr class="separator:gabadb9d9ba7f479df39b3963ee60b7a4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:ga420a88022da249b9f38a6046998dbd7c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga420a88022da249b9f38a6046998dbd7c">DISTRHO_UI_URI</a>&#160;&#160;&#160;<a class="el" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">DISTRHO_PLUGIN_URI</a> &quot;#UI&quot;</td></tr>
  118. <tr class="separator:ga420a88022da249b9f38a6046998dbd7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:ga97bd6556fb9fcfc181778edb4fceeeef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga97bd6556fb9fcfc181778edb4fceeeef">DISTRHO_PLUGIN_LV2_CATEGORY</a>&#160;&#160;&#160;&quot;lv2:Plugin&quot;</td></tr>
  120. <tr class="separator:ga97bd6556fb9fcfc181778edb4fceeeef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:gab5bfd0f8045aa7eedd2ec6f5c9c2d17f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gab5bfd0f8045aa7eedd2ec6f5c9c2d17f">DISTRHO_PLUGIN_VST3_CATEGORIES</a>&#160;&#160;&#160;&quot;Fx&quot;</td></tr>
  122. <tr class="separator:gab5bfd0f8045aa7eedd2ec6f5c9c2d17f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table>
  124. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  125. <p>C Macros that describe your plugin. (defined in the "DistrhoPluginInfo.h" file)</p>
  126. <p>With these macros you can tell the host what features your plugin requires.<br />
  127. Depending on which macros you enable, new functions will be available to call and/or override.</p>
  128. <p>All values are either integer or strings.<br />
  129. For boolean-like values 1 means 'on' and 0 means 'off'.</p>
  130. <p>The values defined in this group are for documentation purposes only.<br />
  131. All macros are disabled by default.</p>
  132. <p>Only 4 macros are required, they are:</p><ul>
  133. <li><a class="el" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a></li>
  134. <li><a class="el" href="group__PluginMacros.html#ga5f4f3d9a5dc3c23882d158e636319998">DISTRHO_PLUGIN_NUM_INPUTS</a></li>
  135. <li><a class="el" href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca">DISTRHO_PLUGIN_NUM_OUTPUTS</a></li>
  136. <li><a class="el" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">DISTRHO_PLUGIN_URI</a> </li>
  137. </ul>
  138. <h2 class="groupheader">Macro Definition Documentation</h2>
  139. <a id="ga888482a9f695c2ca2f433e5f3172dcc4"></a>
  140. <h2 class="memtitle"><span class="permalink"><a href="#ga888482a9f695c2ca2f433e5f3172dcc4">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_NAME</h2>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">#define DISTRHO_PLUGIN_NAME&#160;&#160;&#160;&quot;Plugin Name&quot;</td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>The plugin name.<br />
  150. This is used to identify your plugin before a <a class="el" href="classPlugin.html">Plugin</a> instance can be created. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>
  151. </div>
  152. </div>
  153. <a id="ga5f4f3d9a5dc3c23882d158e636319998"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#ga5f4f3d9a5dc3c23882d158e636319998">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_NUM_INPUTS</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">#define DISTRHO_PLUGIN_NUM_INPUTS&#160;&#160;&#160;2</td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>Number of audio inputs the plugin has. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>
  164. </div>
  165. </div>
  166. <a id="ga917195804ebcb2bb48c9fad52b20b3ca"></a>
  167. <h2 class="memtitle"><span class="permalink"><a href="#ga917195804ebcb2bb48c9fad52b20b3ca">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_NUM_OUTPUTS</h2>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <table class="memname">
  171. <tr>
  172. <td class="memname">#define DISTRHO_PLUGIN_NUM_OUTPUTS&#160;&#160;&#160;2</td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>Number of audio outputs the plugin has. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>
  177. </div>
  178. </div>
  179. <a id="ga9cc186448134e6a1956474b3878c97a8"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#ga9cc186448134e6a1956474b3878c97a8">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_URI</h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">#define DISTRHO_PLUGIN_URI&#160;&#160;&#160;&quot;urn:distrho:name&quot;</td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>The plugin URI when exporting in LV2 format. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>
  190. </div>
  191. </div>
  192. <a id="gacf8a1af679c09637ba0bdc5f4f8e37dd"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#gacf8a1af679c09637ba0bdc5f4f8e37dd">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_HAS_UI</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">#define DISTRHO_PLUGIN_HAS_UI&#160;&#160;&#160;1</td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Whether the plugin has a custom UI. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PluginMacros.html#gad49e79936a2aa5afa089cbc051426ccd">DISTRHO_UI_USE_NANOVG</a> </dd>
  203. <dd>
  204. <a class="el" href="classUI.html">UI</a> </dd></dl>
  205. </div>
  206. </div>
  207. <a id="ga82546dd199fcea338b113f2f6da84ced"></a>
  208. <h2 class="memtitle"><span class="permalink"><a href="#ga82546dd199fcea338b113f2f6da84ced">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_IS_RT_SAFE</h2>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">#define DISTRHO_PLUGIN_IS_RT_SAFE&#160;&#160;&#160;1</td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <p>Whether the plugin processing is realtime-safe.<br />
  218. TODO - list rtsafe requirements </p>
  219. </div>
  220. </div>
  221. <a id="ga854bde6b6fdb0d47182149dbab0fed72"></a>
  222. <h2 class="memtitle"><span class="permalink"><a href="#ga854bde6b6fdb0d47182149dbab0fed72">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_IS_SYNTH</h2>
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">#define DISTRHO_PLUGIN_IS_SYNTH&#160;&#160;&#160;1</td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Whether the plugin is a synth.<br />
  232. <a class="el" href="group__PluginMacros.html#gadf2e2eb7550e4116001c816adfb04a70">DISTRHO_PLUGIN_WANT_MIDI_INPUT</a> is automatically enabled when this is too. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PluginMacros.html#gadf2e2eb7550e4116001c816adfb04a70">DISTRHO_PLUGIN_WANT_MIDI_INPUT</a> </dd></dl>
  233. </div>
  234. </div>
  235. <a id="ga9e0277ebff0b0a05047439532ff216d5"></a>
  236. <h2 class="memtitle"><span class="permalink"><a href="#ga9e0277ebff0b0a05047439532ff216d5">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_MINIMUM_BUFFER_SIZE</h2>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="memname">
  240. <tr>
  241. <td class="memname">#define DISTRHO_PLUGIN_MINIMUM_BUFFER_SIZE&#160;&#160;&#160;2048</td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <p>Request the minimum buffer size for the input and output event ports.<br />
  246. Currently only used in LV2, with a default value of 2048 if unset. </p>
  247. </div>
  248. </div>
  249. <a id="gaf75c327526ca8508c8968e43b6c1e49b"></a>
  250. <h2 class="memtitle"><span class="permalink"><a href="#gaf75c327526ca8508c8968e43b6c1e49b">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_USES_MODGUI</h2>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname">#define DISTRHO_PLUGIN_USES_MODGUI&#160;&#160;&#160;0</td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. <p>Whether the plugin has an LV2 modgui.</p>
  260. <p>This will simply add a "rdfs:seeAlso &lt;modgui.ttl&gt;" on the LV2 manifest.<br />
  261. It is up to you to create this file. </p>
  262. </div>
  263. </div>
  264. <a id="gac6873a3950f52f3fde8e386af63b69a1"></a>
  265. <h2 class="memtitle"><span class="permalink"><a href="#gac6873a3950f52f3fde8e386af63b69a1">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_DIRECT_ACCESS</h2>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">#define DISTRHO_PLUGIN_WANT_DIRECT_ACCESS&#160;&#160;&#160;0</td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>Enable direct access between the UI and plugin code. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classUI.html#a0863a8f7ca7fc7e172e703c58518329f">UI::getPluginInstancePointer()</a> </dd></dl>
  275. <dl class="section note"><dt>Note</dt><dd>DO NOT USE THIS UNLESS STRICTLY NECESSARY!! Try to avoid it at all costs! </dd></dl>
  276. </div>
  277. </div>
  278. <a id="gad6b0ebf10e048f4742f29735da4d4930"></a>
  279. <h2 class="memtitle"><span class="permalink"><a href="#gad6b0ebf10e048f4742f29735da4d4930">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_LATENCY</h2>
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname">#define DISTRHO_PLUGIN_WANT_LATENCY&#160;&#160;&#160;1</td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>Whether the plugin introduces latency during audio or midi processing. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">Plugin::setLatency(uint32_t)</a> </dd></dl>
  289. </div>
  290. </div>
  291. <a id="gadf2e2eb7550e4116001c816adfb04a70"></a>
  292. <h2 class="memtitle"><span class="permalink"><a href="#gadf2e2eb7550e4116001c816adfb04a70">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_MIDI_INPUT</h2>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">#define DISTRHO_PLUGIN_WANT_MIDI_INPUT&#160;&#160;&#160;1</td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. <p>Whether the plugin wants MIDI input.<br />
  302. This is automatically enabled if <a class="el" href="group__PluginMacros.html#ga854bde6b6fdb0d47182149dbab0fed72">DISTRHO_PLUGIN_IS_SYNTH</a> is true. </p>
  303. </div>
  304. </div>
  305. <a id="ga548522eb91344a45841a5a95ff4f8073"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#ga548522eb91344a45841a5a95ff4f8073">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_MIDI_OUTPUT</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">#define DISTRHO_PLUGIN_WANT_MIDI_OUTPUT&#160;&#160;&#160;1</td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <p>Whether the plugin wants MIDI output. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">Plugin::writeMidiEvent(const MidiEvent&amp;)</a> </dd></dl>
  316. </div>
  317. </div>
  318. <a id="ga5a33bc5567795bdbbaab32313fabc652"></a>
  319. <h2 class="memtitle"><span class="permalink"><a href="#ga5a33bc5567795bdbbaab32313fabc652">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST</h2>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">#define DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST&#160;&#160;&#160;1</td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. <p>Whether the plugin wants to change its own parameter inputs.<br />
  329. Not all hosts or plugin formats support this, so <a class="el" href="classPlugin.html#a581614e1d301ee613a988855c61b2517">Plugin::canRequestParameterValueChanges()</a> can be used to query support at runtime. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">Plugin::requestParameterValueChange(uint32_t, float)</a> </dd></dl>
  330. </div>
  331. </div>
  332. <a id="gad95e24b17f196260cee15255fdb5b677"></a>
  333. <h2 class="memtitle"><span class="permalink"><a href="#gad95e24b17f196260cee15255fdb5b677">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_PROGRAMS</h2>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">#define DISTRHO_PLUGIN_WANT_PROGRAMS&#160;&#160;&#160;1</td>
  339. </tr>
  340. </table>
  341. </div><div class="memdoc">
  342. <p>Whether the plugin provides its own internal programs. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b">Plugin::initProgramName(uint32_t, String&amp;)</a> </dd>
  343. <dd>
  344. <a class="el" href="classPlugin.html#a44eb1bfcc3a3e5949ad053fc9ce55ce8">Plugin::loadProgram(uint32_t)</a> </dd></dl>
  345. </div>
  346. </div>
  347. <a id="ga255f43cc0997af8b56abcca260c875e0"></a>
  348. <h2 class="memtitle"><span class="permalink"><a href="#ga255f43cc0997af8b56abcca260c875e0">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_STATE</h2>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">#define DISTRHO_PLUGIN_WANT_STATE&#160;&#160;&#160;1</td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <p>Whether the plugin uses internal non-parameter data. </p><dl class="section see"><dt>See also</dt><dd>Plugin::initState(uint32_t, String&amp;, String&amp;) </dd>
  358. <dd>
  359. <a class="el" href="classPlugin.html#afcbb504b824bacea622de9bac09b2331">Plugin::setState(const char*, const char*)</a> </dd></dl>
  360. </div>
  361. </div>
  362. <a id="gac022d3d0a8782d632d7a801bc9cf721e"></a>
  363. <h2 class="memtitle"><span class="permalink"><a href="#gac022d3d0a8782d632d7a801bc9cf721e">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_FULL_STATE</h2>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <table class="memname">
  367. <tr>
  368. <td class="memname">#define DISTRHO_PLUGIN_WANT_FULL_STATE&#160;&#160;&#160;1</td>
  369. </tr>
  370. </table>
  371. </div><div class="memdoc">
  372. <p>Whether the plugin implements the full state API. When this macro is enabled, the plugin must implement a new getState(const char* key) function, which the host calls when saving its session/project. This is useful for plugins that have custom internal values not exposed to the host as key-value state pairs or parameters. Most simple effects and synths will not need this. </p><dl class="section note"><dt>Note</dt><dd>this macro is automatically enabled if a plugin has programs and state, as the key-value state pairs need to be updated when the current program changes. </dd></dl>
  373. <dl class="section see"><dt>See also</dt><dd>Plugin::getState(const char*) </dd></dl>
  374. </div>
  375. </div>
  376. <a id="ga496610b956d931b1940d07da48d123f2"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#ga496610b956d931b1940d07da48d123f2">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_TIMEPOS</h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">#define DISTRHO_PLUGIN_WANT_TIMEPOS&#160;&#160;&#160;1</td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. <p>Whether the plugin wants time position information from the host. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">Plugin::getTimePosition()</a> </dd></dl>
  387. </div>
  388. </div>
  389. <a id="ga5bcd1ce31e47a617de4c32fbf85e44ca"></a>
  390. <h2 class="memtitle"><span class="permalink"><a href="#ga5bcd1ce31e47a617de4c32fbf85e44ca">&#9670;&nbsp;</a></span>DISTRHO_UI_USE_CUSTOM</h2>
  391. <div class="memitem">
  392. <div class="memproto">
  393. <table class="memname">
  394. <tr>
  395. <td class="memname">#define DISTRHO_UI_USE_CUSTOM&#160;&#160;&#160;1</td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Whether the UI uses a custom toolkit implementation based on OpenGL.<br />
  400. When enabled, the macros <a class="el" href="group__PluginMacros.html#gaf978778ddb34e3663a5c0bd128067e10">DISTRHO_UI_CUSTOM_INCLUDE_PATH</a> and <a class="el" href="group__PluginMacros.html#gaf6377f757b9796bd37f7be4e605ccd4a">DISTRHO_UI_CUSTOM_WIDGET_TYPE</a> are required. </p>
  401. </div>
  402. </div>
  403. <a id="gaf978778ddb34e3663a5c0bd128067e10"></a>
  404. <h2 class="memtitle"><span class="permalink"><a href="#gaf978778ddb34e3663a5c0bd128067e10">&#9670;&nbsp;</a></span>DISTRHO_UI_CUSTOM_INCLUDE_PATH</h2>
  405. <div class="memitem">
  406. <div class="memproto">
  407. <table class="memname">
  408. <tr>
  409. <td class="memname">#define DISTRHO_UI_CUSTOM_INCLUDE_PATH</td>
  410. </tr>
  411. </table>
  412. </div><div class="memdoc">
  413. <p>The include path to the header file used by the custom toolkit implementation. This path must be relative to dpf/distrho/DistrhoUI.hpp </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PluginMacros.html#ga5bcd1ce31e47a617de4c32fbf85e44ca">DISTRHO_UI_USE_CUSTOM</a> </dd></dl>
  414. </div>
  415. </div>
  416. <a id="gaf6377f757b9796bd37f7be4e605ccd4a"></a>
  417. <h2 class="memtitle"><span class="permalink"><a href="#gaf6377f757b9796bd37f7be4e605ccd4a">&#9670;&nbsp;</a></span>DISTRHO_UI_CUSTOM_WIDGET_TYPE</h2>
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname">#define DISTRHO_UI_CUSTOM_WIDGET_TYPE</td>
  423. </tr>
  424. </table>
  425. </div><div class="memdoc">
  426. <p>The top-level-widget typedef to use for the custom toolkit. This widget class MUST be a subclass of DGL TopLevelWindow class. It is recommended that you keep this widget class inside the DGL namespace, and define widget type as e.g. DGL_NAMESPACE::MyCustomTopLevelWidget. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PluginMacros.html#ga5bcd1ce31e47a617de4c32fbf85e44ca">DISTRHO_UI_USE_CUSTOM</a> </dd></dl>
  427. </div>
  428. </div>
  429. <a id="gad49e79936a2aa5afa089cbc051426ccd"></a>
  430. <h2 class="memtitle"><span class="permalink"><a href="#gad49e79936a2aa5afa089cbc051426ccd">&#9670;&nbsp;</a></span>DISTRHO_UI_USE_NANOVG</h2>
  431. <div class="memitem">
  432. <div class="memproto">
  433. <table class="memname">
  434. <tr>
  435. <td class="memname">#define DISTRHO_UI_USE_NANOVG&#160;&#160;&#160;1</td>
  436. </tr>
  437. </table>
  438. </div><div class="memdoc">
  439. <p>Whether the UI uses <a class="el" href="classNanoVG.html">NanoVG</a> for drawing instead of the default raw OpenGL calls.<br />
  440. When enabled your UI instance will subclass NanoWidget instead of <a class="el" href="classWidget.html">Widget</a>. </p>
  441. </div>
  442. </div>
  443. <a id="gabadb9d9ba7f479df39b3963ee60b7a4b"></a>
  444. <h2 class="memtitle"><span class="permalink"><a href="#gabadb9d9ba7f479df39b3963ee60b7a4b">&#9670;&nbsp;</a></span>DISTRHO_UI_USER_RESIZABLE</h2>
  445. <div class="memitem">
  446. <div class="memproto">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname">#define DISTRHO_UI_USER_RESIZABLE&#160;&#160;&#160;1</td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Whether the UI is resizable to any size by the user.<br />
  454. By default this is false, and resizing is only allowed under the plugin <a class="el" href="classUI.html">UI</a> control,<br />
  455. Enabling this options makes it possible for the user to resize the plugin <a class="el" href="classUI.html">UI</a> at anytime. </p><dl class="section see"><dt>See also</dt><dd>UI::setGeometryConstraints(uint, uint, bool, bool) </dd></dl>
  456. </div>
  457. </div>
  458. <a id="ga420a88022da249b9f38a6046998dbd7c"></a>
  459. <h2 class="memtitle"><span class="permalink"><a href="#ga420a88022da249b9f38a6046998dbd7c">&#9670;&nbsp;</a></span>DISTRHO_UI_URI</h2>
  460. <div class="memitem">
  461. <div class="memproto">
  462. <table class="memname">
  463. <tr>
  464. <td class="memname">#define DISTRHO_UI_URI&#160;&#160;&#160;<a class="el" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">DISTRHO_PLUGIN_URI</a> &quot;#UI&quot;</td>
  465. </tr>
  466. </table>
  467. </div><div class="memdoc">
  468. <p>The UI URI when exporting in LV2 format.<br />
  469. By default this is set to <a class="el" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">DISTRHO_PLUGIN_URI</a> with "#UI" as suffix. </p>
  470. </div>
  471. </div>
  472. <a id="ga97bd6556fb9fcfc181778edb4fceeeef"></a>
  473. <h2 class="memtitle"><span class="permalink"><a href="#ga97bd6556fb9fcfc181778edb4fceeeef">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_LV2_CATEGORY</h2>
  474. <div class="memitem">
  475. <div class="memproto">
  476. <table class="memname">
  477. <tr>
  478. <td class="memname">#define DISTRHO_PLUGIN_LV2_CATEGORY&#160;&#160;&#160;&quot;lv2:Plugin&quot;</td>
  479. </tr>
  480. </table>
  481. </div><div class="memdoc">
  482. <p>Custom LV2 category for the plugin.<br />
  483. This can be one of the following values:</p>
  484. <ul>
  485. <li>lv2:<a class="el" href="classPlugin.html">Plugin</a></li>
  486. <li>lv2:AllpassPlugin</li>
  487. <li>lv2:AmplifierPlugin</li>
  488. <li>lv2:AnalyserPlugin</li>
  489. <li>lv2:BandpassPlugin</li>
  490. <li>lv2:ChorusPlugin</li>
  491. <li>lv2:CombPlugin</li>
  492. <li>lv2:CompressorPlugin</li>
  493. <li>lv2:ConstantPlugin</li>
  494. <li>lv2:ConverterPlugin</li>
  495. <li>lv2:DelayPlugin</li>
  496. <li>lv2:DistortionPlugin</li>
  497. <li>lv2:DynamicsPlugin</li>
  498. <li>lv2:EQPlugin</li>
  499. <li>lv2:EnvelopePlugin</li>
  500. <li>lv2:ExpanderPlugin</li>
  501. <li>lv2:FilterPlugin</li>
  502. <li>lv2:FlangerPlugin</li>
  503. <li>lv2:FunctionPlugin</li>
  504. <li>lv2:GatePlugin</li>
  505. <li>lv2:GeneratorPlugin</li>
  506. <li>lv2:HighpassPlugin</li>
  507. <li>lv2:InstrumentPlugin</li>
  508. <li>lv2:LimiterPlugin</li>
  509. <li>lv2:LowpassPlugin</li>
  510. <li>lv2:MIDIPlugin</li>
  511. <li>lv2:MixerPlugin</li>
  512. <li>lv2:ModulatorPlugin</li>
  513. <li>lv2:MultiEQPlugin</li>
  514. <li>lv2:OscillatorPlugin</li>
  515. <li>lv2:ParaEQPlugin</li>
  516. <li>lv2:PhaserPlugin</li>
  517. <li>lv2:PitchPlugin</li>
  518. <li>lv2:ReverbPlugin</li>
  519. <li>lv2:SimulatorPlugin</li>
  520. <li>lv2:SpatialPlugin</li>
  521. <li>lv2:SpectralPlugin</li>
  522. <li>lv2:UtilityPlugin</li>
  523. <li>lv2:WaveshaperPlugin</li>
  524. </ul>
  525. <p>See <a href="http://lv2plug.in/ns/lv2core">http://lv2plug.in/ns/lv2core</a> for more information. </p>
  526. </div>
  527. </div>
  528. <a id="gab5bfd0f8045aa7eedd2ec6f5c9c2d17f"></a>
  529. <h2 class="memtitle"><span class="permalink"><a href="#gab5bfd0f8045aa7eedd2ec6f5c9c2d17f">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_VST3_CATEGORIES</h2>
  530. <div class="memitem">
  531. <div class="memproto">
  532. <table class="memname">
  533. <tr>
  534. <td class="memname">#define DISTRHO_PLUGIN_VST3_CATEGORIES&#160;&#160;&#160;&quot;Fx&quot;</td>
  535. </tr>
  536. </table>
  537. </div><div class="memdoc">
  538. <p>Custom VST3 categories for the plugin.<br />
  539. This is a list of categories, separated by a <code></code>|.</p>
  540. <p>Each effect category can be one of the following values:</p>
  541. <ul>
  542. <li>Fx</li>
  543. <li>Fx|Ambisonics</li>
  544. <li>Fx|Analyzer</li>
  545. <li>Fx|Delay</li>
  546. <li>Fx|Distortion</li>
  547. <li>Fx|Dynamics</li>
  548. <li>Fx|EQ</li>
  549. <li>Fx|Filter</li>
  550. <li>Fx|Instrument</li>
  551. <li>Fx|Instrument|External</li>
  552. <li>Fx|Spatial</li>
  553. <li>Fx|Generator</li>
  554. <li>Fx|Mastering</li>
  555. <li>Fx|Modulation</li>
  556. <li>Fx|Network</li>
  557. <li>Fx|Pitch Shift</li>
  558. <li>Fx|Restoration</li>
  559. <li>Fx|Reverb</li>
  560. <li>Fx|Surround</li>
  561. <li>Fx|Tools</li>
  562. </ul>
  563. <p>Each instrument category can be one of the following values:</p>
  564. <ul>
  565. <li>Instrument</li>
  566. <li>Instrument|Drum</li>
  567. <li>Instrument|External</li>
  568. <li>Instrument|Piano</li>
  569. <li>Instrument|Sampler</li>
  570. <li>Instrument|Synth</li>
  571. <li>Instrument|Synth|Sampler</li>
  572. </ul>
  573. <dl class="section note"><dt>Note</dt><dd>DPF will automatically set Mono and Stereo categories when appropriate. </dd></dl>
  574. </div>
  575. </div>
  576. </div><!-- contents -->
  577. <!-- start footer part -->
  578. <hr class="footer"/><address class="footer"><small>
  579. 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
  580. </small></address>
  581. </body>
  582. </html>