DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/group__PluginMacros.html

817 lines
45KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.9.1"/>

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

  8. <title>DISTRHO Plugin Framework: 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. 

  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. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  115. <tr class="memitem:ga93240ccad789419d3c26768d00f2e97f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga93240ccad789419d3c26768d00f2e97f">DISTRHO_UI_DEFAULT_WIDTH</a>&#160;&#160;&#160;300</td></tr>

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

  117. <tr class="memitem:ga69f68b766833a29671400808221f8f3c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga69f68b766833a29671400808221f8f3c">DISTRHO_UI_DEFAULT_HEIGHT</a>&#160;&#160;&#160;300</td></tr>

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

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

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

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

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

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

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

  125. <tr class="memitem:ga0cb49832109c90267e4e7f7272154d4d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga0cb49832109c90267e4e7f7272154d4d">DISTRHO_PLUGIN_AU_TYPE</a>&#160;&#160;&#160;aufx</td></tr>

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

  127. <tr class="memitem:ga9c9caf7e3376c9235c3529dbc612a964"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga9c9caf7e3376c9235c3529dbc612a964">DISTRHO_PLUGIN_BRAND_ID</a>&#160;&#160;&#160;Dstr</td></tr>

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

  129. <tr class="memitem:ga096d7684289e65485311a427ad8772f3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#ga096d7684289e65485311a427ad8772f3">DISTRHO_PLUGIN_UNIQUE_ID</a>&#160;&#160;&#160;test</td></tr>

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

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

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

  133. <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|Stereo&quot;</td></tr>

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

  135. <tr class="memitem:gadf0fb4c49c6a9019a63bc52fbc2592f2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gadf0fb4c49c6a9019a63bc52fbc2592f2">DISTRHO_PLUGIN_CLAP_FEATURES</a>&#160;&#160;&#160;&quot;audio-effect&quot;, &quot;stereo&quot;</td></tr>

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

  137. <tr class="memitem:gaae12b710ad877c03b2a369e4a5e05140"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginMacros.html#gaae12b710ad877c03b2a369e4a5e05140">DISTRHO_PLUGIN_CLAP_ID</a>&#160;&#160;&#160;&quot;studio.kx.distrho.effect&quot;</td></tr>

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

  139. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

  153. </ul>

  154. <p>Additionally, <a class="el" href="group__PluginMacros.html#gaae12b710ad877c03b2a369e4a5e05140">DISTRHO_PLUGIN_CLAP_ID</a> is required if building CLAP plugins. </p>

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

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

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

  158. 

  159. <div class="memitem">

  160. <div class="memproto">

  161.       <table class="memname">

  162.         <tr>

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

  164.         </tr>

  165.       </table>

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

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

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

  169. 

  170. </div>

  171. </div>

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

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

  174. 

  175. <div class="memitem">

  176. <div class="memproto">

  177.       <table class="memname">

  178.         <tr>

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

  180.         </tr>

  181.       </table>

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

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

  184. 

  185. </div>

  186. </div>

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

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

  189. 

  190. <div class="memitem">

  191. <div class="memproto">

  192.       <table class="memname">

  193.         <tr>

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

  195.         </tr>

  196.       </table>

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

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

  199. 

  200. </div>

  201. </div>

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

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

  204. 

  205. <div class="memitem">

  206. <div class="memproto">

  207.       <table class="memname">

  208.         <tr>

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

  210.         </tr>

  211.       </table>

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

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

  214. 

  215. </div>

  216. </div>

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

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

  219. 

  220. <div class="memitem">

  221. <div class="memproto">

  222.       <table class="memname">

  223.         <tr>

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

  225.         </tr>

  226.       </table>

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

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

  229. <dd>

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

  231. 

  232. </div>

  233. </div>

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

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

  236. 

  237. <div class="memitem">

  238. <div class="memproto">

  239.       <table class="memname">

  240.         <tr>

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

  242.         </tr>

  243.       </table>

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

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

  246. TODO - list rtsafe requirements </p>

  247. 

  248. </div>

  249. </div>

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

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

  252. 

  253. <div class="memitem">

  254. <div class="memproto">

  255.       <table class="memname">

  256.         <tr>

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

  258.         </tr>

  259.       </table>

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

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

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

  263. 

  264. </div>

  265. </div>

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

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

  268. 

  269. <div class="memitem">

  270. <div class="memproto">

  271.       <table class="memname">

  272.         <tr>

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

  274.         </tr>

  275.       </table>

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

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

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

  279. 

  280. </div>

  281. </div>

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

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

  284. 

  285. <div class="memitem">

  286. <div class="memproto">

  287.       <table class="memname">

  288.         <tr>

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

  290.         </tr>

  291.       </table>

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

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

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

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

  296. 

  297. </div>

  298. </div>

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

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

  301. 

  302. <div class="memitem">

  303. <div class="memproto">

  304.       <table class="memname">

  305.         <tr>

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

  307.         </tr>

  308.       </table>

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

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

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

  312. 

  313. </div>

  314. </div>

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

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

  317. 

  318. <div class="memitem">

  319. <div class="memproto">

  320.       <table class="memname">

  321.         <tr>

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

  323.         </tr>

  324.       </table>

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

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

  327. 

  328. </div>

  329. </div>

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

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

  332. 

  333. <div class="memitem">

  334. <div class="memproto">

  335.       <table class="memname">

  336.         <tr>

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

  338.         </tr>

  339.       </table>

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

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

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

  343. 

  344. </div>

  345. </div>

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

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

  348. 

  349. <div class="memitem">

  350. <div class="memproto">

  351.       <table class="memname">

  352.         <tr>

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

  354.         </tr>

  355.       </table>

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

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

  358. 

  359. </div>

  360. </div>

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

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

  363. 

  364. <div class="memitem">

  365. <div class="memproto">

  366.       <table class="memname">

  367.         <tr>

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

  369.         </tr>

  370.       </table>

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

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

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

  374. 

  375. </div>

  376. </div>

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

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

  379. 

  380. <div class="memitem">

  381. <div class="memproto">

  382.       <table class="memname">

  383.         <tr>

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

  385.         </tr>

  386.       </table>

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

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

  389. <dd>

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

  391. 

  392. </div>

  393. </div>

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

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

  396. 

  397. <div class="memitem">

  398. <div class="memproto">

  399.       <table class="memname">

  400.         <tr>

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

  402.         </tr>

  403.       </table>

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

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

  406. <dd>

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

  408. 

  409. </div>

  410. </div>

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

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

  413. 

  414. <div class="memitem">

  415. <div class="memproto">

  416.       <table class="memname">

  417.         <tr>

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

  419.         </tr>

  420.       </table>

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

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

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

  424. 

  425. </div>

  426. </div>

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

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

  429. 

  430. <div class="memitem">

  431. <div class="memproto">

  432.       <table class="memname">

  433.         <tr>

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

  435.         </tr>

  436.       </table>

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

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

  439. 

  440. </div>

  441. </div>

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

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

  444. 

  445. <div class="memitem">

  446. <div class="memproto">

  447.       <table class="memname">

  448.         <tr>

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

  450.         </tr>

  451.       </table>

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

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

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

  455. 

  456. </div>

  457. </div>

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

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

  460. 

  461. <div class="memitem">

  462. <div class="memproto">

  463.       <table class="memname">

  464.         <tr>

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

  466.         </tr>

  467.       </table>

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

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

  470. 

  471. </div>

  472. </div>

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

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

  475. 

  476. <div class="memitem">

  477. <div class="memproto">

  478.       <table class="memname">

  479.         <tr>

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

  481.         </tr>

  482.       </table>

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

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

  485. 

  486. </div>

  487. </div>

  488. <a id="ga93240ccad789419d3c26768d00f2e97f"></a>

  489. <h2 class="memtitle"><span class="permalink"><a href="#ga93240ccad789419d3c26768d00f2e97f">&#9670;&nbsp;</a></span>DISTRHO_UI_DEFAULT_WIDTH</h2>

  490. 

  491. <div class="memitem">

  492. <div class="memproto">

  493.       <table class="memname">

  494.         <tr>

  495.           <td class="memname">#define DISTRHO_UI_DEFAULT_WIDTH&#160;&#160;&#160;300</td>

  496.         </tr>

  497.       </table>

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

  499. <p>Default <a class="el" href="classUI.html">UI</a> width to use when creating initial and temporary windows.<br  />

  500. Setting this macro allows to skip a temporary <a class="el" href="classUI.html">UI</a> from being created in certain VST2 and VST3 hosts. (which would normally be done for knowing the <a class="el" href="classUI.html">UI</a> size before host creates a window for it)</p>

  501. <p>Value must match 1x scale factor.</p>

  502. <p>When this macro is defined, the companion DISTRHO_UI_DEFAULT_HEIGHT macro must be defined as well. </p>

  503. 

  504. </div>

  505. </div>

  506. <a id="ga69f68b766833a29671400808221f8f3c"></a>

  507. <h2 class="memtitle"><span class="permalink"><a href="#ga69f68b766833a29671400808221f8f3c">&#9670;&nbsp;</a></span>DISTRHO_UI_DEFAULT_HEIGHT</h2>

  508. 

  509. <div class="memitem">

  510. <div class="memproto">

  511.       <table class="memname">

  512.         <tr>

  513.           <td class="memname">#define DISTRHO_UI_DEFAULT_HEIGHT&#160;&#160;&#160;300</td>

  514.         </tr>

  515.       </table>

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

  517. <p>Default <a class="el" href="classUI.html">UI</a> height to use when creating initial and temporary windows.<br  />

  518. Setting this macro allows to skip a temporary <a class="el" href="classUI.html">UI</a> from being created in certain VST2 and VST3 hosts. (which would normally be done for knowing the <a class="el" href="classUI.html">UI</a> size before host creates a window for it)</p>

  519. <p>Value must match 1x scale factor.</p>

  520. <p>When this macro is defined, the companion DISTRHO_UI_DEFAULT_WIDTH macro must be defined as well. </p>

  521. 

  522. </div>

  523. </div>

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

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

  526. 

  527. <div class="memitem">

  528. <div class="memproto">

  529.       <table class="memname">

  530.         <tr>

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

  532.         </tr>

  533.       </table>

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

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

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

  537. 

  538. </div>

  539. </div>

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

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

  542. 

  543. <div class="memitem">

  544. <div class="memproto">

  545.       <table class="memname">

  546.         <tr>

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

  548.         </tr>

  549.       </table>

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

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

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

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

  554. 

  555. </div>

  556. </div>

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

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

  559. 

  560. <div class="memitem">

  561. <div class="memproto">

  562.       <table class="memname">

  563.         <tr>

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

  565.         </tr>

  566.       </table>

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

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

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

  570. 

  571. </div>

  572. </div>

  573. <a id="ga0cb49832109c90267e4e7f7272154d4d"></a>

  574. <h2 class="memtitle"><span class="permalink"><a href="#ga0cb49832109c90267e4e7f7272154d4d">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_AU_TYPE</h2>

  575. 

  576. <div class="memitem">

  577. <div class="memproto">

  578.       <table class="memname">

  579.         <tr>

  580.           <td class="memname">#define DISTRHO_PLUGIN_AU_TYPE&#160;&#160;&#160;aufx</td>

  581.         </tr>

  582.       </table>

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

  584. <p>The AudioUnit type for a plugin.<br  />

  585. This is a 4-character symbol, automatically set by DPF based on other plugin macros. See <a href="https://developer.apple.com/documentation/audiotoolbox/1584142-audio_unit_types">https://developer.apple.com/documentation/audiotoolbox/1584142-audio_unit_types</a> for more information. </p>

  586. 

  587. </div>

  588. </div>

  589. <a id="ga9c9caf7e3376c9235c3529dbc612a964"></a>

  590. <h2 class="memtitle"><span class="permalink"><a href="#ga9c9caf7e3376c9235c3529dbc612a964">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_BRAND_ID</h2>

  591. 

  592. <div class="memitem">

  593. <div class="memproto">

  594.       <table class="memname">

  595.         <tr>

  596.           <td class="memname">#define DISTRHO_PLUGIN_BRAND_ID&#160;&#160;&#160;Dstr</td>

  597.         </tr>

  598.       </table>

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

  600. <p>A 4-character symbol that identifies a brand or manufacturer, with at least one non-lower case character.<br  />

  601. Plugins from the same brand should use the same symbol. </p><dl class="section note"><dt>Note</dt><dd>This macro is required when building AU plugins, and used for VST3 if present </dd>

  602. <dd>

  603. Setting this macro will change the uid of a VST3 plugin. If you already released a DPF-based VST3 plugin make sure to also enable DPF_VST3_DONT_USE_BRAND_ID </dd></dl>

  604. 

  605. </div>

  606. </div>

  607. <a id="ga096d7684289e65485311a427ad8772f3"></a>

  608. <h2 class="memtitle"><span class="permalink"><a href="#ga096d7684289e65485311a427ad8772f3">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_UNIQUE_ID</h2>

  609. 

  610. <div class="memitem">

  611. <div class="memproto">

  612.       <table class="memname">

  613.         <tr>

  614.           <td class="memname">#define DISTRHO_PLUGIN_UNIQUE_ID&#160;&#160;&#160;test</td>

  615.         </tr>

  616.       </table>

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

  618. <p>A 4-character symbol which identifies a plugin.<br  />

  619. It must be unique within at least a set of plugins from the brand. </p><dl class="section note"><dt>Note</dt><dd>This macro is required when building AU plugins </dd></dl>

  620. 

  621. </div>

  622. </div>

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

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

  625. 

  626. <div class="memitem">

  627. <div class="memproto">

  628.       <table class="memname">

  629.         <tr>

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

  631.         </tr>

  632.       </table>

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

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

  635. This is a single string, and can be one of the following values:</p>

  636. <ul>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  675. </ul>

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

  677. 

  678. </div>

  679. </div>

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

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

  682. 

  683. <div class="memitem">

  684. <div class="memproto">

  685.       <table class="memname">

  686.         <tr>

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

  688.         </tr>

  689.       </table>

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

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

  692. This is a single concatenated string of categories, separated by a <code></code>|.</p>

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

  694. <ul>

  695. <li>Fx</li>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  715. </ul>

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

  717. <ul>

  718. <li>Instrument</li>

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

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

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

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

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

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

  725. </ul>

  726. <p>And extra categories possible for any plugin type:</p>

  727. <ul>

  728. <li>Mono</li>

  729. <li>Stereo </li>

  730. </ul>

  731. 

  732. </div>

  733. </div>

  734. <a id="gadf0fb4c49c6a9019a63bc52fbc2592f2"></a>

  735. <h2 class="memtitle"><span class="permalink"><a href="#gadf0fb4c49c6a9019a63bc52fbc2592f2">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_CLAP_FEATURES</h2>

  736. 

  737. <div class="memitem">

  738. <div class="memproto">

  739.       <table class="memname">

  740.         <tr>

  741.           <td class="memname">#define DISTRHO_PLUGIN_CLAP_FEATURES&#160;&#160;&#160;&quot;audio-effect&quot;, &quot;stereo&quot;</td>

  742.         </tr>

  743.       </table>

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

  745. <p>Custom CLAP features for the plugin.<br  />

  746. This is a list of features defined as a string array body, without the terminating <code></code>, or nullptr.</p>

  747. <p>A top-level category can be set as feature and be one of the following values:</p>

  748. <ul>

  749. <li>instrument</li>

  750. <li>audio-effect</li>

  751. <li>note-effect</li>

  752. <li>analyzer</li>

  753. </ul>

  754. <p>The following sub-categories can also be set:</p>

  755. <ul>

  756. <li>synthesizer</li>

  757. <li>sampler</li>

  758. <li>drum</li>

  759. <li>drum-machine</li>

  760. <li>filter</li>

  761. <li>phaser</li>

  762. <li>equalizer</li>

  763. <li>de-esser</li>

  764. <li>phase-vocoder</li>

  765. <li>granular</li>

  766. <li>frequency-shifter</li>

  767. <li>pitch-shifter</li>

  768. <li>distortion</li>

  769. <li>transient-shaper</li>

  770. <li>compressor</li>

  771. <li>limiter</li>

  772. <li>flanger</li>

  773. <li>chorus</li>

  774. <li>delay</li>

  775. <li>reverb</li>

  776. <li>tremolo</li>

  777. <li>glitch</li>

  778. <li>utility</li>

  779. <li>pitch-correction</li>

  780. <li>restoration</li>

  781. <li>multi-effects</li>

  782. <li>mixing</li>

  783. <li>mastering</li>

  784. </ul>

  785. <p>And finally the following audio capabilities can be set:</p>

  786. <ul>

  787. <li>mono</li>

  788. <li>stereo</li>

  789. <li>surround</li>

  790. <li>ambisonic </li>

  791. </ul>

  792. 

  793. </div>

  794. </div>

  795. <a id="gaae12b710ad877c03b2a369e4a5e05140"></a>

  796. <h2 class="memtitle"><span class="permalink"><a href="#gaae12b710ad877c03b2a369e4a5e05140">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_CLAP_ID</h2>

  797. 

  798. <div class="memitem">

  799. <div class="memproto">

  800.       <table class="memname">

  801.         <tr>

  802.           <td class="memname">#define DISTRHO_PLUGIN_CLAP_ID&#160;&#160;&#160;&quot;studio.kx.distrho.effect&quot;</td>

  803.         </tr>

  804.       </table>

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

  806. <p>The plugin id when exporting in CLAP format, in reverse URI form. </p><dl class="section note"><dt>Note</dt><dd>This macro is required when building CLAP plugins </dd></dl>

  807. 

  808. </div>

  809. </div>

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

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

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

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

  814. </small></address>

  815. </body>

  816. </html>