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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DISTRHO Plugin Framework: Base Plugin Structs</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.8.17 -->
<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');
/* @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="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">Base Plugin Structs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioPort.html">AudioPort</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterRanges.html">ParameterRanges</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValue.html">ParameterEnumerationValue</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html">Parameter</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMidiEvent.html">MidiEvent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition.html">TimePosition</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga9a7e733c40008f92e96e2ccf24f890de"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> { <a class="el" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">kParameterDesignationNull</a> = 0, 
<a class="el" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b">kParameterDesignationBypass</a> = 1, 
<a class="el" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">kParameterDesignationNull</a> = 0, 
<a class="el" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b">kParameterDesignationBypass</a> = 1
 }</td></tr>
<tr class="separator:ga9a7e733c40008f92e96e2ccf24f890de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9a7e733c40008f92e96e2ccf24f890de"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> { <a class="el" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">kParameterDesignationNull</a> = 0, 
<a class="el" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b">kParameterDesignationBypass</a> = 1, 
<a class="el" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401">kParameterDesignationNull</a> = 0, 
<a class="el" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b">kParameterDesignationBypass</a> = 1
 }</td></tr>
<tr class="separator:ga9a7e733c40008f92e96e2ccf24f890de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga9a7e733c40008f92e96e2ccf24f890de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a7e733c40008f92e96e2ccf24f890de">&#9670;&nbsp;</a></span>ParameterDesignation <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p><a class="el" href="structParameter.html">Parameter</a> designation.<br  />
Allows a parameter to be specially designated for a task, like bypass.</p>
<p>Each designation is unique, there must be only one parameter that uses it.<br  />
The use of designated parameters is completely optional.</p>
<dl class="section note"><dt>Note</dt><dd>Designated parameters have strict ranges. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>ParameterRanges::adjustForDesignation() </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401"></a>kParameterDesignationNull&#160;</td><td class="fielddoc"><p>Null or unset designation. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b"></a>kParameterDesignationBypass&#160;</td><td class="fielddoc"><p>Bypass designation.<br  />
When on (&gt; 0.5f), it means the plugin must run in a bypassed state. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401"></a>kParameterDesignationNull&#160;</td><td class="fielddoc"><p>Null or unset designation. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b"></a>kParameterDesignationBypass&#160;</td><td class="fielddoc"><p>Bypass designation.<br  />
When on (&gt; 0.5f), it means the plugin must run in a bypassed state. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga9a7e733c40008f92e96e2ccf24f890de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a7e733c40008f92e96e2ccf24f890de">&#9670;&nbsp;</a></span>ParameterDesignation <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p><a class="el" href="structParameter.html">Parameter</a> designation.<br  />
Allows a parameter to be specially designated for a task, like bypass.</p>
<p>Each designation is unique, there must be only one parameter that uses it.<br  />
The use of designated parameters is completely optional.</p>
<dl class="section note"><dt>Note</dt><dd>Designated parameters have strict ranges. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>ParameterRanges::adjustForDesignation() </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401"></a>kParameterDesignationNull&#160;</td><td class="fielddoc"><p>Null or unset designation. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b"></a>kParameterDesignationBypass&#160;</td><td class="fielddoc"><p>Bypass designation.<br  />
When on (&gt; 0.5f), it means the plugin must run in a bypassed state. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401"></a>kParameterDesignationNull&#160;</td><td class="fielddoc"><p>Null or unset designation. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b"></a>kParameterDesignationBypass&#160;</td><td class="fielddoc"><p>Bypass designation.<br  />
When on (&gt; 0.5f), it means the plugin must run in a bypassed state. </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 18 2021 11:21:11 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>