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.
409 Commits
7 Branches
53MB
Tree: 71bbf0a202
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '71bbf0a202'
${ noResults }
DPF/group__PluginMacros.html

642 lines
35KB
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: 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.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="#define-members">Macros</a>  </div>

  66.   <div class="headertitle">

  67. <div class="title">Plugin Macros</div>  </div>

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

  69. <div class="contents">

  70. 

  71. <p>C Macros that describe your plugin. (defined in the "DistrhoPluginInfo.h" file)  

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

  73. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  128. </table>

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

  130. <p>C Macros that describe your plugin. (defined in the "DistrhoPluginInfo.h" file) </p>

  131. <p>With these macros you can tell the host what features your plugin requires.<br  />

  132. Depending on which macros you enable, new functions will be available to call and/or override.</p>

  133. <p>All values are either integer or strings.<br  />

  134. For boolean-like values 1 means 'on' and 0 means 'off'.</p>

  135. <p>The values defined in this group are for documentation purposes only.<br  />

  136. All macros are disabled by default.</p>

  137. <p>Only 4 macros are required, they are:</p><ul>

  138. <li><a class="el" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a></li>

  139. <li><a class="el" href="group__PluginMacros.html#ga5f4f3d9a5dc3c23882d158e636319998">DISTRHO_PLUGIN_NUM_INPUTS</a></li>

  140. <li><a class="el" href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca">DISTRHO_PLUGIN_NUM_OUTPUTS</a></li>

  141. <li><a class="el" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">DISTRHO_PLUGIN_URI</a> </li>

  142. </ul>

  143. <h2 class="groupheader">Macro Definition Documentation</h2>

  144. <a id="ga888482a9f695c2ca2f433e5f3172dcc4"></a>

  145. <h2 class="memtitle"><span class="permalink"><a href="#ga888482a9f695c2ca2f433e5f3172dcc4">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_NAME</h2>

  146. 

  147. <div class="memitem">

  148. <div class="memproto">

  149.       <table class="memname">

  150.         <tr>

  151.           <td class="memname">#define DISTRHO_PLUGIN_NAME&#160;&#160;&#160;&quot;Plugin Name&quot;</td>

  152.         </tr>

  153.       </table>

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

  155. <p>The plugin name.<br  />

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

  157. 

  158. </div>

  159. </div>

  160. <a id="ga5f4f3d9a5dc3c23882d158e636319998"></a>

  161. <h2 class="memtitle"><span class="permalink"><a href="#ga5f4f3d9a5dc3c23882d158e636319998">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_NUM_INPUTS</h2>

  162. 

  163. <div class="memitem">

  164. <div class="memproto">

  165.       <table class="memname">

  166.         <tr>

  167.           <td class="memname">#define DISTRHO_PLUGIN_NUM_INPUTS&#160;&#160;&#160;2</td>

  168.         </tr>

  169.       </table>

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

  171. <p>Number of audio inputs the plugin has. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>

  172. 

  173. </div>

  174. </div>

  175. <a id="ga917195804ebcb2bb48c9fad52b20b3ca"></a>

  176. <h2 class="memtitle"><span class="permalink"><a href="#ga917195804ebcb2bb48c9fad52b20b3ca">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_NUM_OUTPUTS</h2>

  177. 

  178. <div class="memitem">

  179. <div class="memproto">

  180.       <table class="memname">

  181.         <tr>

  182.           <td class="memname">#define DISTRHO_PLUGIN_NUM_OUTPUTS&#160;&#160;&#160;2</td>

  183.         </tr>

  184.       </table>

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

  186. <p>Number of audio outputs the plugin has. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>

  187. 

  188. </div>

  189. </div>

  190. <a id="ga9cc186448134e6a1956474b3878c97a8"></a>

  191. <h2 class="memtitle"><span class="permalink"><a href="#ga9cc186448134e6a1956474b3878c97a8">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_URI</h2>

  192. 

  193. <div class="memitem">

  194. <div class="memproto">

  195.       <table class="memname">

  196.         <tr>

  197.           <td class="memname">#define DISTRHO_PLUGIN_URI&#160;&#160;&#160;&quot;urn:distrho:name&quot;</td>

  198.         </tr>

  199.       </table>

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

  201. <p>The plugin URI when exporting in LV2 format. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>

  202. 

  203. </div>

  204. </div>

  205. <a id="gacf8a1af679c09637ba0bdc5f4f8e37dd"></a>

  206. <h2 class="memtitle"><span class="permalink"><a href="#gacf8a1af679c09637ba0bdc5f4f8e37dd">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_HAS_UI</h2>

  207. 

  208. <div class="memitem">

  209. <div class="memproto">

  210.       <table class="memname">

  211.         <tr>

  212.           <td class="memname">#define DISTRHO_PLUGIN_HAS_UI&#160;&#160;&#160;1</td>

  213.         </tr>

  214.       </table>

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

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

  217. <dd>

  218. <a class="el" href="classUI.html">UI</a> </dd></dl>

  219. 

  220. </div>

  221. </div>

  222. <a id="ga82546dd199fcea338b113f2f6da84ced"></a>

  223. <h2 class="memtitle"><span class="permalink"><a href="#ga82546dd199fcea338b113f2f6da84ced">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_IS_RT_SAFE</h2>

  224. 

  225. <div class="memitem">

  226. <div class="memproto">

  227.       <table class="memname">

  228.         <tr>

  229.           <td class="memname">#define DISTRHO_PLUGIN_IS_RT_SAFE&#160;&#160;&#160;1</td>

  230.         </tr>

  231.       </table>

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

  233. <p>Whether the plugin processing is realtime-safe.<br  />

  234. TODO - list rtsafe requirements </p>

  235. 

  236. </div>

  237. </div>

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

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

  240. 

  241. <div class="memitem">

  242. <div class="memproto">

  243.       <table class="memname">

  244.         <tr>

  245.           <td class="memname">#define DISTRHO_PLUGIN_IS_SYNTH&#160;&#160;&#160;1</td>

  246.         </tr>

  247.       </table>

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

  249. <p>Whether the plugin is a synth.<br  />

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

  251. 

  252. </div>

  253. </div>

  254. <a id="ga9e0277ebff0b0a05047439532ff216d5"></a>

  255. <h2 class="memtitle"><span class="permalink"><a href="#ga9e0277ebff0b0a05047439532ff216d5">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_MINIMUM_BUFFER_SIZE</h2>

  256. 

  257. <div class="memitem">

  258. <div class="memproto">

  259.       <table class="memname">

  260.         <tr>

  261.           <td class="memname">#define DISTRHO_PLUGIN_MINIMUM_BUFFER_SIZE&#160;&#160;&#160;2048</td>

  262.         </tr>

  263.       </table>

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

  265. <p>Request the minimum buffer size for the input and output event ports.<br  />

  266. Currently only used in LV2, with a default value of 2048 if unset. </p>

  267. 

  268. </div>

  269. </div>

  270. <a id="gaf75c327526ca8508c8968e43b6c1e49b"></a>

  271. <h2 class="memtitle"><span class="permalink"><a href="#gaf75c327526ca8508c8968e43b6c1e49b">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_USES_MODGUI</h2>

  272. 

  273. <div class="memitem">

  274. <div class="memproto">

  275.       <table class="memname">

  276.         <tr>

  277.           <td class="memname">#define DISTRHO_PLUGIN_USES_MODGUI&#160;&#160;&#160;0</td>

  278.         </tr>

  279.       </table>

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

  281. <p>Whether the plugin has an LV2 modgui.</p>

  282. <p>This will simply add a "rdfs:seeAlso &lt;modgui.ttl&gt;" on the LV2 manifest.<br  />

  283. It is up to you to create this file. </p>

  284. 

  285. </div>

  286. </div>

  287. <a id="gac6873a3950f52f3fde8e386af63b69a1"></a>

  288. <h2 class="memtitle"><span class="permalink"><a href="#gac6873a3950f52f3fde8e386af63b69a1">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_DIRECT_ACCESS</h2>

  289. 

  290. <div class="memitem">

  291. <div class="memproto">

  292.       <table class="memname">

  293.         <tr>

  294.           <td class="memname">#define DISTRHO_PLUGIN_WANT_DIRECT_ACCESS&#160;&#160;&#160;0</td>

  295.         </tr>

  296.       </table>

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

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

  299. <dl class="section note"><dt>Note</dt><dd>DO NOT USE THIS UNLESS STRICTLY NECESSARY!! Try to avoid it at all costs! </dd></dl>

  300. 

  301. </div>

  302. </div>

  303. <a id="gad6b0ebf10e048f4742f29735da4d4930"></a>

  304. <h2 class="memtitle"><span class="permalink"><a href="#gad6b0ebf10e048f4742f29735da4d4930">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_LATENCY</h2>

  305. 

  306. <div class="memitem">

  307. <div class="memproto">

  308.       <table class="memname">

  309.         <tr>

  310.           <td class="memname">#define DISTRHO_PLUGIN_WANT_LATENCY&#160;&#160;&#160;1</td>

  311.         </tr>

  312.       </table>

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

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

  315. 

  316. </div>

  317. </div>

  318. <a id="gadf2e2eb7550e4116001c816adfb04a70"></a>

  319. <h2 class="memtitle"><span class="permalink"><a href="#gadf2e2eb7550e4116001c816adfb04a70">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_MIDI_INPUT</h2>

  320. 

  321. <div class="memitem">

  322. <div class="memproto">

  323.       <table class="memname">

  324.         <tr>

  325.           <td class="memname">#define DISTRHO_PLUGIN_WANT_MIDI_INPUT&#160;&#160;&#160;1</td>

  326.         </tr>

  327.       </table>

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

  329. <p>Whether the plugin wants MIDI input.<br  />

  330. This is automatically enabled if <a class="el" href="group__PluginMacros.html#ga854bde6b6fdb0d47182149dbab0fed72">DISTRHO_PLUGIN_IS_SYNTH</a> is true. </p>

  331. 

  332. </div>

  333. </div>

  334. <a id="ga548522eb91344a45841a5a95ff4f8073"></a>

  335. <h2 class="memtitle"><span class="permalink"><a href="#ga548522eb91344a45841a5a95ff4f8073">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_MIDI_OUTPUT</h2>

  336. 

  337. <div class="memitem">

  338. <div class="memproto">

  339.       <table class="memname">

  340.         <tr>

  341.           <td class="memname">#define DISTRHO_PLUGIN_WANT_MIDI_OUTPUT&#160;&#160;&#160;1</td>

  342.         </tr>

  343.       </table>

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

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

  346. 

  347. </div>

  348. </div>

  349. <a id="ga5a33bc5567795bdbbaab32313fabc652"></a>

  350. <h2 class="memtitle"><span class="permalink"><a href="#ga5a33bc5567795bdbbaab32313fabc652">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST</h2>

  351. 

  352. <div class="memitem">

  353. <div class="memproto">

  354.       <table class="memname">

  355.         <tr>

  356.           <td class="memname">#define DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST&#160;&#160;&#160;1</td>

  357.         </tr>

  358.       </table>

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

  360. <p>Whether the plugin wants to change its own parameter inputs.<br  />

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

  362. 

  363. </div>

  364. </div>

  365. <a id="gad95e24b17f196260cee15255fdb5b677"></a>

  366. <h2 class="memtitle"><span class="permalink"><a href="#gad95e24b17f196260cee15255fdb5b677">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_PROGRAMS</h2>

  367. 

  368. <div class="memitem">

  369. <div class="memproto">

  370.       <table class="memname">

  371.         <tr>

  372.           <td class="memname">#define DISTRHO_PLUGIN_WANT_PROGRAMS&#160;&#160;&#160;1</td>

  373.         </tr>

  374.       </table>

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

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

  377. <dd>

  378. <a class="el" href="classPlugin.html#a44eb1bfcc3a3e5949ad053fc9ce55ce8">Plugin::loadProgram(uint32_t)</a> </dd></dl>

  379. 

  380. </div>

  381. </div>

  382. <a id="ga255f43cc0997af8b56abcca260c875e0"></a>

  383. <h2 class="memtitle"><span class="permalink"><a href="#ga255f43cc0997af8b56abcca260c875e0">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_STATE</h2>

  384. 

  385. <div class="memitem">

  386. <div class="memproto">

  387.       <table class="memname">

  388.         <tr>

  389.           <td class="memname">#define DISTRHO_PLUGIN_WANT_STATE&#160;&#160;&#160;1</td>

  390.         </tr>

  391.       </table>

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

  393. <p>Whether the plugin uses internal non-parameter data. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a807b306c5ecb644c70421ae395421d84">Plugin::initState(uint32_t, String&amp;, String&amp;)</a> </dd>

  394. <dd>

  395. <a class="el" href="classPlugin.html#afcbb504b824bacea622de9bac09b2331">Plugin::setState(const char*, const char*)</a> </dd></dl>

  396. 

  397. </div>

  398. </div>

  399. <a id="gac022d3d0a8782d632d7a801bc9cf721e"></a>

  400. <h2 class="memtitle"><span class="permalink"><a href="#gac022d3d0a8782d632d7a801bc9cf721e">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_FULL_STATE</h2>

  401. 

  402. <div class="memitem">

  403. <div class="memproto">

  404.       <table class="memname">

  405.         <tr>

  406.           <td class="memname">#define DISTRHO_PLUGIN_WANT_FULL_STATE&#160;&#160;&#160;1</td>

  407.         </tr>

  408.       </table>

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

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

  411. <dl class="section see"><dt>See also</dt><dd>Plugin::getState(const char*) </dd></dl>

  412. 

  413. </div>

  414. </div>

  415. <a id="ga496610b956d931b1940d07da48d123f2"></a>

  416. <h2 class="memtitle"><span class="permalink"><a href="#ga496610b956d931b1940d07da48d123f2">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_TIMEPOS</h2>

  417. 

  418. <div class="memitem">

  419. <div class="memproto">

  420.       <table class="memname">

  421.         <tr>

  422.           <td class="memname">#define DISTRHO_PLUGIN_WANT_TIMEPOS&#160;&#160;&#160;1</td>

  423.         </tr>

  424.       </table>

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

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

  427. 

  428. </div>

  429. </div>

  430. <a id="ga5bcd1ce31e47a617de4c32fbf85e44ca"></a>

  431. <h2 class="memtitle"><span class="permalink"><a href="#ga5bcd1ce31e47a617de4c32fbf85e44ca">&#9670;&nbsp;</a></span>DISTRHO_UI_USE_CUSTOM</h2>

  432. 

  433. <div class="memitem">

  434. <div class="memproto">

  435.       <table class="memname">

  436.         <tr>

  437.           <td class="memname">#define DISTRHO_UI_USE_CUSTOM&#160;&#160;&#160;1</td>

  438.         </tr>

  439.       </table>

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

  441. <p>Whether the UI uses a custom toolkit implementation based on OpenGL.<br  />

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

  443. 

  444. </div>

  445. </div>

  446. <a id="gaf978778ddb34e3663a5c0bd128067e10"></a>

  447. <h2 class="memtitle"><span class="permalink"><a href="#gaf978778ddb34e3663a5c0bd128067e10">&#9670;&nbsp;</a></span>DISTRHO_UI_CUSTOM_INCLUDE_PATH</h2>

  448. 

  449. <div class="memitem">

  450. <div class="memproto">

  451.       <table class="memname">

  452.         <tr>

  453.           <td class="memname">#define DISTRHO_UI_CUSTOM_INCLUDE_PATH</td>

  454.         </tr>

  455.       </table>

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

  457. <p>The include path to the header file used by the custom toolkit implementation. This path must be relative to <a class="el" href="DistrhoUI_8hpp_source.html">dpf/distrho/DistrhoUI.hpp</a> </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>

  458. 

  459. </div>

  460. </div>

  461. <a id="gaf6377f757b9796bd37f7be4e605ccd4a"></a>

  462. <h2 class="memtitle"><span class="permalink"><a href="#gaf6377f757b9796bd37f7be4e605ccd4a">&#9670;&nbsp;</a></span>DISTRHO_UI_CUSTOM_WIDGET_TYPE</h2>

  463. 

  464. <div class="memitem">

  465. <div class="memproto">

  466.       <table class="memname">

  467.         <tr>

  468.           <td class="memname">#define DISTRHO_UI_CUSTOM_WIDGET_TYPE</td>

  469.         </tr>

  470.       </table>

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

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

  473. 

  474. </div>

  475. </div>

  476. <a id="gad49e79936a2aa5afa089cbc051426ccd"></a>

  477. <h2 class="memtitle"><span class="permalink"><a href="#gad49e79936a2aa5afa089cbc051426ccd">&#9670;&nbsp;</a></span>DISTRHO_UI_USE_NANOVG</h2>

  478. 

  479. <div class="memitem">

  480. <div class="memproto">

  481.       <table class="memname">

  482.         <tr>

  483.           <td class="memname">#define DISTRHO_UI_USE_NANOVG&#160;&#160;&#160;1</td>

  484.         </tr>

  485.       </table>

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

  487. <p>Whether the UI uses <a class="el" href="classNanoVG.html">NanoVG</a> for drawing instead of the default raw OpenGL calls.<br  />

  488. When enabled your UI instance will subclass NanoWidget instead of <a class="el" href="classWidget.html">Widget</a>. </p>

  489. 

  490. </div>

  491. </div>

  492. <a id="gabadb9d9ba7f479df39b3963ee60b7a4b"></a>

  493. <h2 class="memtitle"><span class="permalink"><a href="#gabadb9d9ba7f479df39b3963ee60b7a4b">&#9670;&nbsp;</a></span>DISTRHO_UI_USER_RESIZABLE</h2>

  494. 

  495. <div class="memitem">

  496. <div class="memproto">

  497.       <table class="memname">

  498.         <tr>

  499.           <td class="memname">#define DISTRHO_UI_USER_RESIZABLE&#160;&#160;&#160;1</td>

  500.         </tr>

  501.       </table>

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

  503. <p>Whether the UI is resizable to any size by the user.<br  />

  504. By default this is false, and resizing is only allowed under the plugin <a class="el" href="classUI.html">UI</a> control,<br  />

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

  506. 

  507. </div>

  508. </div>

  509. <a id="ga420a88022da249b9f38a6046998dbd7c"></a>

  510. <h2 class="memtitle"><span class="permalink"><a href="#ga420a88022da249b9f38a6046998dbd7c">&#9670;&nbsp;</a></span>DISTRHO_UI_URI</h2>

  511. 

  512. <div class="memitem">

  513. <div class="memproto">

  514.       <table class="memname">

  515.         <tr>

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

  517.         </tr>

  518.       </table>

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

  520. <p>The UI URI when exporting in LV2 format.<br  />

  521. By default this is set to <a class="el" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">DISTRHO_PLUGIN_URI</a> with "#UI" as suffix. </p>

  522. 

  523. </div>

  524. </div>

  525. <a id="ga97bd6556fb9fcfc181778edb4fceeeef"></a>

  526. <h2 class="memtitle"><span class="permalink"><a href="#ga97bd6556fb9fcfc181778edb4fceeeef">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_LV2_CATEGORY</h2>

  527. 

  528. <div class="memitem">

  529. <div class="memproto">

  530.       <table class="memname">

  531.         <tr>

  532.           <td class="memname">#define DISTRHO_PLUGIN_LV2_CATEGORY&#160;&#160;&#160;&quot;lv2:Plugin&quot;</td>

  533.         </tr>

  534.       </table>

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

  536. <p>Custom LV2 category for the plugin.<br  />

  537. This can be one of the following values:</p>

  538. <ul>

  539. <li>lv2:<a class="el" href="classPlugin.html">Plugin</a></li>

  540. <li>lv2:AllpassPlugin</li>

  541. <li>lv2:AmplifierPlugin</li>

  542. <li>lv2:AnalyserPlugin</li>

  543. <li>lv2:BandpassPlugin</li>

  544. <li>lv2:ChorusPlugin</li>

  545. <li>lv2:CombPlugin</li>

  546. <li>lv2:CompressorPlugin</li>

  547. <li>lv2:ConstantPlugin</li>

  548. <li>lv2:ConverterPlugin</li>

  549. <li>lv2:DelayPlugin</li>

  550. <li>lv2:DistortionPlugin</li>

  551. <li>lv2:DynamicsPlugin</li>

  552. <li>lv2:EQPlugin</li>

  553. <li>lv2:EnvelopePlugin</li>

  554. <li>lv2:ExpanderPlugin</li>

  555. <li>lv2:FilterPlugin</li>

  556. <li>lv2:FlangerPlugin</li>

  557. <li>lv2:FunctionPlugin</li>

  558. <li>lv2:GatePlugin</li>

  559. <li>lv2:GeneratorPlugin</li>

  560. <li>lv2:HighpassPlugin</li>

  561. <li>lv2:InstrumentPlugin</li>

  562. <li>lv2:LimiterPlugin</li>

  563. <li>lv2:LowpassPlugin</li>

  564. <li>lv2:MIDIPlugin</li>

  565. <li>lv2:MixerPlugin</li>

  566. <li>lv2:ModulatorPlugin</li>

  567. <li>lv2:MultiEQPlugin</li>

  568. <li>lv2:OscillatorPlugin</li>

  569. <li>lv2:ParaEQPlugin</li>

  570. <li>lv2:PhaserPlugin</li>

  571. <li>lv2:PitchPlugin</li>

  572. <li>lv2:ReverbPlugin</li>

  573. <li>lv2:SimulatorPlugin</li>

  574. <li>lv2:SpatialPlugin</li>

  575. <li>lv2:SpectralPlugin</li>

  576. <li>lv2:UtilityPlugin</li>

  577. <li>lv2:WaveshaperPlugin</li>

  578. </ul>

  579. <p>See <a href="http://lv2plug.in/ns/lv2core">http://lv2plug.in/ns/lv2core</a> for more information. </p>

  580. 

  581. </div>

  582. </div>

  583. <a id="gab5bfd0f8045aa7eedd2ec6f5c9c2d17f"></a>

  584. <h2 class="memtitle"><span class="permalink"><a href="#gab5bfd0f8045aa7eedd2ec6f5c9c2d17f">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_VST3_CATEGORIES</h2>

  585. 

  586. <div class="memitem">

  587. <div class="memproto">

  588.       <table class="memname">

  589.         <tr>

  590.           <td class="memname">#define DISTRHO_PLUGIN_VST3_CATEGORIES&#160;&#160;&#160;&quot;Fx&quot;</td>

  591.         </tr>

  592.       </table>

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

  594. <p>Custom VST3 categories for the plugin.<br  />

  595. This is a list of categories, separated by a <code></code>|.</p>

  596. <p>Each effect category can be one of the following values:</p>

  597. <ul>

  598. <li>Fx</li>

  599. <li>Fx|Ambisonics</li>

  600. <li>Fx|Analyzer</li>

  601. <li>Fx|Delay</li>

  602. <li>Fx|Distortion</li>

  603. <li>Fx|Dynamics</li>

  604. <li>Fx|EQ</li>

  605. <li>Fx|Filter</li>

  606. <li>Fx|Instrument</li>

  607. <li>Fx|Instrument|External</li>

  608. <li>Fx|Spatial</li>

  609. <li>Fx|Generator</li>

  610. <li>Fx|Mastering</li>

  611. <li>Fx|Modulation</li>

  612. <li>Fx|Network</li>

  613. <li>Fx|Pitch Shift</li>

  614. <li>Fx|Restoration</li>

  615. <li>Fx|Reverb</li>

  616. <li>Fx|Surround</li>

  617. <li>Fx|Tools</li>

  618. </ul>

  619. <p>Each instrument category can be one of the following values:</p>

  620. <ul>

  621. <li>Instrument</li>

  622. <li>Instrument|Drum</li>

  623. <li>Instrument|External</li>

  624. <li>Instrument|Piano</li>

  625. <li>Instrument|Sampler</li>

  626. <li>Instrument|Synth</li>

  627. <li>Instrument|Synth|Sampler</li>

  628. </ul>

  629. <dl class="section note"><dt>Note</dt><dd>DPF will automatically set Mono and Stereo categories when appropriate. </dd></dl>

  630. 

  631. </div>

  632. </div>

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

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

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

  636. Generated on Mon Oct 25 2021 10:33:22 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  638. </a> 1.8.17

  639. </small></address>

  640. </body>

  641. </html>