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.
406 Commits
7 Branches
52MB
Tree: 2651f47dc4
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '2651f47dc4'
${ noResults }
DPF/group__PluginMacros.html

530 lines
31KB
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. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

  138. </ul>

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

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

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

  142. 

  143. <div class="memitem">

  144. <div class="memproto">

  145.       <table class="memname">

  146.         <tr>

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

  148.         </tr>

  149.       </table>

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

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

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

  153. 

  154. </div>

  155. </div>

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

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

  158. 

  159. <div class="memitem">

  160. <div class="memproto">

  161.       <table class="memname">

  162.         <tr>

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

  164.         </tr>

  165.       </table>

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

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

  168. 

  169. </div>

  170. </div>

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

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

  173. 

  174. <div class="memitem">

  175. <div class="memproto">

  176.       <table class="memname">

  177.         <tr>

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

  179.         </tr>

  180.       </table>

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

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

  183. 

  184. </div>

  185. </div>

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

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

  188. 

  189. <div class="memitem">

  190. <div class="memproto">

  191.       <table class="memname">

  192.         <tr>

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

  194.         </tr>

  195.       </table>

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

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

  198. 

  199. </div>

  200. </div>

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

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

  203. 

  204. <div class="memitem">

  205. <div class="memproto">

  206.       <table class="memname">

  207.         <tr>

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

  209.         </tr>

  210.       </table>

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

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

  213. <dd>

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

  215. 

  216. </div>

  217. </div>

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

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

  220. 

  221. <div class="memitem">

  222. <div class="memproto">

  223.       <table class="memname">

  224.         <tr>

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

  226.         </tr>

  227.       </table>

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

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

  230. TODO - list rtsafe requirements </p>

  231. 

  232. </div>

  233. </div>

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

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

  236. 

  237. <div class="memitem">

  238. <div class="memproto">

  239.       <table class="memname">

  240.         <tr>

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

  242.         </tr>

  243.       </table>

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

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

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

  247. 

  248. </div>

  249. </div>

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

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

  252. 

  253. <div class="memitem">

  254. <div class="memproto">

  255.       <table class="memname">

  256.         <tr>

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

  258.         </tr>

  259.       </table>

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

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

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

  263. 

  264. </div>

  265. </div>

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

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

  268. 

  269. <div class="memitem">

  270. <div class="memproto">

  271.       <table class="memname">

  272.         <tr>

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

  274.         </tr>

  275.       </table>

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

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

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

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

  280. 

  281. </div>

  282. </div>

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

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

  285. 

  286. <div class="memitem">

  287. <div class="memproto">

  288.       <table class="memname">

  289.         <tr>

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

  291.         </tr>

  292.       </table>

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

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

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

  296. 

  297. </div>

  298. </div>

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

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

  301. 

  302. <div class="memitem">

  303. <div class="memproto">

  304.       <table class="memname">

  305.         <tr>

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

  307.         </tr>

  308.       </table>

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

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

  311. 

  312. </div>

  313. </div>

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

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

  316. 

  317. <div class="memitem">

  318. <div class="memproto">

  319.       <table class="memname">

  320.         <tr>

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

  322.         </tr>

  323.       </table>

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

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

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

  327. 

  328. </div>

  329. </div>

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

  331. <h2 class="memtitle"><span class="permalink"><a href="#ga548522eb91344a45841a5a95ff4f8073">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_MIDI_OUTPUT</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_OUTPUT&#160;&#160;&#160;1</td>

  338.         </tr>

  339.       </table>

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

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

  342. 

  343. </div>

  344. </div>

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

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

  347. 

  348. <div class="memitem">

  349. <div class="memproto">

  350.       <table class="memname">

  351.         <tr>

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

  353.         </tr>

  354.       </table>

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

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

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

  358. 

  359. </div>

  360. </div>

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

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

  363. 

  364. <div class="memitem">

  365. <div class="memproto">

  366.       <table class="memname">

  367.         <tr>

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

  369.         </tr>

  370.       </table>

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

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

  373. <dd>

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

  375. 

  376. </div>

  377. </div>

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

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

  380. 

  381. <div class="memitem">

  382. <div class="memproto">

  383.       <table class="memname">

  384.         <tr>

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

  386.         </tr>

  387.       </table>

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

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

  390. <dd>

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

  392. 

  393. </div>

  394. </div>

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

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

  397. 

  398. <div class="memitem">

  399. <div class="memproto">

  400.       <table class="memname">

  401.         <tr>

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

  403.         </tr>

  404.       </table>

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

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

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

  408. 

  409. </div>

  410. </div>

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

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

  413. 

  414. <div class="memitem">

  415. <div class="memproto">

  416.       <table class="memname">

  417.         <tr>

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

  419.         </tr>

  420.       </table>

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

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

  423. 

  424. </div>

  425. </div>

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

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

  428. 

  429. <div class="memitem">

  430. <div class="memproto">

  431.       <table class="memname">

  432.         <tr>

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

  434.         </tr>

  435.       </table>

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

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

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

  439. 

  440. </div>

  441. </div>

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

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

  444. 

  445. <div class="memitem">

  446. <div class="memproto">

  447.       <table class="memname">

  448.         <tr>

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

  450.         </tr>

  451.       </table>

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

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

  454. 

  455. </div>

  456. </div>

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

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

  459. 

  460. <div class="memitem">

  461. <div class="memproto">

  462.       <table class="memname">

  463.         <tr>

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

  465.         </tr>

  466.       </table>

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

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

  469. 

  470. </div>

  471. </div>

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

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

  474. 

  475. <div class="memitem">

  476. <div class="memproto">

  477.       <table class="memname">

  478.         <tr>

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

  480.         </tr>

  481.       </table>

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

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

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

  485. 

  486. </div>

  487. </div>

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

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

  490. 

  491. <div class="memitem">

  492. <div class="memproto">

  493.       <table class="memname">

  494.         <tr>

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

  496.         </tr>

  497.       </table>

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

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

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

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

  502. 

  503. </div>

  504. </div>

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

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

  507. 

  508. <div class="memitem">

  509. <div class="memproto">

  510.       <table class="memname">

  511.         <tr>

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

  513.         </tr>

  514.       </table>

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

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

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

  518. 

  519. </div>

  520. </div>

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

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

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

  524. Generated on Wed Sep 22 2021 13:21:08 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  526. </a> 1.8.17

  527. </small></address>

  528. </body>

  529. </html>