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

448 lines
60KB
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: distrho/DistrhoUI.hpp Source File</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. <!-- 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. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. <div id="nav-path" class="navpath">

  63.   <ul>

  64. <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li>  </ul>

  65. </div>

  66. </div><!-- top -->

  67. <div class="header">

  68.   <div class="headertitle">

  69. <div class="title">DistrhoUI.hpp</div>  </div>

  70. </div><!--header-->

  71. <div class="contents">

  72. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>

  73. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>

  74. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright (C) 2012-2021 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>

  75. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>

  76. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>

  77. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>

  78. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>

  79. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>

  80. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>

  81. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>

  82. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>

  83. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>

  84. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>

  85. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>

  86. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>

  87. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160; </div>

  88. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef DISTRHO_UI_HPP_INCLUDED</span></div>

  89. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define DISTRHO_UI_HPP_INCLUDED</span></div>

  90. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160; </div>

  91. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;extra/LeakDetector.hpp&quot;</span></div>

  92. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;src/DistrhoPluginChecks.h&quot;</span></div>

  93. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>

  94. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#ifdef DGL_CAIRO</span></div>

  95. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor"># include &quot;Cairo.hpp&quot;</span></div>

  96. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#endif</span></div>

  97. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#ifdef DGL_OPENGL</span></div>

  98. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor"># include &quot;OpenGL.hpp&quot;</span></div>

  99. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#endif</span></div>

  100. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#ifdef DGL_VULKAN</span></div>

  101. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor"># include &quot;Vulkan.hpp&quot;</span></div>

  102. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#endif</span></div>

  103. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160; </div>

  104. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_HAS_EXTERNAL_UI</span></div>

  105. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor"># include &quot;../dgl/Base.hpp&quot;</span></div>

  106. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor"># include &quot;extra/ExternalWindow.hpp&quot;</span></div>

  107. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="keyword">typedef</span> DISTRHO_NAMESPACE::ExternalWindow UIWidget;</div>

  108. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#elif DISTRHO_UI_USE_CUSTOM</span></div>

  109. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor"># include DISTRHO_UI_CUSTOM_INCLUDE_PATH</span></div>

  110. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="keyword">typedef</span> <a class="code" href="group__PluginMacros.html#gaf6377f757b9796bd37f7be4e605ccd4a">DISTRHO_UI_CUSTOM_WIDGET_TYPE</a> UIWidget;</div>

  111. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#elif DISTRHO_UI_USE_CAIRO</span></div>

  112. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor"># include &quot;../dgl/Cairo.hpp&quot;</span></div>

  113. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">typedef</span> DGL_NAMESPACE::CairoTopLevelWidget UIWidget;</div>

  114. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#elif DISTRHO_UI_USE_NANOVG</span></div>

  115. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="preprocessor"># include &quot;../dgl/NanoVG.hpp&quot;</span></div>

  116. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="keyword">typedef</span> DGL_NAMESPACE::NanoTopLevelWidget UIWidget;</div>

  117. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#else</span></div>

  118. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor"># include &quot;../dgl/TopLevelWidget.hpp&quot;</span></div>

  119. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="keyword">typedef</span> DGL_NAMESPACE::TopLevelWidget UIWidget;</div>

  120. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="preprocessor">#endif</span></div>

  121. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160; </div>

  122. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;START_NAMESPACE_DGL</div>

  123. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="keyword">class </span>PluginWindow;</div>

  124. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;END_NAMESPACE_DGL</div>

  125. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160; </div>

  126. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;START_NAMESPACE_DISTRHO</div>

  127. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>

  128. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  129. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * DPF UI */</span></div>

  130. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"></span> </div>

  131. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">/**</span></div>

  132. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">   @addtogroup MainClasses</span></div>

  133. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">   @{</span></div>

  134. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"> */</span></div>

  135. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"></span> </div>

  136. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment">/**</span></div>

  137. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">   DPF UI class from where UI instances are created.</span></div>

  138. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment"></span> </div>

  139. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment">   @note You must call setSize during construction,</span></div>

  140. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment">   @TODO Detailed information about this class.</span></div>

  141. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"> */</span></div>

  142. <div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classUI.html">   71</a></span>&#160;<span class="keyword">class </span><a class="code" href="classUI.html">UI</a> : <span class="keyword">public</span> UIWidget</div>

  143. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;{</div>

  144. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div>

  145. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment">   /**</span></div>

  146. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">      UI class constructor.</span></div>

  147. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">      The UI should be initialized to a default state that matches the plugin side.</span></div>

  148. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">    */</span></div>

  149. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <a class="code" href="classUI.html#ad3425075e4a23234a8568d1893b54f22">UI</a>(uint width = 0, uint height = 0);</div>

  150. <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"></span> </div>

  151. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">   /**</span></div>

  152. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">      Destructor.</span></div>

  153. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">    */</span></div>

  154. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="classUI.html#a47e7b6111faba049dfee4738d067cc42">~UI</a>();</div>

  155. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160; </div>

  156. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  157. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment">    * Host state */</span></div>

  158. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"></span> </div>

  159. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">   /**</span></div>

  160. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">      Check if this UI window is resizable (by the user or window manager).</span></div>

  161. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">      There are situations where an UI supports resizing but the plugin host does not, so this could return false.</span></div>

  162. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"></span> </div>

  163. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment">      You might want to add a resize handle for such cases, so the user is still allowed to resize the window.</span></div>

  164. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment">      (programatically resizing a window is always possible, but the same is not true for the window manager)</span></div>

  165. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment">    */</span></div>

  166. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classUI.html#a8fe940d56a0c283095e28bbc5806af31">isResizable</a>() <span class="keyword">const</span> noexcept;</div>

  167. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"></span> </div>

  168. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment">   /**</span></div>

  169. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment">      Get the color used for UI background (i.e. window color) in RGBA format.</span></div>

  170. <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment">      Returns 0 by default, in case of error or lack of host support.</span></div>

  171. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"></span> </div>

  172. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment">      The following example code can be use to extract individual colors:</span></div>

  173. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">      ```</span></div>

  174. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment">      const int red   = (bgColor &gt;&gt; 24) &amp; 0xff;</span></div>

  175. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment">      const int green = (bgColor &gt;&gt; 16) &amp; 0xff;</span></div>

  176. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment">      const int blue  = (bgColor &gt;&gt;  8) &amp; 0xff;</span></div>

  177. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment">      ```</span></div>

  178. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment">    */</span></div>

  179. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    uint <a class="code" href="classUI.html#a3c47bc4cb3dcc558bbd05791d1cc83f5">getBackgroundColor</a>() <span class="keyword">const</span> noexcept;</div>

  180. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"></span> </div>

  181. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment">   /**</span></div>

  182. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment">      Get the color used for UI foreground (i.e. text color) in RGBA format.</span></div>

  183. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment">      Returns 0xffffffff by default, in case of error or lack of host support.</span></div>

  184. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"></span> </div>

  185. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">      The following example code can be use to extract individual colors:</span></div>

  186. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">      ```</span></div>

  187. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment">      const int red   = (fgColor &gt;&gt; 24) &amp; 0xff;</span></div>

  188. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment">      const int green = (fgColor &gt;&gt; 16) &amp; 0xff;</span></div>

  189. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment">      const int blue  = (fgColor &gt;&gt;  8) &amp; 0xff;</span></div>

  190. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment">      ```</span></div>

  191. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment">    */</span></div>

  192. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    uint <a class="code" href="classUI.html#a607ea9f2978605808d8ef5dc3531fae7">getForegroundColor</a>() <span class="keyword">const</span> noexcept;</div>

  193. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"></span> </div>

  194. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment">   /**</span></div>

  195. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment">      Get the current sample rate used in plugin processing.</span></div>

  196. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment">      @see sampleRateChanged(double)</span></div>

  197. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment">    */</span></div>

  198. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    <span class="keywordtype">double</span> <a class="code" href="classUI.html#a97d880182254652f94e7bed355370c07">getSampleRate</a>() <span class="keyword">const</span> noexcept;</div>

  199. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"></span> </div>

  200. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">   /**</span></div>

  201. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment">      editParameter.</span></div>

  202. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment"></span> </div>

  203. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">      Touch/pressed-down event.</span></div>

  204. <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">      Lets the host know the user is tweaking a parameter.</span></div>

  205. <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment">      Required in some hosts to record automation.</span></div>

  206. <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment">    */</span></div>

  207. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classUI.html#a2efcd4f21af0470e91fb6a342d7667a0">editParameter</a>(uint32_t index, <span class="keywordtype">bool</span> started);</div>

  208. <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"></span> </div>

  209. <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment">   /**</span></div>

  210. <div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment">      setParameterValue.</span></div>

  211. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"></span> </div>

  212. <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment">      Change a parameter value in the Plugin.</span></div>

  213. <div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">    */</span></div>

  214. <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classUI.html#a973db6e8805f0aa9be3457685564ab8a">setParameterValue</a>(uint32_t index, <span class="keywordtype">float</span> value);</div>

  215. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160; </div>

  216. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div>

  217. <div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment">   /**</span></div>

  218. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment">      setState.</span></div>

  219. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">      @TODO Document this.</span></div>

  220. <div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment">    */</span></div>

  221. <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classUI.html#abc94a38afa658849f3fdfd66cd8f5f51">setState</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value);</div>

  222. <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="preprocessor">#endif</span></div>

  223. <div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160; </div>

  224. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATEFILES</span></div>

  225. <div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment">   /**</span></div>

  226. <div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment">      Request a new file from the host, matching the properties of a state key.@n</span></div>

  227. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment">      This will use the native host file browser if available, otherwise a DPF built-in file browser is used.@n</span></div>

  228. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">      Response will be sent asynchronously to stateChanged, with the matching key and the new file as the value.@n</span></div>

  229. <div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment">      It is not possible to know if the action was cancelled by the user.</span></div>

  230. <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment"></span> </div>

  231. <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">      @return Success if a file-browser was opened, otherwise false.</span></div>

  232. <div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment">      @note You cannot request more than one file at a time.</span></div>

  233. <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">    */</span></div>

  234. <div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;    <span class="keywordtype">bool</span> requestStateFile(<span class="keyword">const</span> <span class="keywordtype">char</span>* key);</div>

  235. <div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="preprocessor">#endif</span></div>

  236. <div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160; </div>

  237. <div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_MIDI_INPUT</span></div>

  238. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment">   /**</span></div>

  239. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment">      Send a single MIDI note from the UI to the plugin DSP side.@n</span></div>

  240. <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment">      A note with zero velocity will be sent as note-off (MIDI 0x80), otherwise note-on (MIDI 0x90).</span></div>

  241. <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment">    */</span></div>

  242. <div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classUI.html#a9d630b2b1696e01015d869a5b434eb6e">sendNote</a>(uint8_t channel, uint8_t note, uint8_t velocity);</div>

  243. <div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="preprocessor">#endif</span></div>

  244. <div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160; </div>

  245. <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_DIRECT_ACCESS</span></div>

  246. <div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  247. <div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="comment">    * Direct DSP access - DO NOT USE THIS UNLESS STRICTLY NECESSARY!! */</span></div>

  248. <div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment"></span> </div>

  249. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="comment">   /**</span></div>

  250. <div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment">      getPluginInstancePointer.</span></div>

  251. <div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment">      @TODO Document this.</span></div>

  252. <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment">    */</span></div>

  253. <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;    <span class="keywordtype">void</span>* <a class="code" href="classUI.html#a0863a8f7ca7fc7e172e703c58518329f">getPluginInstancePointer</a>() <span class="keyword">const</span> noexcept;</div>

  254. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="preprocessor">#endif</span></div>

  255. <div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160; </div>

  256. <div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_HAS_EXTERNAL_UI</span></div>

  257. <div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  258. <div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment">    * External UI helpers */</span></div>

  259. <div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment"></span> </div>

  260. <div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment">   /**</span></div>

  261. <div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment">      Get the bundle path that will be used for the next UI.</span></div>

  262. <div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment">      @note: This function is only valid during createUI(),</span></div>

  263. <div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment">             it will return null when called from anywhere else.</span></div>

  264. <div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment">    */</span></div>

  265. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;    <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classUI.html#ab157329c83a4660dd059508dc8d041f5">getNextBundlePath</a>() noexcept;</div>

  266. <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment"></span> </div>

  267. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment">   /**</span></div>

  268. <div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment">      Get the scale factor that will be used for the next UI.</span></div>

  269. <div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment">      @note: This function is only valid during createUI(),</span></div>

  270. <div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment">             it will return 1.0 when called from anywhere else.</span></div>

  271. <div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment">    */</span></div>

  272. <div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;    <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="classUI.html#aa7277c575b7d0a75475e5a7ae684dc0f">getNextScaleFactor</a>() noexcept;</div>

  273. <div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160; </div>

  274. <div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="preprocessor"># if DISTRHO_PLUGIN_HAS_EMBED_UI</span></div>

  275. <div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="comment">   /**</span></div>

  276. <div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="comment">      Get the Window Id that will be used for the next created window.</span></div>

  277. <div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;<span class="comment">      @note: This function is only valid during createUI(),</span></div>

  278. <div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;<span class="comment">             it will return 0 when called from anywhere else.</span></div>

  279. <div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;<span class="comment">    */</span></div>

  280. <div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;    <span class="keyword">static</span> uintptr_t <a class="code" href="classUI.html#a4630e30aec3f3e7dcfc353ef2807bf56">getNextWindowId</a>() noexcept;</div>

  281. <div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;<span class="preprocessor"># endif</span></div>

  282. <div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;<span class="preprocessor">#endif</span></div>

  283. <div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160; </div>

  284. <div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="keyword">protected</span>:</div>

  285. <div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  286. <div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="comment">    * DSP/Plugin Callbacks */</span></div>

  287. <div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="comment"></span> </div>

  288. <div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="comment">   /**</span></div>

  289. <div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;<span class="comment">      A parameter has changed on the plugin side.@n</span></div>

  290. <div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;<span class="comment">      This is called by the host to inform the UI about parameter changes.</span></div>

  291. <div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;<span class="comment">    */</span></div>

  292. <div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#ab3086d302a9685b25abf144ade3e88f6">parameterChanged</a>(uint32_t index, <span class="keywordtype">float</span> value) = 0;</div>

  293. <div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160; </div>

  294. <div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_PROGRAMS</span></div>

  295. <div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment">   /**</span></div>

  296. <div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment">      A program has been loaded on the plugin side.@n</span></div>

  297. <div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;<span class="comment">      This is called by the host to inform the UI about program changes.</span></div>

  298. <div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment">    */</span></div>

  299. <div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#a2f043dd1b2e179248a19918c5483cfae">programLoaded</a>(uint32_t index) = 0;</div>

  300. <div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;<span class="preprocessor">#endif</span></div>

  301. <div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160; </div>

  302. <div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;<span class="preprocessor">#if DISTRHO_PLUGIN_WANT_STATE</span></div>

  303. <div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="comment">   /**</span></div>

  304. <div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment">      A state has changed on the plugin side.@n</span></div>

  305. <div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;<span class="comment">      This is called by the host to inform the UI about state changes.</span></div>

  306. <div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;<span class="comment">    */</span></div>

  307. <div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#a1bdc7e158d974e82f0535f1658d66575">stateChanged</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value) = 0;</div>

  308. <div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;<span class="preprocessor">#endif</span></div>

  309. <div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160; </div>

  310. <div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  311. <div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment">    * DSP/Plugin Callbacks (optional) */</span></div>

  312. <div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment"></span> </div>

  313. <div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;<span class="comment">   /**</span></div>

  314. <div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;<span class="comment">      Optional callback to inform the UI about a sample rate change on the plugin side.</span></div>

  315. <div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;<span class="comment">      @see getSampleRate()</span></div>

  316. <div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;<span class="comment">    */</span></div>

  317. <div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classUI.html#ac3e98726ca71f95a1e6c867706ebd9be">sampleRateChanged</a>(<span class="keywordtype">double</span> newSampleRate);</div>

  318. <div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160; </div>

  319. <div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;<span class="preprocessor">#if !DISTRHO_PLUGIN_HAS_EXTERNAL_UI</span></div>

  320. <div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  321. <div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;<span class="comment">    * UI Callbacks (optional) */</span></div>

  322. <div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;<span class="comment"></span> </div>

  323. <div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;<span class="comment">   /**</span></div>

  324. <div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;<span class="comment">      UI idle function, called to give idle time to the plugin UI directly from the host.</span></div>

  325. <div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;<span class="comment">      This is called right after OS event handling and Window idle events (within the same cycle).</span></div>

  326. <div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment">      There are no guarantees in terms of timing.</span></div>

  327. <div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment">      @see addIdleCallback(IdleCallback*, uint).</span></div>

  328. <div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="comment">    */</span></div>

  329. <div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> uiIdle() {}</div>

  330. <div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;<span class="comment"></span> </div>

  331. <div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;<span class="comment">   /**</span></div>

  332. <div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;<span class="comment">      Windows focus function, called when the window gains or loses the keyboard focus.</span></div>

  333. <div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;<span class="comment">      This function is for plugin UIs to be able to override Window::onFocus(bool, CrossingMode).</span></div>

  334. <div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;<span class="comment"></span> </div>

  335. <div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;<span class="comment">      The default implementation does nothing.</span></div>

  336. <div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;<span class="comment">    */</span></div>

  337. <div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> uiFocus(<span class="keywordtype">bool</span> focus, DGL_NAMESPACE::CrossingMode mode);</div>

  338. <div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;<span class="comment"></span> </div>

  339. <div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;<span class="comment">   /**</span></div>

  340. <div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;<span class="comment">      Window reshape function, called when the window is resized.</span></div>

  341. <div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;<span class="comment">      This function is for plugin UIs to be able to override Window::onReshape(uint, uint).</span></div>

  342. <div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;<span class="comment"></span> </div>

  343. <div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;<span class="comment">      The plugin UI size will be set right after this function.</span></div>

  344. <div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;<span class="comment">      The default implementation sets up drawing context where necessary.</span></div>

  345. <div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;<span class="comment"></span> </div>

  346. <div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;<span class="comment">      You should almost never need to override this function.</span></div>

  347. <div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;<span class="comment">      The most common exception is custom OpenGL setup, but only really needed for custom OpenGL drawing code.</span></div>

  348. <div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;<span class="comment">    */</span></div>

  349. <div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> uiReshape(uint width, uint height);</div>

  350. <div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;<span class="comment"></span> </div>

  351. <div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;<span class="comment">   /**</span></div>

  352. <div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;<span class="comment">      Window scale factor function, called when the scale factor changes.</span></div>

  353. <div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;<span class="comment">      This function is for plugin UIs to be able to override Window::onScaleFactorChanged(double).</span></div>

  354. <div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;<span class="comment"></span> </div>

  355. <div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;<span class="comment">      The default implementation does nothing.</span></div>

  356. <div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;<span class="comment">      WARNING function needs a proper name</span></div>

  357. <div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;<span class="comment">    */</span></div>

  358. <div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> uiScaleFactorChanged(<span class="keywordtype">double</span> scaleFactor);</div>

  359. <div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160; </div>

  360. <div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;<span class="preprocessor"># ifndef DGL_FILE_BROWSER_DISABLED</span></div>

  361. <div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;<span class="comment">   /**</span></div>

  362. <div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;<span class="comment">      Window file selected function, called when a path is selected by the user, as triggered by openFileBrowser().</span></div>

  363. <div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;<span class="comment">      This function is for plugin UIs to be able to override Window::onFileSelected(const char*).</span></div>

  364. <div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;<span class="comment"></span> </div>

  365. <div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;<span class="comment">      This action happens after the user confirms the action, so the file browser dialog will be closed at this point.</span></div>

  366. <div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;<span class="comment">      The default implementation does nothing.</span></div>

  367. <div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;<span class="comment"></span> </div>

  368. <div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;<span class="comment">      If you need to use files as plugin state, please setup and use DISTRHO_PLUGIN_WANT_STATEFILES instead.</span></div>

  369. <div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;<span class="comment">    */</span></div>

  370. <div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> uiFileBrowserSelected(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename);</div>

  371. <div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;<span class="preprocessor"># endif</span></div>

  372. <div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160; </div>

  373. <div class="line"><a name="l00302"></a><span class="lineno">  302</span>&#160;   <span class="comment">/* --------------------------------------------------------------------------------------------------------</span></div>

  374. <div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;<span class="comment">    * UI Resize Handling, internal */</span></div>

  375. <div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;<span class="comment"></span> </div>

  376. <div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;<span class="comment">   /**</span></div>

  377. <div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;<span class="comment">      OpenGL widget resize function, called when the widget is resized.</span></div>

  378. <div class="line"><a name="l00307"></a><span class="lineno">  307</span>&#160;<span class="comment">      This is overriden here so the host knows when the UI is resized by you.</span></div>

  379. <div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;<span class="comment">      @see Widget::onResize(const ResizeEvent&amp;)</span></div>

  380. <div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;<span class="comment">    */</span></div>

  381. <div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160;    <span class="keywordtype">void</span> onResize(<span class="keyword">const</span> ResizeEvent&amp; ev) <span class="keyword">override</span>;</div>

  382. <div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;<span class="preprocessor">#endif</span></div>

  383. <div class="line"><a name="l00312"></a><span class="lineno">  312</span>&#160; </div>

  384. <div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;    <span class="comment">// -------------------------------------------------------------------------------------------------------</span></div>

  385. <div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160; </div>

  386. <div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;<span class="keyword">private</span>:</div>

  387. <div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;    <span class="keyword">struct </span>PrivateData;</div>

  388. <div class="line"><a name="l00317"></a><span class="lineno">  317</span>&#160;    PrivateData* <span class="keyword">const</span> uiData;</div>

  389. <div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span>DGL_NAMESPACE::PluginWindow;</div>

  390. <div class="line"><a name="l00319"></a><span class="lineno">  319</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span>UIExporter;</div>

  391. <div class="line"><a name="l00320"></a><span class="lineno">  320</span>&#160; </div>

  392. <div class="line"><a name="l00321"></a><span class="lineno">  321</span>&#160;    DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(<a class="code" href="classUI.html">UI</a>)</div>

  393. <div class="line"><a name="l00322"></a><span class="lineno">  322</span>&#160;};</div>

  394. <div class="line"><a name="l00323"></a><span class="lineno">  323</span>&#160;<span class="comment"></span> </div>

  395. <div class="line"><a name="l00324"></a><span class="lineno">  324</span>&#160;<span class="comment">/** @} */</span></div>

  396. <div class="line"><a name="l00325"></a><span class="lineno">  325</span>&#160; </div>

  397. <div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;<span class="comment">/* ------------------------------------------------------------------------------------------------------------</span></div>

  398. <div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;<span class="comment"> * Create UI, entry point */</span></div>

  399. <div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;<span class="comment"></span> </div>

  400. <div class="line"><a name="l00329"></a><span class="lineno">  329</span>&#160;<span class="comment">/**</span></div>

  401. <div class="line"><a name="l00330"></a><span class="lineno">  330</span>&#160;<span class="comment">   @addtogroup EntryPoints</span></div>

  402. <div class="line"><a name="l00331"></a><span class="lineno">  331</span>&#160;<span class="comment">   @{</span></div>

  403. <div class="line"><a name="l00332"></a><span class="lineno">  332</span>&#160;<span class="comment"> */</span></div>

  404. <div class="line"><a name="l00333"></a><span class="lineno">  333</span>&#160;<span class="comment"></span> </div>

  405. <div class="line"><a name="l00334"></a><span class="lineno">  334</span>&#160;<span class="comment">/**</span></div>

  406. <div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;<span class="comment">   createUI.</span></div>

  407. <div class="line"><a name="l00336"></a><span class="lineno">  336</span>&#160;<span class="comment">   @TODO Document this.</span></div>

  408. <div class="line"><a name="l00337"></a><span class="lineno">  337</span>&#160;<span class="comment"> */</span></div>

  409. <div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;<span class="keyword">extern</span> <a class="code" href="classUI.html">UI</a>* <a class="code" href="group__EntryPoints.html#gaad0ced21537a067680729bee6a65d8c8">createUI</a>();</div>

  410. <div class="line"><a name="l00339"></a><span class="lineno">  339</span>&#160;<span class="comment"></span> </div>

  411. <div class="line"><a name="l00340"></a><span class="lineno">  340</span>&#160;<span class="comment">/** @} */</span></div>

  412. <div class="line"><a name="l00341"></a><span class="lineno">  341</span>&#160; </div>

  413. <div class="line"><a name="l00342"></a><span class="lineno">  342</span>&#160;<span class="comment">// -----------------------------------------------------------------------------------------------------------</span></div>

  414. <div class="line"><a name="l00343"></a><span class="lineno">  343</span>&#160; </div>

  415. <div class="line"><a name="l00344"></a><span class="lineno">  344</span>&#160;END_NAMESPACE_DISTRHO</div>

  416. <div class="line"><a name="l00345"></a><span class="lineno">  345</span>&#160; </div>

  417. <div class="line"><a name="l00346"></a><span class="lineno">  346</span>&#160;<span class="preprocessor">#endif // DISTRHO_UI_HPP_INCLUDED</span></div>

  418. </div><!-- fragment --></div><!-- contents -->

  419. <div class="ttc" id="aclassUI_html_aa7277c575b7d0a75475e5a7ae684dc0f"><div class="ttname"><a href="classUI.html#aa7277c575b7d0a75475e5a7ae684dc0f">UI::getNextScaleFactor</a></div><div class="ttdeci">static double getNextScaleFactor() noexcept</div></div>

  420. <div class="ttc" id="aclassUI_html_a1bdc7e158d974e82f0535f1658d66575"><div class="ttname"><a href="classUI.html#a1bdc7e158d974e82f0535f1658d66575">UI::stateChanged</a></div><div class="ttdeci">virtual void stateChanged(const char *key, const char *value)=0</div></div>

  421. <div class="ttc" id="aclassUI_html_a47e7b6111faba049dfee4738d067cc42"><div class="ttname"><a href="classUI.html#a47e7b6111faba049dfee4738d067cc42">UI::~UI</a></div><div class="ttdeci">virtual ~UI()</div></div>

  422. <div class="ttc" id="aclassUI_html_a607ea9f2978605808d8ef5dc3531fae7"><div class="ttname"><a href="classUI.html#a607ea9f2978605808d8ef5dc3531fae7">UI::getForegroundColor</a></div><div class="ttdeci">uint getForegroundColor() const noexcept</div></div>

  423. <div class="ttc" id="aclassUI_html_a2f043dd1b2e179248a19918c5483cfae"><div class="ttname"><a href="classUI.html#a2f043dd1b2e179248a19918c5483cfae">UI::programLoaded</a></div><div class="ttdeci">virtual void programLoaded(uint32_t index)=0</div></div>

  424. <div class="ttc" id="aclassUI_html_a3c47bc4cb3dcc558bbd05791d1cc83f5"><div class="ttname"><a href="classUI.html#a3c47bc4cb3dcc558bbd05791d1cc83f5">UI::getBackgroundColor</a></div><div class="ttdeci">uint getBackgroundColor() const noexcept</div></div>

  425. <div class="ttc" id="aclassUI_html_a973db6e8805f0aa9be3457685564ab8a"><div class="ttname"><a href="classUI.html#a973db6e8805f0aa9be3457685564ab8a">UI::setParameterValue</a></div><div class="ttdeci">void setParameterValue(uint32_t index, float value)</div></div>

  426. <div class="ttc" id="aclassUI_html_a8fe940d56a0c283095e28bbc5806af31"><div class="ttname"><a href="classUI.html#a8fe940d56a0c283095e28bbc5806af31">UI::isResizable</a></div><div class="ttdeci">bool isResizable() const noexcept</div></div>

  427. <div class="ttc" id="aclassUI_html"><div class="ttname"><a href="classUI.html">UI</a></div><div class="ttdef"><b>Definition:</b> DistrhoUI.hpp:71</div></div>

  428. <div class="ttc" id="aclassUI_html_a9d630b2b1696e01015d869a5b434eb6e"><div class="ttname"><a href="classUI.html#a9d630b2b1696e01015d869a5b434eb6e">UI::sendNote</a></div><div class="ttdeci">void sendNote(uint8_t channel, uint8_t note, uint8_t velocity)</div></div>

  429. <div class="ttc" id="aclassUI_html_ab157329c83a4660dd059508dc8d041f5"><div class="ttname"><a href="classUI.html#ab157329c83a4660dd059508dc8d041f5">UI::getNextBundlePath</a></div><div class="ttdeci">static const char * getNextBundlePath() noexcept</div></div>

  430. <div class="ttc" id="aclassUI_html_a97d880182254652f94e7bed355370c07"><div class="ttname"><a href="classUI.html#a97d880182254652f94e7bed355370c07">UI::getSampleRate</a></div><div class="ttdeci">double getSampleRate() const noexcept</div></div>

  431. <div class="ttc" id="aclassUI_html_ad3425075e4a23234a8568d1893b54f22"><div class="ttname"><a href="classUI.html#ad3425075e4a23234a8568d1893b54f22">UI::UI</a></div><div class="ttdeci">UI(uint width=0, uint height=0)</div></div>

  432. <div class="ttc" id="aclassUI_html_a2efcd4f21af0470e91fb6a342d7667a0"><div class="ttname"><a href="classUI.html#a2efcd4f21af0470e91fb6a342d7667a0">UI::editParameter</a></div><div class="ttdeci">void editParameter(uint32_t index, bool started)</div></div>

  433. <div class="ttc" id="agroup__PluginMacros_html_gaf6377f757b9796bd37f7be4e605ccd4a"><div class="ttname"><a href="group__PluginMacros.html#gaf6377f757b9796bd37f7be4e605ccd4a">DISTRHO_UI_CUSTOM_WIDGET_TYPE</a></div><div class="ttdeci">#define DISTRHO_UI_CUSTOM_WIDGET_TYPE</div><div class="ttdef"><b>Definition:</b> DistrhoInfo.hpp:594</div></div>

  434. <div class="ttc" id="aclassUI_html_ac3e98726ca71f95a1e6c867706ebd9be"><div class="ttname"><a href="classUI.html#ac3e98726ca71f95a1e6c867706ebd9be">UI::sampleRateChanged</a></div><div class="ttdeci">virtual void sampleRateChanged(double newSampleRate)</div></div>

  435. <div class="ttc" id="agroup__EntryPoints_html_gaad0ced21537a067680729bee6a65d8c8"><div class="ttname"><a href="group__EntryPoints.html#gaad0ced21537a067680729bee6a65d8c8">createUI</a></div><div class="ttdeci">UI * createUI()</div></div>

  436. <div class="ttc" id="aclassUI_html_a0863a8f7ca7fc7e172e703c58518329f"><div class="ttname"><a href="classUI.html#a0863a8f7ca7fc7e172e703c58518329f">UI::getPluginInstancePointer</a></div><div class="ttdeci">void * getPluginInstancePointer() const noexcept</div></div>

  437. <div class="ttc" id="aclassUI_html_a4630e30aec3f3e7dcfc353ef2807bf56"><div class="ttname"><a href="classUI.html#a4630e30aec3f3e7dcfc353ef2807bf56">UI::getNextWindowId</a></div><div class="ttdeci">static uintptr_t getNextWindowId() noexcept</div></div>

  438. <div class="ttc" id="aclassUI_html_abc94a38afa658849f3fdfd66cd8f5f51"><div class="ttname"><a href="classUI.html#abc94a38afa658849f3fdfd66cd8f5f51">UI::setState</a></div><div class="ttdeci">void setState(const char *key, const char *value)</div></div>

  439. <div class="ttc" id="aclassUI_html_ab3086d302a9685b25abf144ade3e88f6"><div class="ttname"><a href="classUI.html#ab3086d302a9685b25abf144ade3e88f6">UI::parameterChanged</a></div><div class="ttdeci">virtual void parameterChanged(uint32_t index, float value)=0</div></div>

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

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

  442. Generated on Sat Jul 3 2021 23:07:05 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  444. </a> 1.8.17

  445. </small></address>

  446. </body>

  447. </html>