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: Extra Plugin Macros</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="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">Extra Plugin Macros</div>  </div>
</div><!--header-->
<div class="contents">

<p>C Macros to customize DPF behaviour.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga692c508f53e1eb8747e261d2435490b7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ExtraPluginMacros.html#ga692c508f53e1eb8747e261d2435490b7">DPF_RUNTIME_TESTING</a></td></tr>
<tr class="separator:ga692c508f53e1eb8747e261d2435490b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e6df7bd76cecd30e3762a58e29cd011"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ExtraPluginMacros.html#ga9e6df7bd76cecd30e3762a58e29cd011">DPF_VST_SHOW_PARAMETER_OUTPUTS</a></td></tr>
<tr class="separator:ga9e6df7bd76cecd30e3762a58e29cd011"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga01988e3c3664d33fac3b7958715b00fd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ExtraPluginMacros.html#ga01988e3c3664d33fac3b7958715b00fd">DGL_USE_OPENGL3</a></td></tr>
<tr class="separator:ga01988e3c3664d33fac3b7958715b00fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga89155a96125944b4e4eb32d69d65272e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ExtraPluginMacros.html#ga89155a96125944b4e4eb32d69d65272e">VESTIGE_HEADER</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:ga89155a96125944b4e4eb32d69d65272e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>C Macros to customize DPF behaviour. </p>
<p>These are macros that do not set plugin features or information, but instead change DPF internals.<br  />
They are all optional, none are enabled by default.</p>
<p>Unless stated otherwise, values are assumed to be a simple/empty define. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga692c508f53e1eb8747e261d2435490b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga692c508f53e1eb8747e261d2435490b7">&#9670;&nbsp;</a></span>DPF_RUNTIME_TESTING</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DPF_RUNTIME_TESTING</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Whether to enable runtime plugin tests.<br  />
This will check, during initialization of the plugin, if parameters, programs and states are setup properly.<br  />
Useful to enable as part of CI, can safely be skipped.<br  />
Under DPF makefiles this can be enabled by using <code>make DPF_RUNTIME_TESTING=true</code>.</p>
<dl class="section note"><dt>Note</dt><dd>Some checks are only available with the GCC compiler, for detecting if a virtual function has been reimplemented. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DPF_VST_SHOW_PARAMETER_OUTPUTS</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Whether to show parameter outputs in the VST2 plugins.<br  />
This is disabled (unset) by default, as the VST2 format has no notion of read-only parameters. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DGL_USE_OPENGL3</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Whether to use OpenGL3 instead of the default OpenGL2 compatility profile. Under DPF makefiles this can be enabled by using <code>make USE_OPENGL3=true</code> on the dgl build step.</p>
<dl class="section note"><dt>Note</dt><dd>This is experimental and incomplete, contributions are welcome and appreciated. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define VESTIGE_HEADER&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Whether to use the GPLv2+ vestige header instead of the official Steinberg VST2 SDK.<br  />
This is a boolean, and enabled (set to 1) by default.<br  />
Set this to 0 in order to create non-GPL binaries. (but then at your own discretion in regards to Steinberg licensing)<br  />
When set to 0, DPF will import the VST2 definitions from <code>"vst/aeffectx.h"</code> (not shipped with DPF). </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Sep 22 2021 13:19:09 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>