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: Parameter Hints</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="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">Parameter Hints</div>  </div>
</div><!--header-->
<div class="contents">

<p>Various parameter hints.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<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>
<tr class="separator:ga04161ef926442aa08ae7aa6847078ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:gaafca30df903781d2e1c2491808e17c8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ga76a82c93efe6ad728c9f0cb4ef33a2b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:gabc539ecbfe420246a33f93aed32b8a3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ga0a3633c93e8589f4b3e6124bb97ad8d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga068de47c587411c9e91ef09f7d800884"><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#ga068de47c587411c9e91ef09f7d800884">kParameterIsTrigger</a> = 0x20 | <a class="el" href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">kParameterIsBoolean</a></td></tr>
<tr class="separator:ga068de47c587411c9e91ef09f7d800884"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<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>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga04161ef926442aa08ae7aa6847078ad9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga04161ef926442aa08ae7aa6847078ad9">&#9670;&nbsp;</a></span>kParameterIsAutomable</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kParameterIsAutomable = 0x01</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<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>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kParameterIsBoolean = 0x02</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structParameter.html">Parameter</a> value is boolean.<br  />
It's always at either minimum or maximum value. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kParameterIsInteger = 0x04</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structParameter.html">Parameter</a> value is integer. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kParameterIsLogarithmic = 0x08</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structParameter.html">Parameter</a> value is logarithmic. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kParameterIsOutput = 0x10</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structParameter.html">Parameter</a> is of output type.<br  />
When unset, parameter is assumed to be of input type.</p>
<p><a class="el" href="structParameter.html">Parameter</a> inputs are changed by the host and typically should not be changed by the plugin.<br  />
One exception is when changing programs, see <a class="el" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">Plugin::loadProgram()</a>.<br  />
The other exception is with parameter change requests, see <a class="el" href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">Plugin::requestParameterValueChange()</a>.<br  />
Outputs are changed by the plugin and never modified by the host.</p>
<p>If you are targetting VST2, make sure to order your parameters so that all inputs are before any outputs. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kParameterIsTrigger = 0x20 | <a class="el" href="group__ParameterHints.html#gaafca30df903781d2e1c2491808e17c8d">kParameterIsBoolean</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structParameter.html">Parameter</a> value is a trigger.<br  />
This means the value resets back to its default after each process/run call.<br  />
Cannot be used for output parameters.</p>
<dl class="section note"><dt>Note</dt><dd>Only officially supported under LV2. For other formats DPF simulates the behaviour. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jul 3 2021 23:07:05 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>