|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.9.1"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>DISTRHO Plugin Framework: UI Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">DISTRHO Plugin Framework
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.1 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="#friends">Friends</a> |
- <a href="classUI-members.html">List of all members</a> </div>
- <div class="headertitle">
- <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>
- </div><!--header-->
- <div class="contents">
-
- <p><code>#include <<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for UI:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="classUI.png" alt=""/>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a844584caf362e72c0def15ff3477187f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a844584caf362e72c0def15ff3477187f">UI</a> (uint width=0, uint height=0, bool automaticallyScaleAndSetAsMinimumSize=false)</td></tr>
- <tr class="separator:a844584caf362e72c0def15ff3477187f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9b9e41e6021cc07a25b50539e74daaae"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a9b9e41e6021cc07a25b50539e74daaae">~UI</a> () override</td></tr>
- <tr class="separator:a9b9e41e6021cc07a25b50539e74daaae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8fe940d56a0c283095e28bbc5806af31"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a8fe940d56a0c283095e28bbc5806af31">isResizable</a> () const noexcept</td></tr>
- <tr class="separator:a8fe940d56a0c283095e28bbc5806af31"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3c47bc4cb3dcc558bbd05791d1cc83f5"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a3c47bc4cb3dcc558bbd05791d1cc83f5">getBackgroundColor</a> () const noexcept</td></tr>
- <tr class="separator:a3c47bc4cb3dcc558bbd05791d1cc83f5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a607ea9f2978605808d8ef5dc3531fae7"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a607ea9f2978605808d8ef5dc3531fae7">getForegroundColor</a> () const noexcept</td></tr>
- <tr class="separator:a607ea9f2978605808d8ef5dc3531fae7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a97d880182254652f94e7bed355370c07"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a97d880182254652f94e7bed355370c07">getSampleRate</a> () const noexcept</td></tr>
- <tr class="separator:a97d880182254652f94e7bed355370c07"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3359930fbeb2670230e617d430ecd67e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a3359930fbeb2670230e617d430ecd67e">getBundlePath</a> () const noexcept</td></tr>
- <tr class="separator:a3359930fbeb2670230e617d430ecd67e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2efcd4f21af0470e91fb6a342d7667a0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a2efcd4f21af0470e91fb6a342d7667a0">editParameter</a> (uint32_t index, bool started)</td></tr>
- <tr class="separator:a2efcd4f21af0470e91fb6a342d7667a0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a973db6e8805f0aa9be3457685564ab8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a973db6e8805f0aa9be3457685564ab8a">setParameterValue</a> (uint32_t index, float value)</td></tr>
- <tr class="separator:a973db6e8805f0aa9be3457685564ab8a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abc94a38afa658849f3fdfd66cd8f5f51"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#abc94a38afa658849f3fdfd66cd8f5f51">setState</a> (const char *key, const char *value)</td></tr>
- <tr class="separator:abc94a38afa658849f3fdfd66cd8f5f51"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a53aebb0a0a4ee5d321503d2ba8d7a631"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a53aebb0a0a4ee5d321503d2ba8d7a631">requestStateFile</a> (const char *key)</td></tr>
- <tr class="separator:a53aebb0a0a4ee5d321503d2ba8d7a631"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9d630b2b1696e01015d869a5b434eb6e"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:a9d630b2b1696e01015d869a5b434eb6e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0863a8f7ca7fc7e172e703c58518329f"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a0863a8f7ca7fc7e172e703c58518329f">getPluginInstancePointer</a> () const noexcept</td></tr>
- <tr class="separator:a0863a8f7ca7fc7e172e703c58518329f"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:ab157329c83a4660dd059508dc8d041f5"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ab157329c83a4660dd059508dc8d041f5">getNextBundlePath</a> () noexcept</td></tr>
- <tr class="separator:ab157329c83a4660dd059508dc8d041f5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa7277c575b7d0a75475e5a7ae684dc0f"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#aa7277c575b7d0a75475e5a7ae684dc0f">getNextScaleFactor</a> () noexcept</td></tr>
- <tr class="separator:aa7277c575b7d0a75475e5a7ae684dc0f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4630e30aec3f3e7dcfc353ef2807bf56"><td class="memItemLeft" align="right" valign="top">static uintptr_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a4630e30aec3f3e7dcfc353ef2807bf56">getNextWindowId</a> () noexcept</td></tr>
- <tr class="separator:a4630e30aec3f3e7dcfc353ef2807bf56"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:ab3086d302a9685b25abf144ade3e88f6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ab3086d302a9685b25abf144ade3e88f6">parameterChanged</a> (uint32_t index, float value)=0</td></tr>
- <tr class="separator:ab3086d302a9685b25abf144ade3e88f6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2f043dd1b2e179248a19918c5483cfae"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a2f043dd1b2e179248a19918c5483cfae">programLoaded</a> (uint32_t index)=0</td></tr>
- <tr class="separator:a2f043dd1b2e179248a19918c5483cfae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1bdc7e158d974e82f0535f1658d66575"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a1bdc7e158d974e82f0535f1658d66575">stateChanged</a> (const char *key, const char *value)=0</td></tr>
- <tr class="separator:a1bdc7e158d974e82f0535f1658d66575"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac3e98726ca71f95a1e6c867706ebd9be"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ac3e98726ca71f95a1e6c867706ebd9be">sampleRateChanged</a> (double newSampleRate)</td></tr>
- <tr class="separator:ac3e98726ca71f95a1e6c867706ebd9be"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af8de639088f3b2d42c266a2d2d6719da"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#af8de639088f3b2d42c266a2d2d6719da">uiIdle</a> ()</td></tr>
- <tr class="separator:af8de639088f3b2d42c266a2d2d6719da"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad89b09ef4e8129d72ff3b3cb8716a96b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#ad89b09ef4e8129d72ff3b3cb8716a96b">uiScaleFactorChanged</a> (double scaleFactor)</td></tr>
- <tr class="separator:ad89b09ef4e8129d72ff3b3cb8716a96b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3d499674a620c1ce3b6e1dbded9f09c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUI.html#a3d499674a620c1ce3b6e1dbded9f09c4">sizeChanged</a> (uint width, uint height) override</td></tr>
- <tr class="separator:a3d499674a620c1ce3b6e1dbded9f09c4"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
- Friends</h2></td></tr>
- <tr class="memitem:a248da0691bb4a09193e912d67ab7552e"><td class="memItemLeft" align="right" valign="top"><a id="a248da0691bb4a09193e912d67ab7552e"></a>
- class </td><td class="memItemRight" valign="bottom"><b>PluginWindow</b></td></tr>
- <tr class="separator:a248da0691bb4a09193e912d67ab7552e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf9db2e4a604d26b79f28734659b7409"><td class="memItemLeft" align="right" valign="top"><a id="aaf9db2e4a604d26b79f28734659b7409"></a>
- class </td><td class="memItemRight" valign="bottom"><b>UIExporter</b></td></tr>
- <tr class="separator:aaf9db2e4a604d26b79f28734659b7409"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <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>
- <dl class="section note"><dt>Note</dt><dd>You must call setSize during construction, @TODO Detailed information about this class. </dd></dl>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a844584caf362e72c0def15ff3477187f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a844584caf362e72c0def15ff3477187f">◆ </a></span>UI()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UI::UI </td>
- <td>(</td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>width</em> = <code>0</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>height</em> = <code>0</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>automaticallyScaleAndSetAsMinimumSize</em> = <code>false</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <p>When <em>automaticallyScale</em> is set to true, DPF will automatically scale up the <a class="el" href="classUI.html">UI</a> to fit the host/desktop scale factor.<br />
- It assumes aspect ratio is meant to be kept. Manually call setGeometryConstraints instead if keeping <a class="el" href="classUI.html">UI</a> aspect ratio is not required. </p>
-
- </div>
- </div>
- <a id="a9b9e41e6021cc07a25b50539e74daaae"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9b9e41e6021cc07a25b50539e74daaae">◆ </a></span>~UI()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">UI::~UI </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Destructor. </p>
-
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a8fe940d56a0c283095e28bbc5806af31"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8fe940d56a0c283095e28bbc5806af31">◆ </a></span>isResizable()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool UI::isResizable </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <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>
-
- </div>
- </div>
- <a id="a3c47bc4cb3dcc558bbd05791d1cc83f5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3c47bc4cb3dcc558bbd05791d1cc83f5">◆ </a></span>getBackgroundColor()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint UI::getBackgroundColor </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <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 >> 24) & 0xff;</div>
- <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> green = (bgColor >> 16) & 0xff;</div>
- <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> blue = (bgColor >> 8) & 0xff;</div>
- </div><!-- fragment -->
- </div>
- </div>
- <a id="a607ea9f2978605808d8ef5dc3531fae7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a607ea9f2978605808d8ef5dc3531fae7">◆ </a></span>getForegroundColor()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">uint UI::getForegroundColor </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <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 >> 24) & 0xff;</div>
- <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> green = (fgColor >> 16) & 0xff;</div>
- <div class="line"><span class="keyword">const</span> <span class="keywordtype">int</span> blue = (fgColor >> 8) & 0xff;</div>
- </div><!-- fragment -->
- </div>
- </div>
- <a id="a97d880182254652f94e7bed355370c07"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a97d880182254652f94e7bed355370c07">◆ </a></span>getSampleRate()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">double UI::getSampleRate </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
-
- </div>
- </div>
- <a id="a3359930fbeb2670230e617d430ecd67e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3359930fbeb2670230e617d430ecd67e">◆ </a></span>getBundlePath()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const char* UI::getBundlePath </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the bundle path where the <a class="el" href="classUI.html">UI</a> resides.<br />
- Can return null if the <a class="el" href="classUI.html">UI</a> is not available in a bundle (if it is a single binary). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PluginRelatedUtilities.html#ga59aac78ab7142a37a7a2c5f0c7fd2a62">getBinaryFilename</a> </dd></dl>
-
- </div>
- </div>
- <a id="a2efcd4f21af0470e91fb6a342d7667a0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2efcd4f21af0470e91fb6a342d7667a0">◆ </a></span>editParameter()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void UI::editParameter </td>
- <td>(</td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>index</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>started</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>editParameter.</p>
- <p>Touch/pressed-down event. Lets the host know the user is tweaking a parameter. Required in some hosts to record automation. </p>
-
- </div>
- </div>
- <a id="a973db6e8805f0aa9be3457685564ab8a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a973db6e8805f0aa9be3457685564ab8a">◆ </a></span>setParameterValue()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void UI::setParameterValue </td>
- <td>(</td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>index</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>setParameterValue.</p>
- <p>Change a parameter value in the <a class="el" href="classPlugin.html">Plugin</a>. </p>
-
- </div>
- </div>
- <a id="abc94a38afa658849f3fdfd66cd8f5f51"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abc94a38afa658849f3fdfd66cd8f5f51">◆ </a></span>setState()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void UI::setState </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>setState. @TODO Document this. </p>
-
- </div>
- </div>
- <a id="a53aebb0a0a4ee5d321503d2ba8d7a631"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a53aebb0a0a4ee5d321503d2ba8d7a631">◆ </a></span>requestStateFile()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool UI::requestStateFile </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>key</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Request a new file from the host, matching the properties of a state key.<br />
- This will use the native host file browser if available, otherwise a DPF built-in file browser is used.<br />
- Response will be sent asynchronously to stateChanged, with the matching key and the new file as the value.<br />
- It is not possible to know if the action was cancelled by the user.</p>
- <dl class="section return"><dt>Returns</dt><dd>Success if a file-browser was opened, otherwise false. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>You cannot request more than one file at a time. </dd></dl>
-
- </div>
- </div>
- <a id="a9d630b2b1696e01015d869a5b434eb6e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9d630b2b1696e01015d869a5b434eb6e">◆ </a></span>sendNote()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void UI::sendNote </td>
- <td>(</td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>channel</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>note</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>velocity</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Send a single MIDI note from the <a class="el" href="classUI.html">UI</a> to the plugin DSP side.<br />
- A note with zero velocity will be sent as note-off (MIDI 0x80), otherwise note-on (MIDI 0x90). </p>
-
- </div>
- </div>
- <a id="a0863a8f7ca7fc7e172e703c58518329f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0863a8f7ca7fc7e172e703c58518329f">◆ </a></span>getPluginInstancePointer()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void* UI::getPluginInstancePointer </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>getPluginInstancePointer. @TODO Document this. </p>
-
- </div>
- </div>
- <a id="ab157329c83a4660dd059508dc8d041f5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab157329c83a4660dd059508dc8d041f5">◆ </a></span>getNextBundlePath()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static const char* UI::getNextBundlePath </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
-
- </div>
- </div>
- <a id="aa7277c575b7d0a75475e5a7ae684dc0f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa7277c575b7d0a75475e5a7ae684dc0f">◆ </a></span>getNextScaleFactor()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static double UI::getNextScaleFactor </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
-
- </div>
- </div>
- <a id="a4630e30aec3f3e7dcfc353ef2807bf56"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4630e30aec3f3e7dcfc353ef2807bf56">◆ </a></span>getNextWindowId()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static uintptr_t UI::getNextWindowId </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
-
- </div>
- </div>
- <a id="ab3086d302a9685b25abf144ade3e88f6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab3086d302a9685b25abf144ade3e88f6">◆ </a></span>parameterChanged()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void UI::parameterChanged </td>
- <td>(</td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>index</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A parameter has changed on the plugin side.<br />
- This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about parameter changes. </p>
-
- </div>
- </div>
- <a id="a2f043dd1b2e179248a19918c5483cfae"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2f043dd1b2e179248a19918c5483cfae">◆ </a></span>programLoaded()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void UI::programLoaded </td>
- <td>(</td>
- <td class="paramtype">uint32_t </td>
- <td class="paramname"><em>index</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A program has been loaded on the plugin side.<br />
- This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about program changes. </p>
-
- </div>
- </div>
- <a id="a1bdc7e158d974e82f0535f1658d66575"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1bdc7e158d974e82f0535f1658d66575">◆ </a></span>stateChanged()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void UI::stateChanged </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A state has changed on the plugin side.<br />
- This is called by the host to inform the <a class="el" href="classUI.html">UI</a> about state changes. </p>
-
- </div>
- </div>
- <a id="ac3e98726ca71f95a1e6c867706ebd9be"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac3e98726ca71f95a1e6c867706ebd9be">◆ </a></span>sampleRateChanged()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void UI::sampleRateChanged </td>
- <td>(</td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>newSampleRate</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
-
- </div>
- </div>
- <a id="af8de639088f3b2d42c266a2d2d6719da"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af8de639088f3b2d42c266a2d2d6719da">◆ </a></span>uiIdle()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void UI::uiIdle </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p><a class="el" href="classUI.html">UI</a> idle function, called to give idle time to the plugin <a class="el" href="classUI.html">UI</a> directly from the host. This is called right after OS event handling and <a class="el" href="classWindow.html">Window</a> idle events (within the same cycle). There are no guarantees in terms of timing. </p><dl class="section see"><dt>See also</dt><dd>addIdleCallback(IdleCallback*, uint). </dd></dl>
-
- </div>
- </div>
- <a id="ad89b09ef4e8129d72ff3b3cb8716a96b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad89b09ef4e8129d72ff3b3cb8716a96b">◆ </a></span>uiScaleFactorChanged()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void UI::uiScaleFactorChanged </td>
- <td>(</td>
- <td class="paramtype">double </td>
- <td class="paramname"><em>scaleFactor</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p><a class="el" href="classWindow.html">Window</a> scale factor function, called when the scale factor changes. This function is for plugin UIs to be able to override <a class="el" href="classWindow.html#a306742ddc21c7c41f59b41e5761a38c7">Window::onScaleFactorChanged(double)</a>.</p>
- <p>The default implementation does nothing. WARNING function needs a proper name </p>
-
- </div>
- </div>
- <a id="a3d499674a620c1ce3b6e1dbded9f09c4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3d499674a620c1ce3b6e1dbded9f09c4">◆ </a></span>sizeChanged()</h2>
-
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void UI::sizeChanged </td>
- <td>(</td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint </td>
- <td class="paramname"><em>height</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>External <a class="el" href="classWindow.html">Window</a> resize function, called when the window is resized. This is overriden here so the host knows when the <a class="el" href="classUI.html">UI</a> is resized by you. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classExternalWindow.html#aba350e1f737b68e51bfe8018bded6e45">ExternalWindow::sizeChanged(uint,uint)</a> </dd></dl>
-
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>distrho/<a class="el" href="DistrhoUI_8hpp_source.html">DistrhoUI.hpp</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
- </small></address>
- </body>
- </html>
|