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.

838 lines
39KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: UI Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  65. <a href="#pro-methods">Protected Member Functions</a> &#124;
  66. <a href="#friends">Friends</a> &#124;
  67. <a href="classUI-members.html">List of all members</a> </div>
  68. <div class="headertitle">
  69. <div class="title">UI Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__MainClasses.html">Main Classes</a></div></div> </div>
  70. </div><!--header-->
  71. <div class="contents">
  72. <p><code>#include &lt;<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a>&gt;</code></p>
  73. <div class="dynheader">
  74. Inheritance diagram for UI:</div>
  75. <div class="dyncontent">
  76. <div class="center">
  77. <img src="classUI.png" alt=""/>
  78. </div></div>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  81. Public Member Functions</h2></td></tr>
  82. <tr class="memitem:a844584caf362e72c0def15ff3477187f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a844584caf362e72c0def15ff3477187f">UI</a> (uint width=0, uint height=0, bool automaticallyScaleAndSetAsMinimumSize=false)</td></tr>
  83. <tr class="separator:a844584caf362e72c0def15ff3477187f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a9b9e41e6021cc07a25b50539e74daaae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a9b9e41e6021cc07a25b50539e74daaae">~UI</a> () override</td></tr>
  85. <tr class="separator:a9b9e41e6021cc07a25b50539e74daaae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a8fe940d56a0c283095e28bbc5806af31"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a8fe940d56a0c283095e28bbc5806af31">isResizable</a> () const noexcept</td></tr>
  87. <tr class="separator:a8fe940d56a0c283095e28bbc5806af31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a3c47bc4cb3dcc558bbd05791d1cc83f5"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a3c47bc4cb3dcc558bbd05791d1cc83f5">getBackgroundColor</a> () const noexcept</td></tr>
  89. <tr class="separator:a3c47bc4cb3dcc558bbd05791d1cc83f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a607ea9f2978605808d8ef5dc3531fae7"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a607ea9f2978605808d8ef5dc3531fae7">getForegroundColor</a> () const noexcept</td></tr>
  91. <tr class="separator:a607ea9f2978605808d8ef5dc3531fae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a97d880182254652f94e7bed355370c07"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a97d880182254652f94e7bed355370c07">getSampleRate</a> () const noexcept</td></tr>
  93. <tr class="separator:a97d880182254652f94e7bed355370c07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a3359930fbeb2670230e617d430ecd67e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a3359930fbeb2670230e617d430ecd67e">getBundlePath</a> () const noexcept</td></tr>
  95. <tr class="separator:a3359930fbeb2670230e617d430ecd67e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a2efcd4f21af0470e91fb6a342d7667a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a2efcd4f21af0470e91fb6a342d7667a0">editParameter</a> (uint32_t index, bool started)</td></tr>
  97. <tr class="separator:a2efcd4f21af0470e91fb6a342d7667a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a973db6e8805f0aa9be3457685564ab8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a973db6e8805f0aa9be3457685564ab8a">setParameterValue</a> (uint32_t index, float value)</td></tr>
  99. <tr class="separator:a973db6e8805f0aa9be3457685564ab8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:abc94a38afa658849f3fdfd66cd8f5f51"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#abc94a38afa658849f3fdfd66cd8f5f51">setState</a> (const char *key, const char *value)</td></tr>
  101. <tr class="separator:abc94a38afa658849f3fdfd66cd8f5f51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a53aebb0a0a4ee5d321503d2ba8d7a631"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a53aebb0a0a4ee5d321503d2ba8d7a631">requestStateFile</a> (const char *key)</td></tr>
  103. <tr class="separator:a53aebb0a0a4ee5d321503d2ba8d7a631"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a9d630b2b1696e01015d869a5b434eb6e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a9d630b2b1696e01015d869a5b434eb6e">sendNote</a> (uint8_t channel, uint8_t note, uint8_t velocity)</td></tr>
  105. <tr class="separator:a9d630b2b1696e01015d869a5b434eb6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a0863a8f7ca7fc7e172e703c58518329f"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a0863a8f7ca7fc7e172e703c58518329f">getPluginInstancePointer</a> () const noexcept</td></tr>
  107. <tr class="separator:a0863a8f7ca7fc7e172e703c58518329f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table><table class="memberdecls">
  109. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  110. Static Public Member Functions</h2></td></tr>
  111. <tr class="memitem:ab157329c83a4660dd059508dc8d041f5"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ab157329c83a4660dd059508dc8d041f5">getNextBundlePath</a> () noexcept</td></tr>
  112. <tr class="separator:ab157329c83a4660dd059508dc8d041f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:aa7277c575b7d0a75475e5a7ae684dc0f"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#aa7277c575b7d0a75475e5a7ae684dc0f">getNextScaleFactor</a> () noexcept</td></tr>
  114. <tr class="separator:aa7277c575b7d0a75475e5a7ae684dc0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a4630e30aec3f3e7dcfc353ef2807bf56"><td class="memItemLeft" align="right" valign="top">static uintptr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a4630e30aec3f3e7dcfc353ef2807bf56">getNextWindowId</a> () noexcept</td></tr>
  116. <tr class="separator:a4630e30aec3f3e7dcfc353ef2807bf56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table><table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  119. Protected Member Functions</h2></td></tr>
  120. <tr class="memitem:ab3086d302a9685b25abf144ade3e88f6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ab3086d302a9685b25abf144ade3e88f6">parameterChanged</a> (uint32_t index, float value)=0</td></tr>
  121. <tr class="separator:ab3086d302a9685b25abf144ade3e88f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a2f043dd1b2e179248a19918c5483cfae"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a2f043dd1b2e179248a19918c5483cfae">programLoaded</a> (uint32_t index)=0</td></tr>
  123. <tr class="separator:a2f043dd1b2e179248a19918c5483cfae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a1bdc7e158d974e82f0535f1658d66575"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a1bdc7e158d974e82f0535f1658d66575">stateChanged</a> (const char *key, const char *value)=0</td></tr>
  125. <tr class="separator:a1bdc7e158d974e82f0535f1658d66575"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ac3e98726ca71f95a1e6c867706ebd9be"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ac3e98726ca71f95a1e6c867706ebd9be">sampleRateChanged</a> (double newSampleRate)</td></tr>
  127. <tr class="separator:ac3e98726ca71f95a1e6c867706ebd9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:af8de639088f3b2d42c266a2d2d6719da"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#af8de639088f3b2d42c266a2d2d6719da">uiIdle</a> ()</td></tr>
  129. <tr class="separator:af8de639088f3b2d42c266a2d2d6719da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:ad89b09ef4e8129d72ff3b3cb8716a96b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ad89b09ef4e8129d72ff3b3cb8716a96b">uiScaleFactorChanged</a> (double scaleFactor)</td></tr>
  131. <tr class="separator:ad89b09ef4e8129d72ff3b3cb8716a96b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a3d499674a620c1ce3b6e1dbded9f09c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a3d499674a620c1ce3b6e1dbded9f09c4">sizeChanged</a> (uint width, uint height) override</td></tr>
  133. <tr class="separator:a3d499674a620c1ce3b6e1dbded9f09c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table><table class="memberdecls">
  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  136. Friends</h2></td></tr>
  137. <tr class="memitem:a248da0691bb4a09193e912d67ab7552e"><td class="memItemLeft" align="right" valign="top"><a id="a248da0691bb4a09193e912d67ab7552e"></a>
  138. class&#160;</td><td class="memItemRight" valign="bottom"><b>PluginWindow</b></td></tr>
  139. <tr class="separator:a248da0691bb4a09193e912d67ab7552e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:aaf9db2e4a604d26b79f28734659b7409"><td class="memItemLeft" align="right" valign="top"><a id="aaf9db2e4a604d26b79f28734659b7409"></a>
  141. class&#160;</td><td class="memItemRight" valign="bottom"><b>UIExporter</b></td></tr>
  142. <tr class="separator:aaf9db2e4a604d26b79f28734659b7409"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. </table>
  144. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  145. <div class="textblock"><p>DPF <a class="el" href="classUI.html">UI</a> class from where <a class="el" href="classUI.html">UI</a> instances are created.</p>
  146. <dl class="section note"><dt>Note</dt><dd>You must call setSize during construction, @TODO Detailed information about this class. </dd></dl>
  147. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  148. <a id="a844584caf362e72c0def15ff3477187f"></a>
  149. <h2 class="memtitle"><span class="permalink"><a href="#a844584caf362e72c0def15ff3477187f">&#9670;&nbsp;</a></span>UI()</h2>
  150. <div class="memitem">
  151. <div class="memproto">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">UI::UI </td>
  155. <td>(</td>
  156. <td class="paramtype">uint&#160;</td>
  157. <td class="paramname"><em>width</em> = <code>0</code>, </td>
  158. </tr>
  159. <tr>
  160. <td class="paramkey"></td>
  161. <td></td>
  162. <td class="paramtype">uint&#160;</td>
  163. <td class="paramname"><em>height</em> = <code>0</code>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">bool&#160;</td>
  169. <td class="paramname"><em>automaticallyScaleAndSetAsMinimumSize</em> = <code>false</code>&#160;</td>
  170. </tr>
  171. <tr>
  172. <td></td>
  173. <td>)</td>
  174. <td></td><td></td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <p><a class="el" href="classUI.html">UI</a> class constructor. The <a class="el" href="classUI.html">UI</a> should be initialized to a default state that matches the plugin side.</p>
  179. <p>When <em>automaticallyScale</em> is set to true, DPF will automatically scale up the <a class="el" href="classUI.html">UI</a> to fit the host/desktop scale factor.<br />
  180. It assumes aspect ratio is meant to be kept. Manually call setGeometryConstraints instead if keeping <a class="el" href="classUI.html">UI</a> aspect ratio is not required. </p>
  181. </div>
  182. </div>
  183. <a id="a9b9e41e6021cc07a25b50539e74daaae"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#a9b9e41e6021cc07a25b50539e74daaae">&#9670;&nbsp;</a></span>~UI()</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="mlabels">
  188. <tr>
  189. <td class="mlabels-left">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">UI::~UI </td>
  193. <td>(</td>
  194. <td class="paramname"></td><td>)</td>
  195. <td></td>
  196. </tr>
  197. </table>
  198. </td>
  199. <td class="mlabels-right">
  200. <span class="mlabels"><span class="mlabel">override</span></span> </td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <p>Destructor. </p>
  205. </div>
  206. </div>
  207. <h2 class="groupheader">Member Function Documentation</h2>
  208. <a id="a8fe940d56a0c283095e28bbc5806af31"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#a8fe940d56a0c283095e28bbc5806af31">&#9670;&nbsp;</a></span>isResizable()</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="mlabels">
  213. <tr>
  214. <td class="mlabels-left">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">bool UI::isResizable </td>
  218. <td>(</td>
  219. <td class="paramname"></td><td>)</td>
  220. <td> const</td>
  221. </tr>
  222. </table>
  223. </td>
  224. <td class="mlabels-right">
  225. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. <p>Check if this <a class="el" href="classUI.html">UI</a> window is resizable (by the user or window manager). There are situations where an <a class="el" href="classUI.html">UI</a> supports resizing but the plugin host does not, so this could return false.</p>
  230. <p>You might want to add a resize handle for such cases, so the user is still allowed to resize the window. (programatically resizing a window is always possible, but the same is not true for the window manager) </p>
  231. </div>
  232. </div>
  233. <a id="a3c47bc4cb3dcc558bbd05791d1cc83f5"></a>
  234. <h2 class="memtitle"><span class="permalink"><a href="#a3c47bc4cb3dcc558bbd05791d1cc83f5">&#9670;&nbsp;</a></span>getBackgroundColor()</h2>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="mlabels">
  238. <tr>
  239. <td class="mlabels-left">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">uint UI::getBackgroundColor </td>
  243. <td>(</td>
  244. <td class="paramname"></td><td>)</td>
  245. <td> const</td>
  246. </tr>
  247. </table>
  248. </td>
  249. <td class="mlabels-right">
  250. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Get the color used for <a class="el" href="classUI.html">UI</a> background (i.e. window color) in RGBA format. Returns 0 by default, in case of error or lack of host support.</p>
  255. <p>The following example code can be use to extract individual colors: </p><div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> red = (bgColor &gt;&gt; 24) &amp; 0xff;</div>
  256. <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> green = (bgColor &gt;&gt; 16) &amp; 0xff;</div>
  257. <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> blue = (bgColor &gt;&gt; 8) &amp; 0xff;</div>
  258. </div><!-- fragment -->
  259. </div>
  260. </div>
  261. <a id="a607ea9f2978605808d8ef5dc3531fae7"></a>
  262. <h2 class="memtitle"><span class="permalink"><a href="#a607ea9f2978605808d8ef5dc3531fae7">&#9670;&nbsp;</a></span>getForegroundColor()</h2>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="mlabels">
  266. <tr>
  267. <td class="mlabels-left">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">uint UI::getForegroundColor </td>
  271. <td>(</td>
  272. <td class="paramname"></td><td>)</td>
  273. <td> const</td>
  274. </tr>
  275. </table>
  276. </td>
  277. <td class="mlabels-right">
  278. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <p>Get the color used for <a class="el" href="classUI.html">UI</a> foreground (i.e. text color) in RGBA format. Returns 0xffffffff by default, in case of error or lack of host support.</p>
  283. <p>The following example code can be use to extract individual colors: </p><div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> red = (fgColor &gt;&gt; 24) &amp; 0xff;</div>
  284. <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> green = (fgColor &gt;&gt; 16) &amp; 0xff;</div>
  285. <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> blue = (fgColor &gt;&gt; 8) &amp; 0xff;</div>
  286. </div><!-- fragment -->
  287. </div>
  288. </div>
  289. <a id="a97d880182254652f94e7bed355370c07"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#a97d880182254652f94e7bed355370c07">&#9670;&nbsp;</a></span>getSampleRate()</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="mlabels">
  294. <tr>
  295. <td class="mlabels-left">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname">double UI::getSampleRate </td>
  299. <td>(</td>
  300. <td class="paramname"></td><td>)</td>
  301. <td> const</td>
  302. </tr>
  303. </table>
  304. </td>
  305. <td class="mlabels-right">
  306. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  307. </tr>
  308. </table>
  309. </div><div class="memdoc">
  310. <p>Get the current sample rate used in plugin processing. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classUI.html#ac3e98726ca71f95a1e6c867706ebd9be">sampleRateChanged(double)</a> </dd></dl>
  311. </div>
  312. </div>
  313. <a id="a3359930fbeb2670230e617d430ecd67e"></a>
  314. <h2 class="memtitle"><span class="permalink"><a href="#a3359930fbeb2670230e617d430ecd67e">&#9670;&nbsp;</a></span>getBundlePath()</h2>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="mlabels">
  318. <tr>
  319. <td class="mlabels-left">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname">const char* UI::getBundlePath </td>
  323. <td>(</td>
  324. <td class="paramname"></td><td>)</td>
  325. <td> const</td>
  326. </tr>
  327. </table>
  328. </td>
  329. <td class="mlabels-right">
  330. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. <p>Get the bundle path where the <a class="el" href="classUI.html">UI</a> resides.<br />
  335. Can return null if the <a class="el" href="classUI.html">UI</a> is not available in a bundle (if it is a single binary). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PluginRelatedUtilities.html#ga59aac78ab7142a37a7a2c5f0c7fd2a62">getBinaryFilename</a> </dd></dl>
  336. </div>
  337. </div>
  338. <a id="a2efcd4f21af0470e91fb6a342d7667a0"></a>
  339. <h2 class="memtitle"><span class="permalink"><a href="#a2efcd4f21af0470e91fb6a342d7667a0">&#9670;&nbsp;</a></span>editParameter()</h2>
  340. <div class="memitem">
  341. <div class="memproto">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname">void UI::editParameter </td>
  345. <td>(</td>
  346. <td class="paramtype">uint32_t&#160;</td>
  347. <td class="paramname"><em>index</em>, </td>
  348. </tr>
  349. <tr>
  350. <td class="paramkey"></td>
  351. <td></td>
  352. <td class="paramtype">bool&#160;</td>
  353. <td class="paramname"><em>started</em>&#160;</td>
  354. </tr>
  355. <tr>
  356. <td></td>
  357. <td>)</td>
  358. <td></td><td></td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>editParameter.</p>
  363. <p>Touch/pressed-down event. Lets the host know the user is tweaking a parameter. Required in some hosts to record automation. </p>
  364. </div>
  365. </div>
  366. <a id="a973db6e8805f0aa9be3457685564ab8a"></a>
  367. <h2 class="memtitle"><span class="permalink"><a href="#a973db6e8805f0aa9be3457685564ab8a">&#9670;&nbsp;</a></span>setParameterValue()</h2>
  368. <div class="memitem">
  369. <div class="memproto">
  370. <table class="memname">
  371. <tr>
  372. <td class="memname">void UI::setParameterValue </td>
  373. <td>(</td>
  374. <td class="paramtype">uint32_t&#160;</td>
  375. <td class="paramname"><em>index</em>, </td>
  376. </tr>
  377. <tr>
  378. <td class="paramkey"></td>
  379. <td></td>
  380. <td class="paramtype">float&#160;</td>
  381. <td class="paramname"><em>value</em>&#160;</td>
  382. </tr>
  383. <tr>
  384. <td></td>
  385. <td>)</td>
  386. <td></td><td></td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p>setParameterValue.</p>
  391. <p>Change a parameter value in the <a class="el" href="classPlugin.html">Plugin</a>. </p>
  392. </div>
  393. </div>
  394. <a id="abc94a38afa658849f3fdfd66cd8f5f51"></a>
  395. <h2 class="memtitle"><span class="permalink"><a href="#abc94a38afa658849f3fdfd66cd8f5f51">&#9670;&nbsp;</a></span>setState()</h2>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">void UI::setState </td>
  401. <td>(</td>
  402. <td class="paramtype">const char *&#160;</td>
  403. <td class="paramname"><em>key</em>, </td>
  404. </tr>
  405. <tr>
  406. <td class="paramkey"></td>
  407. <td></td>
  408. <td class="paramtype">const char *&#160;</td>
  409. <td class="paramname"><em>value</em>&#160;</td>
  410. </tr>
  411. <tr>
  412. <td></td>
  413. <td>)</td>
  414. <td></td><td></td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>setState. @TODO Document this. </p>
  419. </div>
  420. </div>
  421. <a id="a53aebb0a0a4ee5d321503d2ba8d7a631"></a>
  422. <h2 class="memtitle"><span class="permalink"><a href="#a53aebb0a0a4ee5d321503d2ba8d7a631">&#9670;&nbsp;</a></span>requestStateFile()</h2>
  423. <div class="memitem">
  424. <div class="memproto">
  425. <table class="memname">
  426. <tr>
  427. <td class="memname">bool UI::requestStateFile </td>
  428. <td>(</td>
  429. <td class="paramtype">const char *&#160;</td>
  430. <td class="paramname"><em>key</em></td><td>)</td>
  431. <td></td>
  432. </tr>
  433. </table>
  434. </div><div class="memdoc">
  435. <p>Request a new file from the host, matching the properties of a state key.<br />
  436. This will use the native host file browser if available, otherwise a DPF built-in file browser is used.<br />
  437. Response will be sent asynchronously to stateChanged, with the matching key and the new file as the value.<br />
  438. It is not possible to know if the action was cancelled by the user.</p>
  439. <dl class="section return"><dt>Returns</dt><dd>Success if a file-browser was opened, otherwise false. </dd></dl>
  440. <dl class="section note"><dt>Note</dt><dd>You cannot request more than one file at a time. </dd></dl>
  441. </div>
  442. </div>
  443. <a id="a9d630b2b1696e01015d869a5b434eb6e"></a>
  444. <h2 class="memtitle"><span class="permalink"><a href="#a9d630b2b1696e01015d869a5b434eb6e">&#9670;&nbsp;</a></span>sendNote()</h2>
  445. <div class="memitem">
  446. <div class="memproto">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname">void UI::sendNote </td>
  450. <td>(</td>
  451. <td class="paramtype">uint8_t&#160;</td>
  452. <td class="paramname"><em>channel</em>, </td>
  453. </tr>
  454. <tr>
  455. <td class="paramkey"></td>
  456. <td></td>
  457. <td class="paramtype">uint8_t&#160;</td>
  458. <td class="paramname"><em>note</em>, </td>
  459. </tr>
  460. <tr>
  461. <td class="paramkey"></td>
  462. <td></td>
  463. <td class="paramtype">uint8_t&#160;</td>
  464. <td class="paramname"><em>velocity</em>&#160;</td>
  465. </tr>
  466. <tr>
  467. <td></td>
  468. <td>)</td>
  469. <td></td><td></td>
  470. </tr>
  471. </table>
  472. </div><div class="memdoc">
  473. <p>Send a single MIDI note from the <a class="el" href="classUI.html">UI</a> to the plugin DSP side.<br />
  474. A note with zero velocity will be sent as note-off (MIDI 0x80), otherwise note-on (MIDI 0x90). </p>
  475. </div>
  476. </div>
  477. <a id="a0863a8f7ca7fc7e172e703c58518329f"></a>
  478. <h2 class="memtitle"><span class="permalink"><a href="#a0863a8f7ca7fc7e172e703c58518329f">&#9670;&nbsp;</a></span>getPluginInstancePointer()</h2>
  479. <div class="memitem">
  480. <div class="memproto">
  481. <table class="mlabels">
  482. <tr>
  483. <td class="mlabels-left">
  484. <table class="memname">
  485. <tr>
  486. <td class="memname">void* UI::getPluginInstancePointer </td>
  487. <td>(</td>
  488. <td class="paramname"></td><td>)</td>
  489. <td> const</td>
  490. </tr>
  491. </table>
  492. </td>
  493. <td class="mlabels-right">
  494. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. <p>getPluginInstancePointer. @TODO Document this. </p>
  499. </div>
  500. </div>
  501. <a id="ab157329c83a4660dd059508dc8d041f5"></a>
  502. <h2 class="memtitle"><span class="permalink"><a href="#ab157329c83a4660dd059508dc8d041f5">&#9670;&nbsp;</a></span>getNextBundlePath()</h2>
  503. <div class="memitem">
  504. <div class="memproto">
  505. <table class="mlabels">
  506. <tr>
  507. <td class="mlabels-left">
  508. <table class="memname">
  509. <tr>
  510. <td class="memname">static const char* UI::getNextBundlePath </td>
  511. <td>(</td>
  512. <td class="paramname"></td><td>)</td>
  513. <td></td>
  514. </tr>
  515. </table>
  516. </td>
  517. <td class="mlabels-right">
  518. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
  519. </tr>
  520. </table>
  521. </div><div class="memdoc">
  522. <p>Get the bundle path that will be used for the next <a class="el" href="classUI.html">UI</a>. </p><dl class="section note"><dt>Note</dt><dd>: This function is only valid during <a class="el" href="group__EntryPoints.html#gaad0ced21537a067680729bee6a65d8c8">createUI()</a>, it will return null when called from anywhere else. </dd></dl>
  523. </div>
  524. </div>
  525. <a id="aa7277c575b7d0a75475e5a7ae684dc0f"></a>
  526. <h2 class="memtitle"><span class="permalink"><a href="#aa7277c575b7d0a75475e5a7ae684dc0f">&#9670;&nbsp;</a></span>getNextScaleFactor()</h2>
  527. <div class="memitem">
  528. <div class="memproto">
  529. <table class="mlabels">
  530. <tr>
  531. <td class="mlabels-left">
  532. <table class="memname">
  533. <tr>
  534. <td class="memname">static double UI::getNextScaleFactor </td>
  535. <td>(</td>
  536. <td class="paramname"></td><td>)</td>
  537. <td></td>
  538. </tr>
  539. </table>
  540. </td>
  541. <td class="mlabels-right">
  542. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
  543. </tr>
  544. </table>
  545. </div><div class="memdoc">
  546. <p>Get the scale factor that will be used for the next <a class="el" href="classUI.html">UI</a>. </p><dl class="section note"><dt>Note</dt><dd>: This function is only valid during <a class="el" href="group__EntryPoints.html#gaad0ced21537a067680729bee6a65d8c8">createUI()</a>, it will return 1.0 when called from anywhere else. </dd></dl>
  547. </div>
  548. </div>
  549. <a id="a4630e30aec3f3e7dcfc353ef2807bf56"></a>
  550. <h2 class="memtitle"><span class="permalink"><a href="#a4630e30aec3f3e7dcfc353ef2807bf56">&#9670;&nbsp;</a></span>getNextWindowId()</h2>
  551. <div class="memitem">
  552. <div class="memproto">
  553. <table class="mlabels">
  554. <tr>
  555. <td class="mlabels-left">
  556. <table class="memname">
  557. <tr>
  558. <td class="memname">static uintptr_t UI::getNextWindowId </td>
  559. <td>(</td>
  560. <td class="paramname"></td><td>)</td>
  561. <td></td>
  562. </tr>
  563. </table>
  564. </td>
  565. <td class="mlabels-right">
  566. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
  567. </tr>
  568. </table>
  569. </div><div class="memdoc">
  570. <p>Get the <a class="el" href="classWindow.html">Window</a> Id that will be used for the next created window. </p><dl class="section note"><dt>Note</dt><dd>: This function is only valid during <a class="el" href="group__EntryPoints.html#gaad0ced21537a067680729bee6a65d8c8">createUI()</a>, it will return 0 when called from anywhere else. </dd></dl>
  571. </div>
  572. </div>
  573. <a id="ab3086d302a9685b25abf144ade3e88f6"></a>
  574. <h2 class="memtitle"><span class="permalink"><a href="#ab3086d302a9685b25abf144ade3e88f6">&#9670;&nbsp;</a></span>parameterChanged()</h2>
  575. <div class="memitem">
  576. <div class="memproto">
  577. <table class="mlabels">
  578. <tr>
  579. <td class="mlabels-left">
  580. <table class="memname">
  581. <tr>
  582. <td class="memname">virtual void UI::parameterChanged </td>
  583. <td>(</td>
  584. <td class="paramtype">uint32_t&#160;</td>
  585. <td class="paramname"><em>index</em>, </td>
  586. </tr>
  587. <tr>
  588. <td class="paramkey"></td>
  589. <td></td>
  590. <td class="paramtype">float&#160;</td>
  591. <td class="paramname"><em>value</em>&#160;</td>
  592. </tr>
  593. <tr>
  594. <td></td>
  595. <td>)</td>
  596. <td></td><td></td>
  597. </tr>
  598. </table>
  599. </td>
  600. <td class="mlabels-right">
  601. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  602. </tr>
  603. </table>
  604. </div><div class="memdoc">
  605. <p>A parameter has changed on the plugin side.<br />
  606. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about parameter changes. </p>
  607. </div>
  608. </div>
  609. <a id="a2f043dd1b2e179248a19918c5483cfae"></a>
  610. <h2 class="memtitle"><span class="permalink"><a href="#a2f043dd1b2e179248a19918c5483cfae">&#9670;&nbsp;</a></span>programLoaded()</h2>
  611. <div class="memitem">
  612. <div class="memproto">
  613. <table class="mlabels">
  614. <tr>
  615. <td class="mlabels-left">
  616. <table class="memname">
  617. <tr>
  618. <td class="memname">virtual void UI::programLoaded </td>
  619. <td>(</td>
  620. <td class="paramtype">uint32_t&#160;</td>
  621. <td class="paramname"><em>index</em></td><td>)</td>
  622. <td></td>
  623. </tr>
  624. </table>
  625. </td>
  626. <td class="mlabels-right">
  627. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  628. </tr>
  629. </table>
  630. </div><div class="memdoc">
  631. <p>A program has been loaded on the plugin side.<br />
  632. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about program changes. </p>
  633. </div>
  634. </div>
  635. <a id="a1bdc7e158d974e82f0535f1658d66575"></a>
  636. <h2 class="memtitle"><span class="permalink"><a href="#a1bdc7e158d974e82f0535f1658d66575">&#9670;&nbsp;</a></span>stateChanged()</h2>
  637. <div class="memitem">
  638. <div class="memproto">
  639. <table class="mlabels">
  640. <tr>
  641. <td class="mlabels-left">
  642. <table class="memname">
  643. <tr>
  644. <td class="memname">virtual void UI::stateChanged </td>
  645. <td>(</td>
  646. <td class="paramtype">const char *&#160;</td>
  647. <td class="paramname"><em>key</em>, </td>
  648. </tr>
  649. <tr>
  650. <td class="paramkey"></td>
  651. <td></td>
  652. <td class="paramtype">const char *&#160;</td>
  653. <td class="paramname"><em>value</em>&#160;</td>
  654. </tr>
  655. <tr>
  656. <td></td>
  657. <td>)</td>
  658. <td></td><td></td>
  659. </tr>
  660. </table>
  661. </td>
  662. <td class="mlabels-right">
  663. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  664. </tr>
  665. </table>
  666. </div><div class="memdoc">
  667. <p>A state has changed on the plugin side.<br />
  668. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about state changes. </p>
  669. </div>
  670. </div>
  671. <a id="ac3e98726ca71f95a1e6c867706ebd9be"></a>
  672. <h2 class="memtitle"><span class="permalink"><a href="#ac3e98726ca71f95a1e6c867706ebd9be">&#9670;&nbsp;</a></span>sampleRateChanged()</h2>
  673. <div class="memitem">
  674. <div class="memproto">
  675. <table class="mlabels">
  676. <tr>
  677. <td class="mlabels-left">
  678. <table class="memname">
  679. <tr>
  680. <td class="memname">virtual void UI::sampleRateChanged </td>
  681. <td>(</td>
  682. <td class="paramtype">double&#160;</td>
  683. <td class="paramname"><em>newSampleRate</em></td><td>)</td>
  684. <td></td>
  685. </tr>
  686. </table>
  687. </td>
  688. <td class="mlabels-right">
  689. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  690. </tr>
  691. </table>
  692. </div><div class="memdoc">
  693. <p>Optional callback to inform the <a class="el" href="classUI.html">UI</a> about a sample rate change on the plugin side. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classUI.html#a97d880182254652f94e7bed355370c07">getSampleRate()</a> </dd></dl>
  694. </div>
  695. </div>
  696. <a id="af8de639088f3b2d42c266a2d2d6719da"></a>
  697. <h2 class="memtitle"><span class="permalink"><a href="#af8de639088f3b2d42c266a2d2d6719da">&#9670;&nbsp;</a></span>uiIdle()</h2>
  698. <div class="memitem">
  699. <div class="memproto">
  700. <table class="mlabels">
  701. <tr>
  702. <td class="mlabels-left">
  703. <table class="memname">
  704. <tr>
  705. <td class="memname">virtual void UI::uiIdle </td>
  706. <td>(</td>
  707. <td class="paramname"></td><td>)</td>
  708. <td></td>
  709. </tr>
  710. </table>
  711. </td>
  712. <td class="mlabels-right">
  713. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  714. </tr>
  715. </table>
  716. </div><div class="memdoc">
  717. <p><a class="el" href="classUI.html">UI</a> idle function, called to give idle time to the plugin <a class="el" href="classUI.html">UI</a> directly from the host. This is called right after OS event handling and <a class="el" href="classWindow.html">Window</a> idle events (within the same cycle). There are no guarantees in terms of timing. </p><dl class="section see"><dt>See also</dt><dd>addIdleCallback(IdleCallback*, uint). </dd></dl>
  718. </div>
  719. </div>
  720. <a id="ad89b09ef4e8129d72ff3b3cb8716a96b"></a>
  721. <h2 class="memtitle"><span class="permalink"><a href="#ad89b09ef4e8129d72ff3b3cb8716a96b">&#9670;&nbsp;</a></span>uiScaleFactorChanged()</h2>
  722. <div class="memitem">
  723. <div class="memproto">
  724. <table class="mlabels">
  725. <tr>
  726. <td class="mlabels-left">
  727. <table class="memname">
  728. <tr>
  729. <td class="memname">virtual void UI::uiScaleFactorChanged </td>
  730. <td>(</td>
  731. <td class="paramtype">double&#160;</td>
  732. <td class="paramname"><em>scaleFactor</em></td><td>)</td>
  733. <td></td>
  734. </tr>
  735. </table>
  736. </td>
  737. <td class="mlabels-right">
  738. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  739. </tr>
  740. </table>
  741. </div><div class="memdoc">
  742. <p><a class="el" href="classWindow.html">Window</a> scale factor function, called when the scale factor changes. This function is for plugin UIs to be able to override <a class="el" href="classWindow.html#a306742ddc21c7c41f59b41e5761a38c7">Window::onScaleFactorChanged(double)</a>.</p>
  743. <p>The default implementation does nothing. WARNING function needs a proper name </p>
  744. </div>
  745. </div>
  746. <a id="a3d499674a620c1ce3b6e1dbded9f09c4"></a>
  747. <h2 class="memtitle"><span class="permalink"><a href="#a3d499674a620c1ce3b6e1dbded9f09c4">&#9670;&nbsp;</a></span>sizeChanged()</h2>
  748. <div class="memitem">
  749. <div class="memproto">
  750. <table class="mlabels">
  751. <tr>
  752. <td class="mlabels-left">
  753. <table class="memname">
  754. <tr>
  755. <td class="memname">void UI::sizeChanged </td>
  756. <td>(</td>
  757. <td class="paramtype">uint&#160;</td>
  758. <td class="paramname"><em>width</em>, </td>
  759. </tr>
  760. <tr>
  761. <td class="paramkey"></td>
  762. <td></td>
  763. <td class="paramtype">uint&#160;</td>
  764. <td class="paramname"><em>height</em>&#160;</td>
  765. </tr>
  766. <tr>
  767. <td></td>
  768. <td>)</td>
  769. <td></td><td></td>
  770. </tr>
  771. </table>
  772. </td>
  773. <td class="mlabels-right">
  774. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span></span> </td>
  775. </tr>
  776. </table>
  777. </div><div class="memdoc">
  778. <p>External <a class="el" href="classWindow.html">Window</a> resize function, called when the window is resized. This is overriden here so the host knows when the <a class="el" href="classUI.html">UI</a> is resized by you. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classExternalWindow.html#aba350e1f737b68e51bfe8018bded6e45">ExternalWindow::sizeChanged(uint,uint)</a> </dd></dl>
  779. </div>
  780. </div>
  781. <hr/>The documentation for this class was generated from the following file:<ul>
  782. <li>distrho/<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a></li>
  783. </ul>
  784. </div><!-- contents -->
  785. <!-- start footer part -->
  786. <hr class="footer"/><address class="footer"><small>
  787. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
  788. </small></address>
  789. </body>
  790. </html>