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.
386 Commits
7 Branches
57MB
Tree: 16812ef750
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '16812ef750'
${ noResults }
DPF/group__ParameterHints.html

220 lines
9.4KB
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.11"/>

  7. <title>DISTRHO Plugin Framework: Parameter Hints</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/searchdata.js"></script>

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

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

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

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

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

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

  34. <!-- Generated by Doxygen 1.8.11 -->

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

  41.       <li class="current"><a href="modules.html"><span>Modules</span></a></li>

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

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

  44.       <li>

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

  46.         <span class="left">

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

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

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

  50.                alt=""/>

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

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

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

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

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

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

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

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

  64. <div id="MSearchSelectWindow"

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

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

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

  68. </div>

  69. 

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

  71. <div id="MSearchResultsWindow">

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

  73.         name="MSearchResults" id="MSearchResults">

  74. </iframe>

  75. </div>

  76. 

  77. <div class="header">

  78.   <div class="summary">

  79. <a href="#var-members">Variables</a>  </div>

  80.   <div class="headertitle">

  81. <div class="title">Parameter Hints</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="var-members"></a>

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

  87. <tr class="memitem:ga04161ef926442aa08ae7aa6847078ad9"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#ga04161ef926442aa08ae7aa6847078ad9">kParameterIsAutomable</a> = 0x01</td></tr>

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

  89. <tr class="memitem:gaafca30df903781d2e1c2491808e17c8d"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">kParameterIsBoolean</a> = 0x02</td></tr>

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

  91. <tr class="memitem:ga76a82c93efe6ad728c9f0cb4ef33a2b9"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#ga76a82c93efe6ad728c9f0cb4ef33a2b9">kParameterIsInteger</a> = 0x04</td></tr>

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

  93. <tr class="memitem:gabc539ecbfe420246a33f93aed32b8a3b"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#gabc539ecbfe420246a33f93aed32b8a3b">kParameterIsLogarithmic</a> = 0x08</td></tr>

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

  95. <tr class="memitem:ga0a3633c93e8589f4b3e6124bb97ad8d4"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ParameterHints.html#ga0a3633c93e8589f4b3e6124bb97ad8d4">kParameterIsOutput</a> = 0x10</td></tr>

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

  97. </table>

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

  99. <p>Various parameter hints. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">Parameter::hints</a> </dd></dl>

  100. <h2 class="groupheader">Variable Documentation</h2>

  101. <a class="anchor" id="ga04161ef926442aa08ae7aa6847078ad9"></a>

  102. <div class="memitem">

  103. <div class="memproto">

  104. <table class="mlabels">

  105.   <tr>

  106.   <td class="mlabels-left">

  107.       <table class="memname">

  108.         <tr>

  109.           <td class="memname">const uint32_t kParameterIsAutomable = 0x01</td>

  110.         </tr>

  111.       </table>

  112.   </td>

  113.   <td class="mlabels-right">

  114. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  115.   </tr>

  116. </table>

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

  118. <p><a class="el" href="structParameter.html">Parameter</a> is automable (real-time safe). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a6911a881fabb9eca9daf0eadbaad8599">Plugin::setParameterValue(uint32_t, float)</a> </dd></dl>

  119. 

  120. </div>

  121. </div>

  122. <a class="anchor" id="gaafca30df903781d2e1c2491808e17c8d"></a>

  123. <div class="memitem">

  124. <div class="memproto">

  125. <table class="mlabels">

  126.   <tr>

  127.   <td class="mlabels-left">

  128.       <table class="memname">

  129.         <tr>

  130.           <td class="memname">const uint32_t kParameterIsBoolean = 0x02</td>

  131.         </tr>

  132.       </table>

  133.   </td>

  134.   <td class="mlabels-right">

  135. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  136.   </tr>

  137. </table>

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

  139. <p><a class="el" href="structParameter.html">Parameter</a> value is boolean.<br />

  140. It's always at either minimum or maximum value. </p>

  141. 

  142. </div>

  143. </div>

  144. <a class="anchor" id="ga76a82c93efe6ad728c9f0cb4ef33a2b9"></a>

  145. <div class="memitem">

  146. <div class="memproto">

  147. <table class="mlabels">

  148.   <tr>

  149.   <td class="mlabels-left">

  150.       <table class="memname">

  151.         <tr>

  152.           <td class="memname">const uint32_t kParameterIsInteger = 0x04</td>

  153.         </tr>

  154.       </table>

  155.   </td>

  156.   <td class="mlabels-right">

  157. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  158.   </tr>

  159. </table>

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

  161. <p><a class="el" href="structParameter.html">Parameter</a> value is integer. </p>

  162. 

  163. </div>

  164. </div>

  165. <a class="anchor" id="gabc539ecbfe420246a33f93aed32b8a3b"></a>

  166. <div class="memitem">

  167. <div class="memproto">

  168. <table class="mlabels">

  169.   <tr>

  170.   <td class="mlabels-left">

  171.       <table class="memname">

  172.         <tr>

  173.           <td class="memname">const uint32_t kParameterIsLogarithmic = 0x08</td>

  174.         </tr>

  175.       </table>

  176.   </td>

  177.   <td class="mlabels-right">

  178. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  179.   </tr>

  180. </table>

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

  182. <p><a class="el" href="structParameter.html">Parameter</a> value is logarithmic. </p>

  183. 

  184. </div>

  185. </div>

  186. <a class="anchor" id="ga0a3633c93e8589f4b3e6124bb97ad8d4"></a>

  187. <div class="memitem">

  188. <div class="memproto">

  189. <table class="mlabels">

  190.   <tr>

  191.   <td class="mlabels-left">

  192.       <table class="memname">

  193.         <tr>

  194.           <td class="memname">const uint32_t kParameterIsOutput = 0x10</td>

  195.         </tr>

  196.       </table>

  197.   </td>

  198.   <td class="mlabels-right">

  199. <span class="mlabels"><span class="mlabel">static</span></span>  </td>

  200.   </tr>

  201. </table>

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

  203. <p><a class="el" href="structParameter.html">Parameter</a> is of output type.<br />

  204. When unset, parameter is assumed to be of input type.</p>

  205. <p><a class="el" href="structParameter.html">Parameter</a> inputs are changed by the host and must not be changed by the plugin.<br />

  206. The only exception being when changing programs, see <a class="el" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">Plugin::loadProgram()</a>.<br />

  207. Outputs are changed by the plugin and never modified by the host. </p>

  208. 

  209. </div>

  210. </div>

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

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

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

  214. Generated on Tue Jun 7 2016 14:04:29 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  216. </a> 1.8.11

  217. </small></address>

  218. </body>

  219. </html>