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: ParameterEnumerationValues 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="structParameterEnumerationValues-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ParameterEnumerationValues 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:a8f8bc997ceb137ec7ead3b0468f6b0ef"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValues.html#a8f8bc997ceb137ec7ead3b0468f6b0ef">ParameterEnumerationValues</a> () noexcept</td></tr>
<tr class="separator:a8f8bc997ceb137ec7ead3b0468f6b0ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08cf9d8ef22b0ddd6fb288307a3ff1bf"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValues.html#a08cf9d8ef22b0ddd6fb288307a3ff1bf">ParameterEnumerationValues</a> (uint8_t c, bool r, <a class="el" href="structParameterEnumerationValue.html">ParameterEnumerationValue</a> *v) noexcept</td></tr>
<tr class="separator:a08cf9d8ef22b0ddd6fb288307a3ff1bf"><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:afd740dd45384c493801405a1c1c3d51d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValues.html#afd740dd45384c493801405a1c1c3d51d">count</a></td></tr>
<tr class="separator:afd740dd45384c493801405a1c1c3d51d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a014ebcacbe68c3f77f2f8ac9ffe3cd6f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValues.html#a014ebcacbe68c3f77f2f8ac9ffe3cd6f">restrictedMode</a></td></tr>
<tr class="separator:a014ebcacbe68c3f77f2f8ac9ffe3cd6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae101471c5d819624398001c84c534b7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structParameterEnumerationValue.html">ParameterEnumerationValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValues.html#ae101471c5d819624398001c84c534b7a">values</a></td></tr>
<tr class="separator:ae101471c5d819624398001c84c534b7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf882508439c41eb4c1bc38237dcc976"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValues.html#acf882508439c41eb4c1bc38237dcc976">deleteLater</a></td></tr>
<tr class="separator:acf882508439c41eb4c1bc38237dcc976"><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>Details around parameter enumeration values.<br  />
Wraps <a class="el" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a> and provides a few extra details to the host about these values. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8f8bc997ceb137ec7ead3b0468f6b0ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f8bc997ceb137ec7ead3b0468f6b0ef">&#9670;&nbsp;</a></span>ParameterEnumerationValues() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr ParameterEnumerationValues::ParameterEnumerationValues </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">constexpr</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Default constructor, for zero enumeration values. </p>

</div>
</div>
<a id="a08cf9d8ef22b0ddd6fb288307a3ff1bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08cf9d8ef22b0ddd6fb288307a3ff1bf">&#9670;&nbsp;</a></span>ParameterEnumerationValues() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr ParameterEnumerationValues::ParameterEnumerationValues </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>c</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structParameterEnumerationValue.html">ParameterEnumerationValue</a> *&#160;</td>
          <td class="paramname"><em>v</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor using custom values.<br  />
When using this constructor the pointer to @values MUST have been statically declared.<br  />
It will not be automatically deleted later. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ParameterEnumerationValues::count</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Number of elements allocated in @values. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ParameterEnumerationValues::restrictedMode</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Whether the host is to be restricted to only use enumeration values.</p>
<dl class="section note"><dt>Note</dt><dd>This mode is only a hint! Not all hosts and plugin formats support this mode. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structParameterEnumerationValue.html">ParameterEnumerationValue</a>* ParameterEnumerationValues::values</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Array of @ParameterEnumerationValue items.<br  />
When assining this pointer manually, it must be allocated on the heap with <code>new <a class="el" href="structParameterEnumerationValue.html">ParameterEnumerationValue</a>[count]</code>.<br  />
The array pointer will be automatically deleted later unless <code>deleteLater</code> is set to false. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ParameterEnumerationValues::deleteLater</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Whether to take ownership of the <code>values</code> pointer.<br  />
Defaults to true unless stated otherwise. </p>

</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>