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.
389 Commits
7 Branches
59MB
Tree: 51186ba54a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '51186ba54a'
${ noResults }
DPF/group__BasePluginStructs.html

131 lines
7.3KB
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.13"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

  23.   <td id="projectalign" style="padding-left: 0.5em;">

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

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

  32. <!-- Generated by Doxygen 1.8.13 -->

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

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

  35. </script>

  36. <script type="text/javascript" src="menudata.js"></script>

  37. <script type="text/javascript" src="menu.js"></script>

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

  39. $(function() {

  40.   initMenu('',true,false,'search.php','Search');

  41.   $(document).ready(function() { init_search(); });

  42. });

  43. </script>

  44. <div id="main-nav"></div>

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

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

  47. <div id="MSearchSelectWindow"

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

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

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

  51. </div>

  52. 

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

  54. <div id="MSearchResultsWindow">

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

  56.         name="MSearchResults" id="MSearchResults">

  57. </iframe>

  58. </div>

  59. 

  60. <div class="header">

  61.   <div class="summary">

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

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

  64.   <div class="headertitle">

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

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

  67. <div class="contents">

  68. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  90.  }</td></tr>

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

  92. </table>

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

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

  95. <a id="ga9a7e733c40008f92e96e2ccf24f890de"></a>

  96. <h2 class="memtitle"><span class="permalink"><a href="#ga9a7e733c40008f92e96e2ccf24f890de">&#9670;&nbsp;</a></span>ParameterDesignation</h2>

  97. 

  98. <div class="memitem">

  99. <div class="memproto">

  100.       <table class="memname">

  101.         <tr>

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

  103.         </tr>

  104.       </table>

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

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

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

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

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

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

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

  112. <table class="fieldtable">

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

  114. </td></tr>

  115. <tr><td class="fieldname"><a id="gga9a7e733c40008f92e96e2ccf24f890dea0623d4fc45bc45f4afad0f752955c50b"></a>kParameterDesignationBypass&#160;</td><td class="fielddoc"><p>Bypass designation.<br />

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

  117. </td></tr>

  118. </table>

  119. 

  120. </div>

  121. </div>

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

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

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

  125. Generated on Sun Apr 7 2019 05:47:58 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  127. </a> 1.8.13

  128. </small></address>

  129. </body>

  130. </html>