302 lines
19 KiB
HTML
302 lines
19 KiB
HTML
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>VST 3 SDK: Macros for defining the compile time class factory</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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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" />
|
|
<link href="smtg_extra.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">VST 3 SDK<span id="projectnumber"> VST 3.8</span>
|
|
</div>
|
|
<div id="projectbrief">SDK for developing VST plug-in</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('group__constexprClassFactoryMacros.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#define-members">Macros</a> </div>
|
|
<div class="headertitle"><div class="title">Macros for defining the compile time class factory<div class="ingroups"><a class="el" href="group__sdkBase.html">Common SDK Implementation Helper Classes</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><b>Example:</b>
|
|
<a href="#details">More...</a></p>
|
|
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Macros for defining the compile time class factory:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="group__constexprClassFactoryMacros.png" border="0" usemap="#agroup____constexprClassFactoryMacros" alt=""/></div>
|
|
<map name="agroup____constexprClassFactoryMacros" id="agroup____constexprClassFactoryMacros">
|
|
<area shape="rect" title="Example:" alt="" coords="240,5,384,58"/>
|
|
<area shape="rect" href="group__sdkBase.html" title="Common SDK files are located in folders "public.sdk/source/common" and "public.sdk/source/main"." alt="" coords="5,12,192,51"/>
|
|
</map>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga34c1a3909dade5be13a5fffa0c498703" id="r_ga34c1a3909dade5be13a5fffa0c498703"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga34c1a3909dade5be13a5fffa0c498703">BEGIN_FACTORY_DEF</a>(company, url, email, noClasses)</td></tr>
|
|
<tr class="separator:ga34c1a3909dade5be13a5fffa0c498703"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac38f5fd5ba69e3506baf96a2fb86b6e7" id="r_gac38f5fd5ba69e3506baf96a2fb86b6e7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac38f5fd5ba69e3506baf96a2fb86b6e7">DEF_CLASS</a>(cid, cardinality, category, name, classFlags, subCategories, version, sdkVersion, createMethod, createContext)</td></tr>
|
|
<tr class="separator:gac38f5fd5ba69e3506baf96a2fb86b6e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga962bbf29e9f424c00fd43493fb8f9489" id="r_ga962bbf29e9f424c00fd43493fb8f9489"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga962bbf29e9f424c00fd43493fb8f9489">END_FACTORY</a></td></tr>
|
|
<tr class="separator:ga962bbf29e9f424c00fd43493fb8f9489"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p><b>Example:</b> </p>
|
|
<div class="fragment"><div class="line"><span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">size_t</span> numberOfClasses = 1;</div>
|
|
<div class="line"><span class="keyword">static</span> <a class="code hl_defineRef" href="../base/funknown_8h.html#a5e349c26a022f90b3562eeb32976e6ed">DECLARE_UID</a> (TestPluginUID, 0x00000001, 0x00000002, 0x00000003, 0x00000004);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><a class="code hl_define" href="#ga34c1a3909dade5be13a5fffa0c498703">BEGIN_FACTORY_DEF</a> (<span class="stringliteral">"MyCompany"</span>, <span class="stringliteral">"mycompany.com"</span>, <span class="stringliteral">"info@mycompany.com"</span>, numberOfClasses)</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <a class="code hl_define" href="group__classFactoryMacros.html#gaae295af1798ff7bd4e2eaa31978142b3">DEF_CLASS</a> (TestPluginUID,</div>
|
|
<div class="line"> PClassInfo::kManyInstances,</div>
|
|
<div class="line"> <span class="stringliteral">"PlugIn"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"Test PlugIn"</span>,</div>
|
|
<div class="line"> 0,</div>
|
|
<div class="line"> <span class="stringliteral">"SubCategory"</span>,</div>
|
|
<div class="line"> <span class="stringliteral">"1.0.0"</span>,</div>
|
|
<div class="line"> stringSDKVersion,</div>
|
|
<div class="line"> TestPlugin::newInstance,</div>
|
|
<div class="line"> <span class="keyword">nullptr</span>)</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><a class="code hl_define" href="group__classFactoryMacros.html#ga962bbf29e9f424c00fd43493fb8f9489">END_FACTORY</a></div>
|
|
<div class="ttc" id="afunknown_8h_html_a5e349c26a022f90b3562eeb32976e6ed"><div class="ttname"><a href="../base/funknown_8h.html#a5e349c26a022f90b3562eeb32976e6ed">DECLARE_UID</a></div><div class="ttdeci">#define DECLARE_UID(name, l1, l2, l3, l4)</div></div>
|
|
<div class="ttc" id="agroup__classFactoryMacros_html_ga962bbf29e9f424c00fd43493fb8f9489"><div class="ttname"><a href="group__classFactoryMacros.html#ga962bbf29e9f424c00fd43493fb8f9489">END_FACTORY</a></div><div class="ttdeci">#define END_FACTORY</div><div class="ttdef"><b>Definition</b> pluginfactory.h:169</div></div>
|
|
<div class="ttc" id="agroup__classFactoryMacros_html_gaae295af1798ff7bd4e2eaa31978142b3"><div class="ttname"><a href="group__classFactoryMacros.html#gaae295af1798ff7bd4e2eaa31978142b3">DEF_CLASS</a></div><div class="ttdeci">#define DEF_CLASS(cid, cardinality, category, name, createMethod)</div><div class="ttdef"><b>Definition</b> pluginfactory.h:149</div></div>
|
|
<div class="ttc" id="agroup__constexprClassFactoryMacros_html_ga34c1a3909dade5be13a5fffa0c498703"><div class="ttname"><a href="#ga34c1a3909dade5be13a5fffa0c498703">BEGIN_FACTORY_DEF</a></div><div class="ttdeci">#define BEGIN_FACTORY_DEF(company, url, email, noClasses)</div><div class="ttdef"><b>Definition</b> pluginfactory_constexpr.h:176</div></div>
|
|
</div><!-- fragment --> <h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ga34c1a3909dade5be13a5fffa0c498703" name="ga34c1a3909dade5be13a5fffa0c498703"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga34c1a3909dade5be13a5fffa0c498703">◆ </a></span>BEGIN_FACTORY_DEF</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define BEGIN_FACTORY_DEF</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>company</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>url</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>email</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>noClasses</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">struct </span>SMTG_HIDDEN_SYMBOL FactoryData \</div>
|
|
<div class="line"> { \</div>
|
|
<div class="line"> <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_structRef" href="../base/structSteinberg_1_1PFactoryInfo.html">Steinberg::PFactoryInfo</a> factoryInfo = { \</div>
|
|
<div class="line"> company, url, email, <a class="code hl_variableRef" href="../base/structSteinberg_1_1PFactoryInfo.html#a618f56f095d5a47e04cb2a60c9fb7380aab221417e3c0a7c87707b0a5b80c9209">Steinberg::PFactoryInfo::kUnicode</a>}; \</div>
|
|
<div class="line"> \</div>
|
|
<div class="line"> <span class="keyword">static</span> <span class="keyword">constexpr</span> std::array<<a class="code hl_struct" href="structSteinberg_1_1PluginFactoryDetail_1_1ClassInfo2WithCreateFunc.html">Steinberg::PluginFactoryDetail::ClassInfo2WithCreateFunc</a>, \</div>
|
|
<div class="line"> noClasses> \</div>
|
|
<div class="line"> classInfos = {</div>
|
|
<div class="ttc" id="astructSteinberg_1_1PFactoryInfo_html"><div class="ttname"><a href="../base/structSteinberg_1_1PFactoryInfo.html">Steinberg::PFactoryInfo</a></div></div>
|
|
<div class="ttc" id="astructSteinberg_1_1PFactoryInfo_html_a618f56f095d5a47e04cb2a60c9fb7380aab221417e3c0a7c87707b0a5b80c9209"><div class="ttname"><a href="../base/structSteinberg_1_1PFactoryInfo.html#a618f56f095d5a47e04cb2a60c9fb7380aab221417e3c0a7c87707b0a5b80c9209">Steinberg::PFactoryInfo::kUnicode</a></div><div class="ttdeci">kUnicode</div></div>
|
|
<div class="ttc" id="astructSteinberg_1_1PluginFactoryDetail_1_1ClassInfo2WithCreateFunc_html"><div class="ttname"><a href="structSteinberg_1_1PluginFactoryDetail_1_1ClassInfo2WithCreateFunc.html">Steinberg::PluginFactoryDetail::ClassInfo2WithCreateFunc</a></div><div class="ttdef"><b>Definition</b> pluginfactory_constexpr.h:107</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="gac38f5fd5ba69e3506baf96a2fb86b6e7" name="gac38f5fd5ba69e3506baf96a2fb86b6e7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac38f5fd5ba69e3506baf96a2fb86b6e7">◆ </a></span>DEF_CLASS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define DEF_CLASS</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>cid</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>cardinality</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>category</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>classFlags</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>subCategories</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>version</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>sdkVersion</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>createMethod</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>createContext</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <a class="code hl_function" href="namespaceSteinberg_1_1PluginFactoryDetail.html#a4bf32b2af66cbb8a01a30cdf65503d57">Steinberg::PluginFactoryDetail::makeClassInfo2</a> (cid, cardinality, category, name, classFlags, \</div>
|
|
<div class="line"> subCategories, <span class="keyword">nullptr</span>, version, sdkVersion, \</div>
|
|
<div class="line"> createMethod, createContext),</div>
|
|
<div class="ttc" id="anamespaceSteinberg_1_1PluginFactoryDetail_html_a4bf32b2af66cbb8a01a30cdf65503d57"><div class="ttname"><a href="namespaceSteinberg_1_1PluginFactoryDetail.html#a4bf32b2af66cbb8a01a30cdf65503d57">Steinberg::PluginFactoryDetail::makeClassInfo2</a></div><div class="ttdeci">constexpr ClassInfo2WithCreateFunc makeClassInfo2(const TUID cid, int32 cardinality, const char8 *category, const char8 *name, int32 classFlags, const char8 *subCategories, const char8 *vendor, const char8 *version, const char8 *sdkVersion, ClassInfo2WithCreateFunc::CreateInstanceFunc func, void *context=nullptr)</div><div class="ttdef"><b>Definition</b> pluginfactory_constexpr.h:114</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ga962bbf29e9f424c00fd43493fb8f9489" name="ga962bbf29e9f424c00fd43493fb8f9489"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga962bbf29e9f424c00fd43493fb8f9489">◆ </a></span>END_FACTORY</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define END_FACTORY</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> };}; \</div>
|
|
<div class="line"> SMTG_EXPORT_SYMBOL Steinberg::IPluginFactory* PLUGIN_API <a class="code hl_functionRef" href="../base/group__pluginBase.html#gaa032a4a5e821cf7c490a99d3e7d5e9ce">GetPluginFactory</a> () \</div>
|
|
<div class="line"> { \</div>
|
|
<div class="line"> <span class="keyword">static</span> Steinberg::PluginFactory<FactoryData> factory; \</div>
|
|
<div class="line"> <span class="keywordflow">return</span> &factory; \</div>
|
|
<div class="line"> }</div>
|
|
<div class="ttc" id="agroup__pluginBase_html_gaa032a4a5e821cf7c490a99d3e7d5e9ce"><div class="ttname"><a href="../base/group__pluginBase.html#gaa032a4a5e821cf7c490a99d3e7d5e9ce">GetPluginFactory</a></div><div class="ttdeci">SMTG_EXPORT_SYMBOL Steinberg::IPluginFactory * GetPluginFactory()</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<html>
|
|
<head>
|
|
<title>Empty</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<meta name="Author" content="Steinberg">
|
|
</head>
|
|
<body>
|
|
<br/>
|
|
<hr width="100%" size="2" align="left" />
|
|
<div align=right>
|
|
Copyright ©<span id="year"></span> <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies GmbH</u></a>.
|
|
All Rights Reserved. This documentation is under this <a href="http://www.steinberg.net/sdklicenses" target="_blank"><u>license</u></a>.
|
|
</div>
|
|
<script>
|
|
document.querySelector("#year").textContent = new Date().getFullYear();
|
|
</script>
|
|
</body>
|
|
</html>
|