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

587 lines
26KB
Raw Blame History 

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

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

  3. <head>

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

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

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

  7. <title>DISTRHO Plugin Framework: UI Class Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/search.js"></script>

  13. <script type="text/javascript">

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  17. </head>

  18. <body>

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  20. <div id="titlearea">

  21. <table cellspacing="0" cellpadding="0">

  22.  <tbody>

  23.  <tr style="height: 56px;">

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">DISTRHO Plugin Framework

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

  32. <!-- end header part -->

  33. <!-- Generated by Doxygen 1.8.6 -->

  34. <script type="text/javascript">

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  64.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>

  65.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>

  66.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  67.     </ul>

  68.   </div>

  69. <!-- window showing the filter options -->

  70. <div id="MSearchSelectWindow"

  71.      onmouseover="return searchBox.OnSearchSelectShow()"

  72.      onmouseout="return searchBox.OnSearchSelectHide()"

  73.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  74. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  75. 

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

  77. <div id="MSearchResultsWindow">

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

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

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

  84. <div class="header">

  85.   <div class="summary">

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

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

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

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

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

  91.   <div class="headertitle">

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

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

  94. <div class="contents">

  95. 

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

  97. <div class="dynheader">

  98. Inheritance diagram for UI:</div>

  99. <div class="dyncontent">

  100.  <div class="center">

  101.   <img src="classUI.png" usemap="#UI_map" alt=""/>

  102.   <map id="UI_map" name="UI_map">

  103. </map>

  104.  </div></div>

  105. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  150. <tr class="memitem:a09076cbeb5a44f946ba377c83859bfd3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09076cbeb5a44f946ba377c83859bfd3"></a>

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

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

  153. </table>

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

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

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

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

  158. <a class="anchor" id="ad3425075e4a23234a8568d1893b54f22"></a>

  159. <div class="memitem">

  160. <div class="memproto">

  161.       <table class="memname">

  162.         <tr>

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

  164.           <td>(</td>

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

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

  167.         </tr>

  168.         <tr>

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

  170.           <td></td>

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

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

  173.         </tr>

  174.         <tr>

  175.           <td></td>

  176.           <td>)</td>

  177.           <td></td><td></td>

  178.         </tr>

  179.       </table>

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

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

  182. 

  183. </div>

  184. </div>

  185. <a class="anchor" id="a47e7b6111faba049dfee4738d067cc42"></a>

  186. <div class="memitem">

  187. <div class="memproto">

  188. <table class="mlabels">

  189.   <tr>

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

  191.       <table class="memname">

  192.         <tr>

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

  194.           <td>(</td>

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

  196.           <td></td>

  197.         </tr>

  198.       </table>

  199.   </td>

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

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

  202.   </tr>

  203. </table>

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

  205. <p>Destructor. </p>

  206. 

  207. </div>

  208. </div>

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

  210. <a class="anchor" id="a97d880182254652f94e7bed355370c07"></a>

  211. <div class="memitem">

  212. <div class="memproto">

  213. <table class="mlabels">

  214.   <tr>

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

  216.       <table class="memname">

  217.         <tr>

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

  219.           <td>(</td>

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

  221.           <td> const</td>

  222.         </tr>

  223.       </table>

  224.   </td>

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

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

  227.   </tr>

  228. </table>

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

  230. <p>Get the current sample rate used in plugin processing. </p>

  231. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classUI.html#ac3e98726ca71f95a1e6c867706ebd9be">sampleRateChanged(double)</a> </dd></dl>

  232. 

  233. </div>

  234. </div>

  235. <a class="anchor" id="a2efcd4f21af0470e91fb6a342d7667a0"></a>

  236. <div class="memitem">

  237. <div class="memproto">

  238.       <table class="memname">

  239.         <tr>

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

  241.           <td>(</td>

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

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

  244.         </tr>

  245.         <tr>

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

  247.           <td></td>

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

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

  250.         </tr>

  251.         <tr>

  252.           <td></td>

  253.           <td>)</td>

  254.           <td></td><td></td>

  255.         </tr>

  256.       </table>

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

  258. <p>editParameter.</p>

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

  260. 

  261. </div>

  262. </div>

  263. <a class="anchor" id="a973db6e8805f0aa9be3457685564ab8a"></a>

  264. <div class="memitem">

  265. <div class="memproto">

  266.       <table class="memname">

  267.         <tr>

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

  269.           <td>(</td>

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

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

  272.         </tr>

  273.         <tr>

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

  275.           <td></td>

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

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

  278.         </tr>

  279.         <tr>

  280.           <td></td>

  281.           <td>)</td>

  282.           <td></td><td></td>

  283.         </tr>

  284.       </table>

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

  286. <p>setParameterValue.</p>

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

  288. 

  289. </div>

  290. </div>

  291. <a class="anchor" id="abc94a38afa658849f3fdfd66cd8f5f51"></a>

  292. <div class="memitem">

  293. <div class="memproto">

  294.       <table class="memname">

  295.         <tr>

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

  297.           <td>(</td>

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

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

  300.         </tr>

  301.         <tr>

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

  303.           <td></td>

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

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

  306.         </tr>

  307.         <tr>

  308.           <td></td>

  309.           <td>)</td>

  310.           <td></td><td></td>

  311.         </tr>

  312.       </table>

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

  314. <p>setState.  Document this. </p>

  315. 

  316. </div>

  317. </div>

  318. <a class="anchor" id="a9d630b2b1696e01015d869a5b434eb6e"></a>

  319. <div class="memitem">

  320. <div class="memproto">

  321.       <table class="memname">

  322.         <tr>

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

  324.           <td>(</td>

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

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

  327.         </tr>

  328.         <tr>

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

  330.           <td></td>

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

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

  333.         </tr>

  334.         <tr>

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

  336.           <td></td>

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

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

  339.         </tr>

  340.         <tr>

  341.           <td></td>

  342.           <td>)</td>

  343.           <td></td><td></td>

  344.         </tr>

  345.       </table>

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

  347. <p>sendNote.  Document this. </p>

  348. <dl class="section note"><dt>Note</dt><dd>Work in progress. Implemented for DSSI and LV2 formats. </dd></dl>

  349. 

  350. </div>

  351. </div>

  352. <a class="anchor" id="a0863a8f7ca7fc7e172e703c58518329f"></a>

  353. <div class="memitem">

  354. <div class="memproto">

  355. <table class="mlabels">

  356.   <tr>

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

  358.       <table class="memname">

  359.         <tr>

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

  361.           <td>(</td>

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

  363.           <td> const</td>

  364.         </tr>

  365.       </table>

  366.   </td>

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

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

  369.   </tr>

  370. </table>

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

  372. <p>getPluginInstancePointer.  Document this. </p>

  373. 

  374. </div>

  375. </div>

  376. <a class="anchor" id="ab157329c83a4660dd059508dc8d041f5"></a>

  377. <div class="memitem">

  378. <div class="memproto">

  379. <table class="mlabels">

  380.   <tr>

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

  382.       <table class="memname">

  383.         <tr>

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

  385.           <td>(</td>

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

  387.           <td></td>

  388.         </tr>

  389.       </table>

  390.   </td>

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

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

  393.   </tr>

  394. </table>

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

  396. <p>Get the bundle path that will be used for the next <a class="el" href="classUI.html">UI</a>. </p>

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

  398. 

  399. </div>

  400. </div>

  401. <a class="anchor" id="aa7277c575b7d0a75475e5a7ae684dc0f"></a>

  402. <div class="memitem">

  403. <div class="memproto">

  404. <table class="mlabels">

  405.   <tr>

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

  407.       <table class="memname">

  408.         <tr>

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

  410.           <td>(</td>

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

  412.           <td></td>

  413.         </tr>

  414.       </table>

  415.   </td>

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

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

  418.   </tr>

  419. </table>

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

  421. <p>Get the scale factor that will be used for the next <a class="el" href="classUI.html">UI</a>. </p>

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

  423. 

  424. </div>

  425. </div>

  426. <a class="anchor" id="a4630e30aec3f3e7dcfc353ef2807bf56"></a>

  427. <div class="memitem">

  428. <div class="memproto">

  429. <table class="mlabels">

  430.   <tr>

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

  432.       <table class="memname">

  433.         <tr>

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

  435.           <td>(</td>

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

  437.           <td></td>

  438.         </tr>

  439.       </table>

  440.   </td>

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

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

  443.   </tr>

  444. </table>

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

  446. <p>Get the <a class="el" href="classWindow.html">Window</a> Id that will be used for the next created window. </p>

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

  448. 

  449. </div>

  450. </div>

  451. <a class="anchor" id="ab3086d302a9685b25abf144ade3e88f6"></a>

  452. <div class="memitem">

  453. <div class="memproto">

  454. <table class="mlabels">

  455.   <tr>

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

  457.       <table class="memname">

  458.         <tr>

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

  460.           <td>(</td>

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

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

  463.         </tr>

  464.         <tr>

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

  466.           <td></td>

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

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

  469.         </tr>

  470.         <tr>

  471.           <td></td>

  472.           <td>)</td>

  473.           <td></td><td></td>

  474.         </tr>

  475.       </table>

  476.   </td>

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

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

  479.   </tr>

  480. </table>

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

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

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

  484. 

  485. </div>

  486. </div>

  487. <a class="anchor" id="a2f043dd1b2e179248a19918c5483cfae"></a>

  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">virtual void UI::programLoaded </td>

  496.           <td>(</td>

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

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

  499.           <td></td>

  500.         </tr>

  501.       </table>

  502.   </td>

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

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

  505.   </tr>

  506. </table>

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

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

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

  510. 

  511. </div>

  512. </div>

  513. <a class="anchor" id="a1bdc7e158d974e82f0535f1658d66575"></a>

  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">virtual void UI::stateChanged </td>

  522.           <td>(</td>

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

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

  525.         </tr>

  526.         <tr>

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

  528.           <td></td>

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

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

  531.         </tr>

  532.         <tr>

  533.           <td></td>

  534.           <td>)</td>

  535.           <td></td><td></td>

  536.         </tr>

  537.       </table>

  538.   </td>

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

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

  541.   </tr>

  542. </table>

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

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

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

  546. 

  547. </div>

  548. </div>

  549. <a class="anchor" id="ac3e98726ca71f95a1e6c867706ebd9be"></a>

  550. <div class="memitem">

  551. <div class="memproto">

  552. <table class="mlabels">

  553.   <tr>

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

  555.       <table class="memname">

  556.         <tr>

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

  558.           <td>(</td>

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

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

  561.           <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">virtual</span></span>  </td>

  567.   </tr>

  568. </table>

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

  570. <p>Optional callback to inform the <a class="el" href="classUI.html">UI</a> about a sample rate change on the plugin side. </p>

  571. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classUI.html#a97d880182254652f94e7bed355370c07">getSampleRate()</a> </dd></dl>

  572. 

  573. </div>

  574. </div>

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

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

  577. </ul>

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

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

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

  581. Generated on Mon Jun 24 2019 11:56:27 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  583. </a> 1.8.6

  584. </small></address>

  585. </body>

  586. </html>