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.
398 Commits
7 Branches
89MB
Tree: e82edc537a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e82edc537a'
${ noResults }
DPF/classUI.html

680 lines
31KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.17"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: 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.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><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;

  67. <a href="#pro-methods">Protected Member Functions</a> &#124;

  68. <a href="#friends">Friends</a> &#124;

  69. <a href="classUI-members.html">List of all members</a>  </div>

  70.   <div class="headertitle">

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

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

  73. <div class="contents">

  74. 

  75. <p><code>#include &lt;<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a>&gt;</code></p>

  76. <div class="dynheader">

  77. Inheritance diagram for UI:</div>

  78. <div class="dyncontent">

  79.  <div class="center">

  80.   <img src="classUI.png" alt=""/>

  81.  </div></div>

  82. <table class="memberdecls">

  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  84. Public Member Functions</h2></td></tr>

  85. <tr class="memitem:ad3425075e4a23234a8568d1893b54f22"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ad3425075e4a23234a8568d1893b54f22">UI</a> (uint width=0, uint height=0)</td></tr>

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

  87. <tr class="memitem:a47e7b6111faba049dfee4738d067cc42"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a47e7b6111faba049dfee4738d067cc42">~UI</a> ()</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  107. </table><table class="memberdecls">

  108. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>

  109. Static Public Member Functions</h2></td></tr>

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

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

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

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

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

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

  116. </table><table class="memberdecls">

  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>

  118. Protected Member Functions</h2></td></tr>

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

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

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

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

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

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

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

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

  127. </table><table class="memberdecls">

  128. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  129. Friends</h2></td></tr>

  130. <tr class="memitem:a248da0691bb4a09193e912d67ab7552e"><td class="memItemLeft" align="right" valign="top"><a id="a248da0691bb4a09193e912d67ab7552e"></a>

  131. class&#160;</td><td class="memItemRight" valign="bottom"><b>PluginWindow</b></td></tr>

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

  133. <tr class="memitem:aaf9db2e4a604d26b79f28734659b7409"><td class="memItemLeft" align="right" valign="top"><a id="aaf9db2e4a604d26b79f28734659b7409"></a>

  134. class&#160;</td><td class="memItemRight" valign="bottom"><b>UIExporter</b></td></tr>

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

  136. </table>

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

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

  139. <dl class="section note"><dt>Note</dt><dd>You must call setSize during construction, @TODO Detailed information about this class. </dd></dl>

  140. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  141. <a id="ad3425075e4a23234a8568d1893b54f22"></a>

  142. <h2 class="memtitle"><span class="permalink"><a href="#ad3425075e4a23234a8568d1893b54f22">&#9670;&nbsp;</a></span>UI()</h2>

  143. 

  144. <div class="memitem">

  145. <div class="memproto">

  146.       <table class="memname">

  147.         <tr>

  148.           <td class="memname">UI::UI </td>

  149.           <td>(</td>

  150.           <td class="paramtype">uint&#160;</td>

  151.           <td class="paramname"><em>width</em> = <code>0</code>, </td>

  152.         </tr>

  153.         <tr>

  154.           <td class="paramkey"></td>

  155.           <td></td>

  156.           <td class="paramtype">uint&#160;</td>

  157.           <td class="paramname"><em>height</em> = <code>0</code>&#160;</td>

  158.         </tr>

  159.         <tr>

  160.           <td></td>

  161.           <td>)</td>

  162.           <td></td><td></td>

  163.         </tr>

  164.       </table>

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

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

  167. 

  168. </div>

  169. </div>

  170. <a id="a47e7b6111faba049dfee4738d067cc42"></a>

  171. <h2 class="memtitle"><span class="permalink"><a href="#a47e7b6111faba049dfee4738d067cc42">&#9670;&nbsp;</a></span>~UI()</h2>

  172. 

  173. <div class="memitem">

  174. <div class="memproto">

  175. <table class="mlabels">

  176.   <tr>

  177.   <td class="mlabels-left">

  178.       <table class="memname">

  179.         <tr>

  180.           <td class="memname">virtual UI::~UI </td>

  181.           <td>(</td>

  182.           <td class="paramname"></td><td>)</td>

  183.           <td></td>

  184.         </tr>

  185.       </table>

  186.   </td>

  187.   <td class="mlabels-right">

  188. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>

  189.   </tr>

  190. </table>

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

  192. <p>Destructor. </p>

  193. 

  194. </div>

  195. </div>

  196. <h2 class="groupheader">Member Function Documentation</h2>

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

  198. <h2 class="memtitle"><span class="permalink"><a href="#a8fe940d56a0c283095e28bbc5806af31">&#9670;&nbsp;</a></span>isResizable()</h2>

  199. 

  200. <div class="memitem">

  201. <div class="memproto">

  202. <table class="mlabels">

  203.   <tr>

  204.   <td class="mlabels-left">

  205.       <table class="memname">

  206.         <tr>

  207.           <td class="memname">bool UI::isResizable </td>

  208.           <td>(</td>

  209.           <td class="paramname"></td><td>)</td>

  210.           <td> const</td>

  211.         </tr>

  212.       </table>

  213.   </td>

  214.   <td class="mlabels-right">

  215. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  216.   </tr>

  217. </table>

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

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

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

  221. 

  222. </div>

  223. </div>

  224. <a id="a3c47bc4cb3dcc558bbd05791d1cc83f5"></a>

  225. <h2 class="memtitle"><span class="permalink"><a href="#a3c47bc4cb3dcc558bbd05791d1cc83f5">&#9670;&nbsp;</a></span>getBackgroundColor()</h2>

  226. 

  227. <div class="memitem">

  228. <div class="memproto">

  229. <table class="mlabels">

  230.   <tr>

  231.   <td class="mlabels-left">

  232.       <table class="memname">

  233.         <tr>

  234.           <td class="memname">uint UI::getBackgroundColor </td>

  235.           <td>(</td>

  236.           <td class="paramname"></td><td>)</td>

  237.           <td> const</td>

  238.         </tr>

  239.       </table>

  240.   </td>

  241.   <td class="mlabels-right">

  242. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  243.   </tr>

  244. </table>

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

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

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

  248. <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> green = (bgColor &gt;&gt; 16) &amp; 0xff;</div>

  249. <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> blue  = (bgColor &gt;&gt;  8) &amp; 0xff;</div>

  250. </div><!-- fragment --> 

  251. </div>

  252. </div>

  253. <a id="a607ea9f2978605808d8ef5dc3531fae7"></a>

  254. <h2 class="memtitle"><span class="permalink"><a href="#a607ea9f2978605808d8ef5dc3531fae7">&#9670;&nbsp;</a></span>getForegroundColor()</h2>

  255. 

  256. <div class="memitem">

  257. <div class="memproto">

  258. <table class="mlabels">

  259.   <tr>

  260.   <td class="mlabels-left">

  261.       <table class="memname">

  262.         <tr>

  263.           <td class="memname">uint UI::getForegroundColor </td>

  264.           <td>(</td>

  265.           <td class="paramname"></td><td>)</td>

  266.           <td> const</td>

  267.         </tr>

  268.       </table>

  269.   </td>

  270.   <td class="mlabels-right">

  271. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  272.   </tr>

  273. </table>

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

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

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

  277. <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> green = (fgColor &gt;&gt; 16) &amp; 0xff;</div>

  278. <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> blue  = (fgColor &gt;&gt;  8) &amp; 0xff;</div>

  279. </div><!-- fragment --> 

  280. </div>

  281. </div>

  282. <a id="a97d880182254652f94e7bed355370c07"></a>

  283. <h2 class="memtitle"><span class="permalink"><a href="#a97d880182254652f94e7bed355370c07">&#9670;&nbsp;</a></span>getSampleRate()</h2>

  284. 

  285. <div class="memitem">

  286. <div class="memproto">

  287. <table class="mlabels">

  288.   <tr>

  289.   <td class="mlabels-left">

  290.       <table class="memname">

  291.         <tr>

  292.           <td class="memname">double UI::getSampleRate </td>

  293.           <td>(</td>

  294.           <td class="paramname"></td><td>)</td>

  295.           <td> const</td>

  296.         </tr>

  297.       </table>

  298.   </td>

  299.   <td class="mlabels-right">

  300. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  301.   </tr>

  302. </table>

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

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

  305. 

  306. </div>

  307. </div>

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

  309. <h2 class="memtitle"><span class="permalink"><a href="#a2efcd4f21af0470e91fb6a342d7667a0">&#9670;&nbsp;</a></span>editParameter()</h2>

  310. 

  311. <div class="memitem">

  312. <div class="memproto">

  313.       <table class="memname">

  314.         <tr>

  315.           <td class="memname">void UI::editParameter </td>

  316.           <td>(</td>

  317.           <td class="paramtype">uint32_t&#160;</td>

  318.           <td class="paramname"><em>index</em>, </td>

  319.         </tr>

  320.         <tr>

  321.           <td class="paramkey"></td>

  322.           <td></td>

  323.           <td class="paramtype">bool&#160;</td>

  324.           <td class="paramname"><em>started</em>&#160;</td>

  325.         </tr>

  326.         <tr>

  327.           <td></td>

  328.           <td>)</td>

  329.           <td></td><td></td>

  330.         </tr>

  331.       </table>

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

  333. <p>editParameter.</p>

  334. <p>Touch/pressed-down event. Lets the host know the user is tweaking a parameter. Required in some hosts to record automation. </p>

  335. 

  336. </div>

  337. </div>

  338. <a id="a973db6e8805f0aa9be3457685564ab8a"></a>

  339. <h2 class="memtitle"><span class="permalink"><a href="#a973db6e8805f0aa9be3457685564ab8a">&#9670;&nbsp;</a></span>setParameterValue()</h2>

  340. 

  341. <div class="memitem">

  342. <div class="memproto">

  343.       <table class="memname">

  344.         <tr>

  345.           <td class="memname">void UI::setParameterValue </td>

  346.           <td>(</td>

  347.           <td class="paramtype">uint32_t&#160;</td>

  348.           <td class="paramname"><em>index</em>, </td>

  349.         </tr>

  350.         <tr>

  351.           <td class="paramkey"></td>

  352.           <td></td>

  353.           <td class="paramtype">float&#160;</td>

  354.           <td class="paramname"><em>value</em>&#160;</td>

  355.         </tr>

  356.         <tr>

  357.           <td></td>

  358.           <td>)</td>

  359.           <td></td><td></td>

  360.         </tr>

  361.       </table>

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

  363. <p>setParameterValue.</p>

  364. <p>Change a parameter value in the <a class="el" href="classPlugin.html">Plugin</a>. </p>

  365. 

  366. </div>

  367. </div>

  368. <a id="abc94a38afa658849f3fdfd66cd8f5f51"></a>

  369. <h2 class="memtitle"><span class="permalink"><a href="#abc94a38afa658849f3fdfd66cd8f5f51">&#9670;&nbsp;</a></span>setState()</h2>

  370. 

  371. <div class="memitem">

  372. <div class="memproto">

  373.       <table class="memname">

  374.         <tr>

  375.           <td class="memname">void UI::setState </td>

  376.           <td>(</td>

  377.           <td class="paramtype">const char *&#160;</td>

  378.           <td class="paramname"><em>key</em>, </td>

  379.         </tr>

  380.         <tr>

  381.           <td class="paramkey"></td>

  382.           <td></td>

  383.           <td class="paramtype">const char *&#160;</td>

  384.           <td class="paramname"><em>value</em>&#160;</td>

  385.         </tr>

  386.         <tr>

  387.           <td></td>

  388.           <td>)</td>

  389.           <td></td><td></td>

  390.         </tr>

  391.       </table>

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

  393. <p>setState. @TODO Document this. </p>

  394. 

  395. </div>

  396. </div>

  397. <a id="a9d630b2b1696e01015d869a5b434eb6e"></a>

  398. <h2 class="memtitle"><span class="permalink"><a href="#a9d630b2b1696e01015d869a5b434eb6e">&#9670;&nbsp;</a></span>sendNote()</h2>

  399. 

  400. <div class="memitem">

  401. <div class="memproto">

  402.       <table class="memname">

  403.         <tr>

  404.           <td class="memname">void UI::sendNote </td>

  405.           <td>(</td>

  406.           <td class="paramtype">uint8_t&#160;</td>

  407.           <td class="paramname"><em>channel</em>, </td>

  408.         </tr>

  409.         <tr>

  410.           <td class="paramkey"></td>

  411.           <td></td>

  412.           <td class="paramtype">uint8_t&#160;</td>

  413.           <td class="paramname"><em>note</em>, </td>

  414.         </tr>

  415.         <tr>

  416.           <td class="paramkey"></td>

  417.           <td></td>

  418.           <td class="paramtype">uint8_t&#160;</td>

  419.           <td class="paramname"><em>velocity</em>&#160;</td>

  420.         </tr>

  421.         <tr>

  422.           <td></td>

  423.           <td>)</td>

  424.           <td></td><td></td>

  425.         </tr>

  426.       </table>

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

  428. <p>Send a single MIDI note from the <a class="el" href="classUI.html">UI</a> to the plugin DSP side.<br  />

  429. A note with zero velocity will be sent as note-off (MIDI 0x80), otherwise note-on (MIDI 0x90). </p>

  430. 

  431. </div>

  432. </div>

  433. <a id="a0863a8f7ca7fc7e172e703c58518329f"></a>

  434. <h2 class="memtitle"><span class="permalink"><a href="#a0863a8f7ca7fc7e172e703c58518329f">&#9670;&nbsp;</a></span>getPluginInstancePointer()</h2>

  435. 

  436. <div class="memitem">

  437. <div class="memproto">

  438. <table class="mlabels">

  439.   <tr>

  440.   <td class="mlabels-left">

  441.       <table class="memname">

  442.         <tr>

  443.           <td class="memname">void* UI::getPluginInstancePointer </td>

  444.           <td>(</td>

  445.           <td class="paramname"></td><td>)</td>

  446.           <td> const</td>

  447.         </tr>

  448.       </table>

  449.   </td>

  450.   <td class="mlabels-right">

  451. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  452.   </tr>

  453. </table>

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

  455. <p>getPluginInstancePointer. @TODO Document this. </p>

  456. 

  457. </div>

  458. </div>

  459. <a id="ab157329c83a4660dd059508dc8d041f5"></a>

  460. <h2 class="memtitle"><span class="permalink"><a href="#ab157329c83a4660dd059508dc8d041f5">&#9670;&nbsp;</a></span>getNextBundlePath()</h2>

  461. 

  462. <div class="memitem">

  463. <div class="memproto">

  464. <table class="mlabels">

  465.   <tr>

  466.   <td class="mlabels-left">

  467.       <table class="memname">

  468.         <tr>

  469.           <td class="memname">static const char* UI::getNextBundlePath </td>

  470.           <td>(</td>

  471.           <td class="paramname"></td><td>)</td>

  472.           <td></td>

  473.         </tr>

  474.       </table>

  475.   </td>

  476.   <td class="mlabels-right">

  477. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>

  478.   </tr>

  479. </table>

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

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

  482. 

  483. </div>

  484. </div>

  485. <a id="aa7277c575b7d0a75475e5a7ae684dc0f"></a>

  486. <h2 class="memtitle"><span class="permalink"><a href="#aa7277c575b7d0a75475e5a7ae684dc0f">&#9670;&nbsp;</a></span>getNextScaleFactor()</h2>

  487. 

  488. <div class="memitem">

  489. <div class="memproto">

  490. <table class="mlabels">

  491.   <tr>

  492.   <td class="mlabels-left">

  493.       <table class="memname">

  494.         <tr>

  495.           <td class="memname">static double UI::getNextScaleFactor </td>

  496.           <td>(</td>

  497.           <td class="paramname"></td><td>)</td>

  498.           <td></td>

  499.         </tr>

  500.       </table>

  501.   </td>

  502.   <td class="mlabels-right">

  503. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>

  504.   </tr>

  505. </table>

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

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

  508. 

  509. </div>

  510. </div>

  511. <a id="a4630e30aec3f3e7dcfc353ef2807bf56"></a>

  512. <h2 class="memtitle"><span class="permalink"><a href="#a4630e30aec3f3e7dcfc353ef2807bf56">&#9670;&nbsp;</a></span>getNextWindowId()</h2>

  513. 

  514. <div class="memitem">

  515. <div class="memproto">

  516. <table class="mlabels">

  517.   <tr>

  518.   <td class="mlabels-left">

  519.       <table class="memname">

  520.         <tr>

  521.           <td class="memname">static uintptr_t UI::getNextWindowId </td>

  522.           <td>(</td>

  523.           <td class="paramname"></td><td>)</td>

  524.           <td></td>

  525.         </tr>

  526.       </table>

  527.   </td>

  528.   <td class="mlabels-right">

  529. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>

  530.   </tr>

  531. </table>

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

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

  534. 

  535. </div>

  536. </div>

  537. <a id="ab3086d302a9685b25abf144ade3e88f6"></a>

  538. <h2 class="memtitle"><span class="permalink"><a href="#ab3086d302a9685b25abf144ade3e88f6">&#9670;&nbsp;</a></span>parameterChanged()</h2>

  539. 

  540. <div class="memitem">

  541. <div class="memproto">

  542. <table class="mlabels">

  543.   <tr>

  544.   <td class="mlabels-left">

  545.       <table class="memname">

  546.         <tr>

  547.           <td class="memname">virtual void UI::parameterChanged </td>

  548.           <td>(</td>

  549.           <td class="paramtype">uint32_t&#160;</td>

  550.           <td class="paramname"><em>index</em>, </td>

  551.         </tr>

  552.         <tr>

  553.           <td class="paramkey"></td>

  554.           <td></td>

  555.           <td class="paramtype">float&#160;</td>

  556.           <td class="paramname"><em>value</em>&#160;</td>

  557.         </tr>

  558.         <tr>

  559.           <td></td>

  560.           <td>)</td>

  561.           <td></td><td></td>

  562.         </tr>

  563.       </table>

  564.   </td>

  565.   <td class="mlabels-right">

  566. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  567.   </tr>

  568. </table>

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

  570. <p>A parameter has changed on the plugin side.<br  />

  571. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about parameter changes. </p>

  572. 

  573. </div>

  574. </div>

  575. <a id="a2f043dd1b2e179248a19918c5483cfae"></a>

  576. <h2 class="memtitle"><span class="permalink"><a href="#a2f043dd1b2e179248a19918c5483cfae">&#9670;&nbsp;</a></span>programLoaded()</h2>

  577. 

  578. <div class="memitem">

  579. <div class="memproto">

  580. <table class="mlabels">

  581.   <tr>

  582.   <td class="mlabels-left">

  583.       <table class="memname">

  584.         <tr>

  585.           <td class="memname">virtual void UI::programLoaded </td>

  586.           <td>(</td>

  587.           <td class="paramtype">uint32_t&#160;</td>

  588.           <td class="paramname"><em>index</em></td><td>)</td>

  589.           <td></td>

  590.         </tr>

  591.       </table>

  592.   </td>

  593.   <td class="mlabels-right">

  594. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  595.   </tr>

  596. </table>

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

  598. <p>A program has been loaded on the plugin side.<br  />

  599. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about program changes. </p>

  600. 

  601. </div>

  602. </div>

  603. <a id="a1bdc7e158d974e82f0535f1658d66575"></a>

  604. <h2 class="memtitle"><span class="permalink"><a href="#a1bdc7e158d974e82f0535f1658d66575">&#9670;&nbsp;</a></span>stateChanged()</h2>

  605. 

  606. <div class="memitem">

  607. <div class="memproto">

  608. <table class="mlabels">

  609.   <tr>

  610.   <td class="mlabels-left">

  611.       <table class="memname">

  612.         <tr>

  613.           <td class="memname">virtual void UI::stateChanged </td>

  614.           <td>(</td>

  615.           <td class="paramtype">const char *&#160;</td>

  616.           <td class="paramname"><em>key</em>, </td>

  617.         </tr>

  618.         <tr>

  619.           <td class="paramkey"></td>

  620.           <td></td>

  621.           <td class="paramtype">const char *&#160;</td>

  622.           <td class="paramname"><em>value</em>&#160;</td>

  623.         </tr>

  624.         <tr>

  625.           <td></td>

  626.           <td>)</td>

  627.           <td></td><td></td>

  628.         </tr>

  629.       </table>

  630.   </td>

  631.   <td class="mlabels-right">

  632. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  633.   </tr>

  634. </table>

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

  636. <p>A state has changed on the plugin side.<br  />

  637. This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about state changes. </p>

  638. 

  639. </div>

  640. </div>

  641. <a id="ac3e98726ca71f95a1e6c867706ebd9be"></a>

  642. <h2 class="memtitle"><span class="permalink"><a href="#ac3e98726ca71f95a1e6c867706ebd9be">&#9670;&nbsp;</a></span>sampleRateChanged()</h2>

  643. 

  644. <div class="memitem">

  645. <div class="memproto">

  646. <table class="mlabels">

  647.   <tr>

  648.   <td class="mlabels-left">

  649.       <table class="memname">

  650.         <tr>

  651.           <td class="memname">virtual void UI::sampleRateChanged </td>

  652.           <td>(</td>

  653.           <td class="paramtype">double&#160;</td>

  654.           <td class="paramname"><em>newSampleRate</em></td><td>)</td>

  655.           <td></td>

  656.         </tr>

  657.       </table>

  658.   </td>

  659.   <td class="mlabels-right">

  660. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  661.   </tr>

  662. </table>

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

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

  665. 

  666. </div>

  667. </div>

  668. <hr/>The documentation for this class was generated from the following file:<ul>

  669. <li>distrho/<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a></li>

  670. </ul>

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

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

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

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

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

  676. </a> 1.8.17

  677. </small></address>

  678. </body>

  679. </html>