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.

380 lines
21KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
  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.13 -->
  33. <script type="text/javascript">
  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  35. </script>
  36. <script type="text/javascript" src="menudata.js"></script>
  37. <script type="text/javascript" src="menu.js"></script>
  38. <script type="text/javascript">
  39. $(function() {
  40. initMenu('',true,false,'search.php','Search');
  41. $(document).ready(function() { init_search(); });
  42. });
  43. </script>
  44. <div id="main-nav"></div>
  45. </div><!-- top -->
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div class="header">
  59. <div class="summary">
  60. <a href="#define-members">Macros</a> </div>
  61. <div class="headertitle">
  62. <div class="title">Plugin Macros</div> </div>
  63. </div><!--header-->
  64. <div class="contents">
  65. <table class="memberdecls">
  66. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  67. Macros</h2></td></tr>
  68. <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>
  69. <tr class="separator:ga888482a9f695c2ca2f433e5f3172dcc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <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>
  71. <tr class="separator:ga5f4f3d9a5dc3c23882d158e636319998"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <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>
  73. <tr class="separator:ga917195804ebcb2bb48c9fad52b20b3ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <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>
  75. <tr class="separator:ga9cc186448134e6a1956474b3878c97a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <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>
  77. <tr class="separator:gacf8a1af679c09637ba0bdc5f4f8e37dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <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>
  79. <tr class="separator:ga82546dd199fcea338b113f2f6da84ced"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <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>
  81. <tr class="separator:ga854bde6b6fdb0d47182149dbab0fed72"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <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>
  83. <tr class="separator:gac6873a3950f52f3fde8e386af63b69a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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>
  85. <tr class="separator:gad6b0ebf10e048f4742f29735da4d4930"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <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>
  87. <tr class="separator:gadf2e2eb7550e4116001c816adfb04a70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <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>
  89. <tr class="separator:ga548522eb91344a45841a5a95ff4f8073"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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>
  91. <tr class="separator:gad95e24b17f196260cee15255fdb5b677"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <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>
  93. <tr class="separator:ga255f43cc0997af8b56abcca260c875e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <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>
  95. <tr class="separator:ga496610b956d931b1940d07da48d123f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <tr class="separator:gad49e79936a2aa5afa089cbc051426ccd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:ga420a88022da249b9f38a6046998dbd7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table>
  101. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  102. <p>C Macros that describe your plugin. (defined in the "DistrhoPluginInfo.h" file)</p>
  103. <p>With these macros you can tell the host what features your plugin requires.<br />
  104. Depending on which macros you enable, new functions will be available to call and/or override.</p>
  105. <p>All values are either integer or strings.<br />
  106. For boolean-like values 1 means 'on' and 0 means 'off'.</p>
  107. <p>The values defined in this group are for documentation purposes only.<br />
  108. All macros are disabled by default.</p>
  109. <p>Only 4 macros are required, they are:</p><ul>
  110. <li><a class="el" href="group__PluginMacros.html#ga888482a9f695c2ca2f433e5f3172dcc4">DISTRHO_PLUGIN_NAME</a></li>
  111. <li><a class="el" href="group__PluginMacros.html#ga5f4f3d9a5dc3c23882d158e636319998">DISTRHO_PLUGIN_NUM_INPUTS</a></li>
  112. <li><a class="el" href="group__PluginMacros.html#ga917195804ebcb2bb48c9fad52b20b3ca">DISTRHO_PLUGIN_NUM_OUTPUTS</a></li>
  113. <li><a class="el" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">DISTRHO_PLUGIN_URI</a> </li>
  114. </ul>
  115. <h2 class="groupheader">Macro Definition Documentation</h2>
  116. <a id="ga888482a9f695c2ca2f433e5f3172dcc4"></a>
  117. <h2 class="memtitle"><span class="permalink"><a href="#ga888482a9f695c2ca2f433e5f3172dcc4">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_NAME</h2>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">#define DISTRHO_PLUGIN_NAME&#160;&#160;&#160;&quot;Plugin Name&quot;</td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. <p>The plugin name.<br />
  127. 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>
  128. </div>
  129. </div>
  130. <a id="ga5f4f3d9a5dc3c23882d158e636319998"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#ga5f4f3d9a5dc3c23882d158e636319998">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_NUM_INPUTS</h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">#define DISTRHO_PLUGIN_NUM_INPUTS&#160;&#160;&#160;2</td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. <p>Number of audio inputs the plugin has. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>
  141. </div>
  142. </div>
  143. <a id="ga917195804ebcb2bb48c9fad52b20b3ca"></a>
  144. <h2 class="memtitle"><span class="permalink"><a href="#ga917195804ebcb2bb48c9fad52b20b3ca">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_NUM_OUTPUTS</h2>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname">#define DISTRHO_PLUGIN_NUM_OUTPUTS&#160;&#160;&#160;2</td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. <p>Number of audio outputs the plugin has. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>
  154. </div>
  155. </div>
  156. <a id="ga9cc186448134e6a1956474b3878c97a8"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#ga9cc186448134e6a1956474b3878c97a8">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_URI</h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">#define DISTRHO_PLUGIN_URI&#160;&#160;&#160;&quot;urn:distrho:name&quot;</td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>The plugin URI when exporting in LV2 format. </p><dl class="section note"><dt>Note</dt><dd>This macro is required. </dd></dl>
  167. </div>
  168. </div>
  169. <a id="gacf8a1af679c09637ba0bdc5f4f8e37dd"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#gacf8a1af679c09637ba0bdc5f4f8e37dd">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_HAS_UI</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">#define DISTRHO_PLUGIN_HAS_UI&#160;&#160;&#160;1</td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Wherever 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>
  180. <dd>
  181. <a class="el" href="classUI.html">UI</a> </dd></dl>
  182. </div>
  183. </div>
  184. <a id="ga82546dd199fcea338b113f2f6da84ced"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#ga82546dd199fcea338b113f2f6da84ced">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_IS_RT_SAFE</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">#define DISTRHO_PLUGIN_IS_RT_SAFE&#160;&#160;&#160;1</td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <p>Wherever the plugin processing is realtime-safe.<br />
  195. TODO - list rtsafe requirements </p>
  196. </div>
  197. </div>
  198. <a id="ga854bde6b6fdb0d47182149dbab0fed72"></a>
  199. <h2 class="memtitle"><span class="permalink"><a href="#ga854bde6b6fdb0d47182149dbab0fed72">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_IS_SYNTH</h2>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">#define DISTRHO_PLUGIN_IS_SYNTH&#160;&#160;&#160;1</td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. <p>Wherever the plugin is a synth.<br />
  209. <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>
  210. </div>
  211. </div>
  212. <a id="gac6873a3950f52f3fde8e386af63b69a1"></a>
  213. <h2 class="memtitle"><span class="permalink"><a href="#gac6873a3950f52f3fde8e386af63b69a1">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_DIRECT_ACCESS</h2>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">#define DISTRHO_PLUGIN_WANT_DIRECT_ACCESS&#160;&#160;&#160;0</td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <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>
  223. <dl class="section note"><dt>Note</dt><dd>DO NOT USE THIS UNLESS STRICTLY NECESSARY!! Try to avoid it at all costs! </dd></dl>
  224. </div>
  225. </div>
  226. <a id="gad6b0ebf10e048f4742f29735da4d4930"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#gad6b0ebf10e048f4742f29735da4d4930">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_LATENCY</h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">#define DISTRHO_PLUGIN_WANT_LATENCY&#160;&#160;&#160;1</td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Wherever 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>
  237. </div>
  238. </div>
  239. <a id="gadf2e2eb7550e4116001c816adfb04a70"></a>
  240. <h2 class="memtitle"><span class="permalink"><a href="#gadf2e2eb7550e4116001c816adfb04a70">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_MIDI_INPUT</h2>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname">#define DISTRHO_PLUGIN_WANT_MIDI_INPUT&#160;&#160;&#160;1</td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Wherever the plugin wants MIDI input.<br />
  250. This is automatically enabled if <a class="el" href="group__PluginMacros.html#ga854bde6b6fdb0d47182149dbab0fed72">DISTRHO_PLUGIN_IS_SYNTH</a> is true. </p>
  251. </div>
  252. </div>
  253. <a id="ga548522eb91344a45841a5a95ff4f8073"></a>
  254. <h2 class="memtitle"><span class="permalink"><a href="#ga548522eb91344a45841a5a95ff4f8073">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_MIDI_OUTPUT</h2>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname">#define DISTRHO_PLUGIN_WANT_MIDI_OUTPUT&#160;&#160;&#160;1</td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <p>Wherever 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>
  264. </div>
  265. </div>
  266. <a id="gad95e24b17f196260cee15255fdb5b677"></a>
  267. <h2 class="memtitle"><span class="permalink"><a href="#gad95e24b17f196260cee15255fdb5b677">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_PROGRAMS</h2>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">#define DISTRHO_PLUGIN_WANT_PROGRAMS&#160;&#160;&#160;1</td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p>Wherever 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>
  277. <dd>
  278. <a class="el" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">Plugin::loadProgram(uint32_t)</a> </dd></dl>
  279. </div>
  280. </div>
  281. <a id="ga255f43cc0997af8b56abcca260c875e0"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#ga255f43cc0997af8b56abcca260c875e0">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_STATE</h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">#define DISTRHO_PLUGIN_WANT_STATE&#160;&#160;&#160;1</td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <p>Wherever 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>
  292. <dd>
  293. <a class="el" href="classPlugin.html#ad25ed64a2f00f48c86d2ae0016ea3e59">Plugin::setState(const char*, const char*)</a> </dd></dl>
  294. </div>
  295. </div>
  296. <a id="ga496610b956d931b1940d07da48d123f2"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#ga496610b956d931b1940d07da48d123f2">&#9670;&nbsp;</a></span>DISTRHO_PLUGIN_WANT_TIMEPOS</h2>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname">#define DISTRHO_PLUGIN_WANT_TIMEPOS&#160;&#160;&#160;1</td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <p>Wherever 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>
  307. </div>
  308. </div>
  309. <a id="gad49e79936a2aa5afa089cbc051426ccd"></a>
  310. <h2 class="memtitle"><span class="permalink"><a href="#gad49e79936a2aa5afa089cbc051426ccd">&#9670;&nbsp;</a></span>DISTRHO_UI_USE_NANOVG</h2>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">#define DISTRHO_UI_USE_NANOVG&#160;&#160;&#160;1</td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. <p>Wherever the UI uses <a class="el" href="classNanoVG.html">NanoVG</a> for drawing instead of the default raw OpenGL calls.<br />
  320. When enabled your UI instance will subclass <a class="el" href="classNanoWidget.html">NanoWidget</a> instead of <a class="el" href="classWidget.html">Widget</a>. </p>
  321. </div>
  322. </div>
  323. <a id="ga420a88022da249b9f38a6046998dbd7c"></a>
  324. <h2 class="memtitle"><span class="permalink"><a href="#ga420a88022da249b9f38a6046998dbd7c">&#9670;&nbsp;</a></span>DISTRHO_UI_URI</h2>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <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>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>The UI URI when exporting in LV2 format.<br />
  334. By default this is set to <a class="el" href="group__PluginMacros.html#ga9cc186448134e6a1956474b3878c97a8">DISTRHO_PLUGIN_URI</a> with "#UI" as suffix. </p>
  335. </div>
  336. </div>
  337. </div><!-- contents -->
  338. <!-- start footer part -->
  339. <hr class="footer"/><address class="footer"><small>
  340. Generated on Mon Aug 13 2018 06:29:25 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  341. <img class="footer" src="doxygen.png" alt="doxygen"/>
  342. </a> 1.8.13
  343. </small></address>
  344. </body>
  345. </html>