DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
391 Commits
7 Branches
270MB
Tree: e20bc6408d
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e20bc6408d'
${ noResults }
DPF/group__BasePluginStructs.html

147 lines
9.1KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.6"/>

  7. <title>DISTRHO Plugin Framework: Base Plugin Structs</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/search.js"></script>

  13. <script type="text/javascript">

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  17. </head>

  18. <body>

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  20. <div id="titlearea">

  21. <table cellspacing="0" cellpadding="0">

  22.  <tbody>

  23.  <tr style="height: 56px;">

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">DISTRHO Plugin Framework

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

  32. <!-- end header part -->

  33. <!-- Generated by Doxygen 1.8.6 -->

  34. <script type="text/javascript">

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61. </div><!-- top -->

  62. <!-- window showing the filter options -->

  63. <div id="MSearchSelectWindow"

  64.      onmouseover="return searchBox.OnSearchSelectShow()"

  65.      onmouseout="return searchBox.OnSearchSelectHide()"

  66.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  67. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  68. 

  69. <!-- iframe showing the search results (closed by default) -->

  70. <div id="MSearchResultsWindow">

  71. <iframe src="javascript:void(0)" frameborder="0" 

  72.         name="MSearchResults" id="MSearchResults">

  73. </iframe>

  74. </div>

  75. 

  76. <div class="header">

  77.   <div class="summary">

  78. <a href="#nested-classes">Classes</a> &#124;

  79. <a href="#enum-members">Enumerations</a>  </div>

  80.   <div class="headertitle">

  81. <div class="title">Base Plugin Structs</div>  </div>

  82. </div><!--header-->

  83. <div class="contents">

  84. <table class="memberdecls">

  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>

  86. Classes</h2></td></tr>

  87. <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>

  88. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  89. <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>

  90. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  91. <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>

  92. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  93. <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>

  94. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  95. <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>

  96. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  97. <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>

  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  99. <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>

  100. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>

  101. </table><table class="memberdecls">

  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>

  103. Enumerations</h2></td></tr>

  104. <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, 

  105. <a class="el" href="group__BasePluginStructs.html#gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b">kParameterDesignationBypass</a> = 1

  106.  }</td></tr>

  107. <tr class="separator:ga9a7e733c40008f92e96e2ccf24f890de"><td class="memSeparator" colspan="2">&#160;</td></tr>

  108. </table>

  109. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  110. <h2 class="groupheader">Enumeration Type Documentation</h2>

  111. <a class="anchor" id="ga9a7e733c40008f92e96e2ccf24f890de"></a>

  112. <div class="memitem">

  113. <div class="memproto">

  114.       <table class="memname">

  115.         <tr>

  116.           <td class="memname">enum <a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a></td>

  117.         </tr>

  118.       </table>

  119. </div><div class="memdoc">

  120. <p><a class="el" href="structParameter.html">Parameter</a> designation.<br/>

  121. Allows a parameter to be specially designated for a task, like bypass.</p>

  122. <p>Each designation is unique, there must be only one parameter that uses it.<br/>

  123. The use of designated parameters is completely optional.</p>

  124. <dl class="section note"><dt>Note</dt><dd>Designated parameters have strict ranges. </dd></dl>

  125. <dl class="section see"><dt>See Also</dt><dd>ParameterRanges::adjustForDesignation() </dd></dl>

  126. <table class="fieldtable">

  127. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga9a7e733c40008f92e96e2ccf24f890deaee7f64d019ddec5f802c9d53eb033401"></a>kParameterDesignationNull</em>&#160;</td><td class="fielddoc">

  128. <p>Null or unset designation. </p>

  129. </td></tr>

  130. <tr><td class="fieldname"><em><a class="anchor" id="gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b"></a>kParameterDesignationBypass</em>&#160;</td><td class="fielddoc">

  131. <p>Bypass designation.<br/>

  132. When on (&gt; 0.5f), it means the plugin must run in a bypassed state. </p>

  133. </td></tr>

  134. </table>

  135. 

  136. </div>

  137. </div>

  138. </div><!-- contents -->

  139. <!-- start footer part -->

  140. <hr class="footer"/><address class="footer"><small>

  141. Generated on Mon Jun 24 2019 11:54:44 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  142. <img class="footer" src="doxygen.png" alt="doxygen"/>

  143. </a> 1.8.6

  144. </small></address>

  145. </body>

  146. </html>