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 Struct 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&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>
<!-- 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> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structState-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">State Struct Reference<div class="ingroups"><a class="el" href="group__BasePluginStructs.html">Base Plugin Structs</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a>&gt;</code></p>
<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:abd7983c6af263866ab33229e6d835ef1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structState.html#abd7983c6af263866ab33229e6d835ef1">State</a> () noexcept</td></tr>
<tr class="separator:abd7983c6af263866ab33229e6d835ef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:adaa34a729d4e8c0e2e6434b4c4f55fab"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structState.html#adaa34a729d4e8c0e2e6434b4c4f55fab">hints</a></td></tr>
<tr class="separator:adaa34a729d4e8c0e2e6434b4c4f55fab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62474faa50839c3d35fe31b3bf7e39b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structState.html#a62474faa50839c3d35fe31b3bf7e39b0">key</a></td></tr>
<tr class="separator:a62474faa50839c3d35fe31b3bf7e39b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af925c53b4676ed45b8b813424e626c3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structState.html#af925c53b4676ed45b8b813424e626c3e">defaultValue</a></td></tr>
<tr class="separator:af925c53b4676ed45b8b813424e626c3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad29e7e5a872defd5521d69e47b1e9df5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structState.html#ad29e7e5a872defd5521d69e47b1e9df5">label</a></td></tr>
<tr class="separator:ad29e7e5a872defd5521d69e47b1e9df5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb8bee553cefbfe2a495fc391a5f0243"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structState.html#afb8bee553cefbfe2a495fc391a5f0243">description</a></td></tr>
<tr class="separator:afb8bee553cefbfe2a495fc391a5f0243"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="structState.html">State</a>.</p>
<p>In DPF states refer to key:value string pairs, used to store arbitrary non-parameter data.<br  />
By default states are completely internal to the plugin and not visible by the host.<br  />
Flags can be set to allow hosts to see and/or change them.</p>
<p>TODO API under construction </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abd7983c6af263866ab33229e6d835ef1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd7983c6af263866ab33229e6d835ef1">&#9670;&nbsp;</a></span>State()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">State::State </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">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Default constructor for a null state. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adaa34a729d4e8c0e2e6434b4c4f55fab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adaa34a729d4e8c0e2e6434b4c4f55fab">&#9670;&nbsp;</a></span>hints</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t State::hints</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Hints describing this state. </p><dl class="section note"><dt>Note</dt><dd>Changing these hints can break compatibility with previously saved data. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StateHints.html">State Hints</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classString.html">String</a> State::key</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The key or "symbol" of this state.<br  />
A state key is a short restricted name used as a machine and human readable identifier. </p><dl class="section note"><dt>Note</dt><dd><a class="el" href="structState.html">State</a> keys MUST be unique within a plugin instance. TODO define rules for allowed characters, must be usable as URI non-encoded parameters </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classString.html">String</a> State::defaultValue</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The default value of this state.<br  />
Can be left empty if considered a valid initial state. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classString.html">String</a> State::label</td>
        </tr>
      </table>
</div><div class="memdoc">
<p><a class="el" href="classString.html">String</a> representation of this state. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classString.html">String</a> State::description</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>An extensive description/comment about this state. </p><dl class="section note"><dt>Note</dt><dd>This value is optional and only used for LV2. </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>distrho/<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a></li>
</ul>
</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>