DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!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: State Hints</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&amp;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&amp;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>
</div><!-- top -->
<!-- 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 class="header">
  <div class="summary">
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">State Hints</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga41ada5ff397930abdbf3fbfb1abb6fea"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StateHints.html#ga41ada5ff397930abdbf3fbfb1abb6fea">kStateIsHostReadable</a> = 0x01</td></tr>
<tr class="separator:ga41ada5ff397930abdbf3fbfb1abb6fea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec50a267e06e0299ae9f20fd702e4e60"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StateHints.html#gaec50a267e06e0299ae9f20fd702e4e60">kStateIsHostWritable</a> = 0x02 | <a class="el" href="group__StateHints.html#ga41ada5ff397930abdbf3fbfb1abb6fea">kStateIsHostReadable</a></td></tr>
<tr class="separator:gaec50a267e06e0299ae9f20fd702e4e60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f41b602be8ae24d8ad0cd25deb41922"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StateHints.html#ga5f41b602be8ae24d8ad0cd25deb41922">kStateIsFilenamePath</a> = 0x04 | <a class="el" href="group__StateHints.html#gaec50a267e06e0299ae9f20fd702e4e60">kStateIsHostWritable</a></td></tr>
<tr class="separator:ga5f41b602be8ae24d8ad0cd25deb41922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac892503b0568ceb31f0f7c46af701b0b"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StateHints.html#gac892503b0568ceb31f0f7c46af701b0b">kStateIsBase64Blob</a> = 0x08</td></tr>
<tr class="separator:gac892503b0568ceb31f0f7c46af701b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c0833856c3f88a338bd8ee578ab8b72"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StateHints.html#ga2c0833856c3f88a338bd8ee578ab8b72">kStateIsOnlyForDSP</a> = 0x10</td></tr>
<tr class="separator:ga2c0833856c3f88a338bd8ee578ab8b72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga313547806946a945f31f1a6de14fd12d"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StateHints.html#ga313547806946a945f31f1a6de14fd12d">kStateIsOnlyForUI</a> = 0x20</td></tr>
<tr class="separator:ga313547806946a945f31f1a6de14fd12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Various state hints. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structState.html#adaa34a729d4e8c0e2e6434b4c4f55fab">State::hints</a> </dd></dl>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga41ada5ff397930abdbf3fbfb1abb6fea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga41ada5ff397930abdbf3fbfb1abb6fea">&#9670;&nbsp;</a></span>kStateIsHostReadable</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr const uint32_t kStateIsHostReadable = 0x01</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structState.html">State</a> is visible and readable by hosts that support string-type plugin parameters. </p>

</div>
</div>
<a id="gaec50a267e06e0299ae9f20fd702e4e60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec50a267e06e0299ae9f20fd702e4e60">&#9670;&nbsp;</a></span>kStateIsHostWritable</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr const uint32_t kStateIsHostWritable = 0x02 | <a class="el" href="group__StateHints.html#ga41ada5ff397930abdbf3fbfb1abb6fea">kStateIsHostReadable</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structState.html">State</a> is writable by the host, allowing users to arbitrarily change the state.<br  />
For obvious reasons a writable state is also readable by the host. </p>

</div>
</div>
<a id="ga5f41b602be8ae24d8ad0cd25deb41922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5f41b602be8ae24d8ad0cd25deb41922">&#9670;&nbsp;</a></span>kStateIsFilenamePath</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr const uint32_t kStateIsFilenamePath = 0x04 | <a class="el" href="group__StateHints.html#gaec50a267e06e0299ae9f20fd702e4e60">kStateIsHostWritable</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structState.html">State</a> is a filename path instead of a regular string.<br  />
The readable and writable hints are required for filenames to work, and thus are automatically set. </p>

</div>
</div>
<a id="gac892503b0568ceb31f0f7c46af701b0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac892503b0568ceb31f0f7c46af701b0b">&#9670;&nbsp;</a></span>kStateIsBase64Blob</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr const uint32_t kStateIsBase64Blob = 0x08</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structState.html">State</a> is a base64 encoded string. </p>

</div>
</div>
<a id="ga2c0833856c3f88a338bd8ee578ab8b72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c0833856c3f88a338bd8ee578ab8b72">&#9670;&nbsp;</a></span>kStateIsOnlyForDSP</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr const uint32_t kStateIsOnlyForDSP = 0x10</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structState.html">State</a> is for Plugin/DSP side only, meaning there is never a need to notify the <a class="el" href="classUI.html">UI</a> when it changes. </p>

</div>
</div>
<a id="ga313547806946a945f31f1a6de14fd12d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga313547806946a945f31f1a6de14fd12d">&#9670;&nbsp;</a></span>kStateIsOnlyForUI</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr const uint32_t kStateIsOnlyForUI = 0x20</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structState.html">State</a> is for <a class="el" href="classUI.html">UI</a> side only.<br  />
If the DSP and <a class="el" href="classUI.html">UI</a> are separate and the <a class="el" href="classUI.html">UI</a> is not available, this property won't be saved. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>