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.
397 Commits
6 Branches
58MB
Tree: db1e4a4e6e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'db1e4a4e6e'
${ noResults }
DPF/group__PluginMacros.html

493 lines
29KB
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: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  120. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

  134. </ul>

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

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

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

  138. 

  139. <div class="memitem">

  140. <div class="memproto">

  141.       <table class="memname">

  142.         <tr>

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

  144.         </tr>

  145.       </table>

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

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

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

  149. 

  150. </div>

  151. </div>

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

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

  154. 

  155. <div class="memitem">

  156. <div class="memproto">

  157.       <table class="memname">

  158.         <tr>

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

  160.         </tr>

  161.       </table>

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

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

  164. 

  165. </div>

  166. </div>

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

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

  169. 

  170. <div class="memitem">

  171. <div class="memproto">

  172.       <table class="memname">

  173.         <tr>

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

  175.         </tr>

  176.       </table>

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

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

  179. 

  180. </div>

  181. </div>

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

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

  184. 

  185. <div class="memitem">

  186. <div class="memproto">

  187.       <table class="memname">

  188.         <tr>

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

  190.         </tr>

  191.       </table>

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

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

  194. 

  195. </div>

  196. </div>

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

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

  199. 

  200. <div class="memitem">

  201. <div class="memproto">

  202.       <table class="memname">

  203.         <tr>

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

  205.         </tr>

  206.       </table>

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

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

  209. <dd>

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

  211. 

  212. </div>

  213. </div>

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

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

  216. 

  217. <div class="memitem">

  218. <div class="memproto">

  219.       <table class="memname">

  220.         <tr>

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

  222.         </tr>

  223.       </table>

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

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

  226. TODO - list rtsafe requirements </p>

  227. 

  228. </div>

  229. </div>

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

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

  232. 

  233. <div class="memitem">

  234. <div class="memproto">

  235.       <table class="memname">

  236.         <tr>

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

  238.         </tr>

  239.       </table>

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

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

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

  243. 

  244. </div>

  245. </div>

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

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

  248. 

  249. <div class="memitem">

  250. <div class="memproto">

  251.       <table class="memname">

  252.         <tr>

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

  254.         </tr>

  255.       </table>

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

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

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

  259. 

  260. </div>

  261. </div>

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

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

  264. 

  265. <div class="memitem">

  266. <div class="memproto">

  267.       <table class="memname">

  268.         <tr>

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

  270.         </tr>

  271.       </table>

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

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

  274. 

  275. </div>

  276. </div>

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

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

  279. 

  280. <div class="memitem">

  281. <div class="memproto">

  282.       <table class="memname">

  283.         <tr>

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

  285.         </tr>

  286.       </table>

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

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

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

  290. 

  291. </div>

  292. </div>

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

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

  295. 

  296. <div class="memitem">

  297. <div class="memproto">

  298.       <table class="memname">

  299.         <tr>

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

  301.         </tr>

  302.       </table>

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

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

  305. 

  306. </div>

  307. </div>

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

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

  310. 

  311. <div class="memitem">

  312. <div class="memproto">

  313.       <table class="memname">

  314.         <tr>

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

  316.         </tr>

  317.       </table>

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

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

  320. Not all hosts or plugin formats support this, so Plugin::canRequestParameterValueChanges() can be used to query support at runtime. </p><dl class="section see"><dt>See also</dt><dd>Plugin::requestParameterValueChange(uint32_t, float) </dd></dl>

  321. 

  322. </div>

  323. </div>

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

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

  326. 

  327. <div class="memitem">

  328. <div class="memproto">

  329.       <table class="memname">

  330.         <tr>

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

  332.         </tr>

  333.       </table>

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

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

  336. <dd>

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

  338. 

  339. </div>

  340. </div>

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

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

  343. 

  344. <div class="memitem">

  345. <div class="memproto">

  346.       <table class="memname">

  347.         <tr>

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

  349.         </tr>

  350.       </table>

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

  352. <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#ae301a970a8b5cff3c7ecef927ea20080">Plugin::initState(uint32_t, String&amp;, String&amp;)</a> </dd>

  353. <dd>

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

  355. 

  356. </div>

  357. </div>

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

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

  360. 

  361. <div class="memitem">

  362. <div class="memproto">

  363.       <table class="memname">

  364.         <tr>

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

  366.         </tr>

  367.       </table>

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

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

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

  371. 

  372. </div>

  373. </div>

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

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

  376. 

  377. <div class="memitem">

  378. <div class="memproto">

  379.       <table class="memname">

  380.         <tr>

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

  382.         </tr>

  383.       </table>

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

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

  386. 

  387. </div>

  388. </div>

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

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

  391. 

  392. <div class="memitem">

  393. <div class="memproto">

  394.       <table class="memname">

  395.         <tr>

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

  397.         </tr>

  398.       </table>

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

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

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

  402. 

  403. </div>

  404. </div>

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

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

  407. 

  408. <div class="memitem">

  409. <div class="memproto">

  410.       <table class="memname">

  411.         <tr>

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

  413.         </tr>

  414.       </table>

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

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

  417. 

  418. </div>

  419. </div>

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

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

  422. 

  423. <div class="memitem">

  424. <div class="memproto">

  425.       <table class="memname">

  426.         <tr>

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

  428.         </tr>

  429.       </table>

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

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

  432. 

  433. </div>

  434. </div>

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

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

  437. 

  438. <div class="memitem">

  439. <div class="memproto">

  440.       <table class="memname">

  441.         <tr>

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

  443.         </tr>

  444.       </table>

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

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

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

  448. 

  449. </div>

  450. </div>

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

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

  453. 

  454. <div class="memitem">

  455. <div class="memproto">

  456.       <table class="memname">

  457.         <tr>

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

  459.         </tr>

  460.       </table>

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

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

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

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

  465. 

  466. </div>

  467. </div>

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

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

  470. 

  471. <div class="memitem">

  472. <div class="memproto">

  473.       <table class="memname">

  474.         <tr>

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

  476.         </tr>

  477.       </table>

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

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

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

  481. 

  482. </div>

  483. </div>

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

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

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

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

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

  489. </a> 1.8.17

  490. </small></address>

  491. </body>

  492. </html>