725 lines
54 KiB
HTML
725 lines
54 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>Base Module: fobject.h File Reference</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">Base Module<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('fobject_8h.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="#nested-classes">Classes</a> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">fobject.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Basic Object implementing FUnknown.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "pluginterfaces/base/funknown.h"</code><br />
|
|
<code>#include "pluginterfaces/base/iupdatehandler.h"</code><br />
|
|
<code>#include "<a class="el" href="fdebug_8h.html">base/source/fdebug.h</a>"</code><br />
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1FObject.html">FObject</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Implements FUnknown and IDependent. <a href="classSteinberg_1_1FObject.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html">Steinberg</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg_1_1Singleton.html">Steinberg::Singleton</a></td></tr>
|
|
<tr class="memdesc:namespaceSteinberg_1_1Singleton"><td class="mdescLeft"> </td><td class="mdescRight">Automatic creation and destruction of singleton instances. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:acc5dd3332b6e78cc206fe66cdd96f347" id="r_acc5dd3332b6e78cc206fe66cdd96f347"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#acc5dd3332b6e78cc206fe66cdd96f347">SMTG_DEPENDENCY_COUNT</a>   DEVELOPMENT</td></tr>
|
|
<tr class="separator:acc5dd3332b6e78cc206fe66cdd96f347"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69f2b09f8941011cb853819558eff4a7" id="r_a69f2b09f8941011cb853819558eff4a7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a69f2b09f8941011cb853819558eff4a7">SINGLETON</a>(ClassName)</td></tr>
|
|
<tr class="separator:a69f2b09f8941011cb853819558eff4a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a6e2365f969f95aee286638cf6164c7" id="r_a5a6e2365f969f95aee286638cf6164c7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5a6e2365f969f95aee286638cf6164c7">OBJ_METHODS</a>(className, baseClass)</td></tr>
|
|
<tr class="separator:a5a6e2365f969f95aee286638cf6164c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebbb3846780fdaf18f8ee89b73ff149d" id="r_aebbb3846780fdaf18f8ee89b73ff149d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#aebbb3846780fdaf18f8ee89b73ff149d">REFCOUNT_METHODS</a>(BaseClass)</td></tr>
|
|
<tr class="memdesc:aebbb3846780fdaf18f8ee89b73ff149d"><td class="mdescLeft"> </td><td class="mdescRight">Delegate refcount functions to BaseClass. <br /></td></tr>
|
|
<tr class="separator:aebbb3846780fdaf18f8ee89b73ff149d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Macros to implement FUnknown::queryInterface ().</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p><b>Examples:</b></p>
|
|
<div class="fragment"><div class="line"><span class="keyword">class </span>Foo : <span class="keyword">public</span> FObject, <span class="keyword">public</span> IFoo2, <span class="keyword">public</span> IFoo3 </div>
|
|
<div class="line">{</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line"> <a class="code hl_define" href="#a3c0ce0ce836f44d269b414624e3e0971">DEFINE_INTERFACES</a></div>
|
|
<div class="line"> <a class="code hl_define" href="#a53e7d200032b573e38e925748fdb89e3">DEF_INTERFACE</a> (IFoo2)</div>
|
|
<div class="line"> <a class="code hl_define" href="#a53e7d200032b573e38e925748fdb89e3">DEF_INTERFACE</a> (IFoo3)</div>
|
|
<div class="line"> <a class="code hl_define" href="#a7991876302dbc825f493930c856dbd83">END_DEFINE_INTERFACES</a> (FObject)</div>
|
|
<div class="line"> <a class="code hl_define" href="#aebbb3846780fdaf18f8ee89b73ff149d">REFCOUNT_METHODS</a>(FObject)</div>
|
|
<div class="line"> <span class="comment">// Implement IFoo2 interface ...</span></div>
|
|
<div class="line"> <span class="comment">// Implement IFoo3 interface ...</span></div>
|
|
<div class="line"> ...</div>
|
|
<div class="line">};</div>
|
|
<div class="ttc" id="afobject_8h_html_a3c0ce0ce836f44d269b414624e3e0971"><div class="ttname"><a href="#a3c0ce0ce836f44d269b414624e3e0971">DEFINE_INTERFACES</a></div><div class="ttdeci">#define DEFINE_INTERFACES</div><div class="ttdoc">Start defining interfaces.</div><div class="ttdef"><b>Definition</b> fobject.h:420</div></div>
|
|
<div class="ttc" id="afobject_8h_html_a53e7d200032b573e38e925748fdb89e3"><div class="ttname"><a href="#a53e7d200032b573e38e925748fdb89e3">DEF_INTERFACE</a></div><div class="ttdeci">#define DEF_INTERFACE(InterfaceName)</div><div class="ttdoc">Add a interfaces.</div><div class="ttdef"><b>Definition</b> fobject.h:427</div></div>
|
|
<div class="ttc" id="afobject_8h_html_a7991876302dbc825f493930c856dbd83"><div class="ttname"><a href="#a7991876302dbc825f493930c856dbd83">END_DEFINE_INTERFACES</a></div><div class="ttdeci">#define END_DEFINE_INTERFACES(BaseClass)</div><div class="ttdoc">End defining interfaces.</div><div class="ttdef"><b>Definition</b> fobject.h:433</div></div>
|
|
<div class="ttc" id="afobject_8h_html_aebbb3846780fdaf18f8ee89b73ff149d"><div class="ttname"><a href="#aebbb3846780fdaf18f8ee89b73ff149d">REFCOUNT_METHODS</a></div><div class="ttdeci">#define REFCOUNT_METHODS(BaseClass)</div><div class="ttdoc">Delegate refcount functions to BaseClass.</div><div class="ttdef"><b>Definition</b> fobject.h:393</div></div>
|
|
</div><!-- fragment --> </div></td></tr>
|
|
<tr class="memitem:a3c0ce0ce836f44d269b414624e3e0971" id="r_a3c0ce0ce836f44d269b414624e3e0971"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c0ce0ce836f44d269b414624e3e0971">DEFINE_INTERFACES</a></td></tr>
|
|
<tr class="memdesc:a3c0ce0ce836f44d269b414624e3e0971"><td class="mdescLeft"> </td><td class="mdescRight">Start defining interfaces. <br /></td></tr>
|
|
<tr class="separator:a3c0ce0ce836f44d269b414624e3e0971"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53e7d200032b573e38e925748fdb89e3" id="r_a53e7d200032b573e38e925748fdb89e3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a53e7d200032b573e38e925748fdb89e3">DEF_INTERFACE</a>(InterfaceName)</td></tr>
|
|
<tr class="memdesc:a53e7d200032b573e38e925748fdb89e3"><td class="mdescLeft"> </td><td class="mdescRight">Add a interfaces. <br /></td></tr>
|
|
<tr class="separator:a53e7d200032b573e38e925748fdb89e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7991876302dbc825f493930c856dbd83" id="r_a7991876302dbc825f493930c856dbd83"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7991876302dbc825f493930c856dbd83">END_DEFINE_INTERFACES</a>(BaseClass)</td></tr>
|
|
<tr class="memdesc:a7991876302dbc825f493930c856dbd83"><td class="mdescLeft"> </td><td class="mdescRight">End defining interfaces. <br /></td></tr>
|
|
<tr class="separator:a7991876302dbc825f493930c856dbd83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Convenient macros to implement Steinberg::FUnknown::queryInterface ().</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p><b>Examples:</b></p>
|
|
<div class="fragment"><div class="line"><span class="keyword">class </span>Foo : <span class="keyword">public</span> FObject, <span class="keyword">public</span> IFoo2, <span class="keyword">public</span> IFoo3 </div>
|
|
<div class="line">{</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line"> <a class="code hl_define" href="#a334b586ec792ec3bcd90863cc61eb27c">DEF_INTERFACES_2</a>(IFoo2,IFoo3,FObject)</div>
|
|
<div class="line"> <a class="code hl_define" href="#aebbb3846780fdaf18f8ee89b73ff149d">REFCOUNT_METHODS</a>(FObject)</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line">};</div>
|
|
<div class="ttc" id="afobject_8h_html_a334b586ec792ec3bcd90863cc61eb27c"><div class="ttname"><a href="#a334b586ec792ec3bcd90863cc61eb27c">DEF_INTERFACES_2</a></div><div class="ttdeci">#define DEF_INTERFACES_2(InterfaceName1, InterfaceName2, BaseClass)</div><div class="ttdef"><b>Definition</b> fobject.h:459</div></div>
|
|
</div><!-- fragment --> </div></td></tr>
|
|
<tr class="memitem:aba57dd99d0ef259ecc04fc3d05734e88" id="r_aba57dd99d0ef259ecc04fc3d05734e88"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#aba57dd99d0ef259ecc04fc3d05734e88">DEF_INTERFACES_1</a>(InterfaceName, BaseClass)</td></tr>
|
|
<tr class="separator:aba57dd99d0ef259ecc04fc3d05734e88"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a334b586ec792ec3bcd90863cc61eb27c" id="r_a334b586ec792ec3bcd90863cc61eb27c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a334b586ec792ec3bcd90863cc61eb27c">DEF_INTERFACES_2</a>(InterfaceName1, InterfaceName2, BaseClass)</td></tr>
|
|
<tr class="separator:a334b586ec792ec3bcd90863cc61eb27c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06f8f8494473247c3a89e0627600b0ad" id="r_a06f8f8494473247c3a89e0627600b0ad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a06f8f8494473247c3a89e0627600b0ad">DEF_INTERFACES_3</a>(InterfaceName1, InterfaceName2, InterfaceName3, BaseClass)</td></tr>
|
|
<tr class="separator:a06f8f8494473247c3a89e0627600b0ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8fa73969db52bf1e78aaea1b2175128e" id="r_a8fa73969db52bf1e78aaea1b2175128e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8fa73969db52bf1e78aaea1b2175128e">DEF_INTERFACES_4</a>(InterfaceName1, InterfaceName2, InterfaceName3, InterfaceName4, BaseClass)</td></tr>
|
|
<tr class="separator:a8fa73969db52bf1e78aaea1b2175128e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Convenient macros to implement Steinberg::FUnknown methods.</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p><b>Examples:</b></p>
|
|
<div class="fragment"><div class="line"><span class="keyword">class </span>Foo : <span class="keyword">public</span> FObject, <span class="keyword">public</span> IFoo2, <span class="keyword">public</span> IFoo3 </div>
|
|
<div class="line">{</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line"> <a class="code hl_define" href="#ad07f904465df9375353c5ca367a5dfb2">FUNKNOWN_METHODS2</a>(IFoo2,IFoo3,FObject)</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line">};</div>
|
|
<div class="ttc" id="afobject_8h_html_ad07f904465df9375353c5ca367a5dfb2"><div class="ttname"><a href="#ad07f904465df9375353c5ca367a5dfb2">FUNKNOWN_METHODS2</a></div><div class="ttdeci">#define FUNKNOWN_METHODS2(InterfaceName1, InterfaceName2, BaseClass)</div><div class="ttdef"><b>Definition</b> fobject.h:500</div></div>
|
|
</div><!-- fragment --> </div></td></tr>
|
|
<tr class="memitem:a1ad212b9357c288b64de6b6a46c19a57" id="r_a1ad212b9357c288b64de6b6a46c19a57"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1ad212b9357c288b64de6b6a46c19a57">FUNKNOWN_METHODS</a>(InterfaceName, BaseClass)</td></tr>
|
|
<tr class="separator:a1ad212b9357c288b64de6b6a46c19a57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad07f904465df9375353c5ca367a5dfb2" id="r_ad07f904465df9375353c5ca367a5dfb2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad07f904465df9375353c5ca367a5dfb2">FUNKNOWN_METHODS2</a>(InterfaceName1, InterfaceName2, BaseClass)</td></tr>
|
|
<tr class="separator:ad07f904465df9375353c5ca367a5dfb2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa888a63aad080dec3651edbb764cd8bd" id="r_aa888a63aad080dec3651edbb764cd8bd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa888a63aad080dec3651edbb764cd8bd">FUNKNOWN_METHODS3</a>(InterfaceName1, InterfaceName2, InterfaceName3, BaseClass)</td></tr>
|
|
<tr class="separator:aa888a63aad080dec3651edbb764cd8bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41a8ea197ab9208b554473144f6572fd" id="r_a41a8ea197ab9208b554473144f6572fd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a41a8ea197ab9208b554473144f6572fd">FUNKNOWN_METHODS4</a>(InterfaceName1, InterfaceName2, InterfaceName3, InterfaceName4, BaseClass)</td></tr>
|
|
<tr class="separator:a41a8ea197ab9208b554473144f6572fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ab36f267af0b3dc88ce9135a0c3b4f170" id="r_ab36f267af0b3dc88ce9135a0c3b4f170"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a> = FIDString</td></tr>
|
|
<tr class="separator:ab36f267af0b3dc88ce9135a0c3b4f170"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:aaa99ecbd430edfff1c6f13067b6445c1" id="r_aaa99ecbd430edfff1c6f13067b6445c1"><td class="memTemplParams" colspan="2">template<class C> </td></tr>
|
|
<tr class="memitem:aaa99ecbd430edfff1c6f13067b6445c1"><td class="memTemplItemLeft" align="right" valign="top">C * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#aaa99ecbd430edfff1c6f13067b6445c1">FCast</a> (const <a class="el" href="classSteinberg_1_1FObject.html">FObject</a> *object)</td></tr>
|
|
<tr class="memdesc:aaa99ecbd430edfff1c6f13067b6445c1"><td class="mdescLeft"> </td><td class="mdescRight">FCast overload 1 - <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> to <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a>. <br /></td></tr>
|
|
<tr class="separator:aaa99ecbd430edfff1c6f13067b6445c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1c7c73bcf9453420493980ea0c148d6" id="r_ab1c7c73bcf9453420493980ea0c148d6"><td class="memTemplParams" colspan="2">template<class C> </td></tr>
|
|
<tr class="memitem:ab1c7c73bcf9453420493980ea0c148d6"><td class="memTemplItemLeft" align="right" valign="top">C * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#ab1c7c73bcf9453420493980ea0c148d6">FCast</a> (FUnknown *unknown)</td></tr>
|
|
<tr class="memdesc:ab1c7c73bcf9453420493980ea0c148d6"><td class="mdescLeft"> </td><td class="mdescRight">FCast overload 2 - FUnknown to <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a>. <br /></td></tr>
|
|
<tr class="separator:ab1c7c73bcf9453420493980ea0c148d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a091df1d5711be4cc3638dc4df0520e59" id="r_a091df1d5711be4cc3638dc4df0520e59"><td class="memTemplParams" colspan="2">template<class I> </td></tr>
|
|
<tr class="memitem:a091df1d5711be4cc3638dc4df0520e59"><td class="memTemplItemLeft" align="right" valign="top">IPtr< I > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#a091df1d5711be4cc3638dc4df0520e59">ICast</a> (<a class="el" href="classSteinberg_1_1FObject.html">FObject</a> *object)</td></tr>
|
|
<tr class="memdesc:a091df1d5711be4cc3638dc4df0520e59"><td class="mdescLeft"> </td><td class="mdescRight">ICast - casting from <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> to FUnknown Interface. <br /></td></tr>
|
|
<tr class="separator:a091df1d5711be4cc3638dc4df0520e59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66c0905bbe3432f8a15ed3565846ae0a" id="r_a66c0905bbe3432f8a15ed3565846ae0a"><td class="memTemplParams" colspan="2">template<class I> </td></tr>
|
|
<tr class="memitem:a66c0905bbe3432f8a15ed3565846ae0a"><td class="memTemplItemLeft" align="right" valign="top">IPtr< I > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#a66c0905bbe3432f8a15ed3565846ae0a">ICast</a> (FUnknown *object)</td></tr>
|
|
<tr class="memdesc:a66c0905bbe3432f8a15ed3565846ae0a"><td class="mdescLeft"> </td><td class="mdescRight">ICast - casting from FUnknown to another FUnknown Interface. <br /></td></tr>
|
|
<tr class="separator:a66c0905bbe3432f8a15ed3565846ae0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30de56b256b272282807bb50634a7888" id="r_a30de56b256b272282807bb50634a7888"><td class="memTemplParams" colspan="2">template<class C> </td></tr>
|
|
<tr class="memitem:a30de56b256b272282807bb50634a7888"><td class="memTemplItemLeft" align="right" valign="top">C * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#a30de56b256b272282807bb50634a7888">FCastIsA</a> (const <a class="el" href="classSteinberg_1_1FObject.html">FObject</a> *object)</td></tr>
|
|
<tr class="separator:a30de56b256b272282807bb50634a7888"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5b3f6bf640105c689aad999c94b3ae8" id="r_aa5b3f6bf640105c689aad999c94b3ae8"><td class="memTemplParams" colspan="2">template<class C> </td></tr>
|
|
<tr class="memitem:aa5b3f6bf640105c689aad999c94b3ae8"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#aa5b3f6bf640105c689aad999c94b3ae8">SMTG_DEPRECATED_MSG</a> ("use <a class="el" href="namespaceSteinberg.html#a091df1d5711be4cc3638dc4df0520e59">ICast</a><>") inline C *FUCast(<a class="el" href="classSteinberg_1_1FObject.html">FObject</a> *object)</td></tr>
|
|
<tr class="separator:aa5b3f6bf640105c689aad999c94b3ae8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a772adc0fcb5de416403e831a5f16797d" id="r_a772adc0fcb5de416403e831a5f16797d"><td class="memTemplParams" colspan="2">template<class T> </td></tr>
|
|
<tr class="memitem:a772adc0fcb5de416403e831a5f16797d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#a772adc0fcb5de416403e831a5f16797d">AssignShared</a> (T *&dest, T *newPtr)</td></tr>
|
|
<tr class="separator:a772adc0fcb5de416403e831a5f16797d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1bd8111a2b52e57f15758f0e1d7b3f5c" id="r_a1bd8111a2b52e57f15758f0e1d7b3f5c"><td class="memTemplParams" colspan="2">template<class T> </td></tr>
|
|
<tr class="memitem:a1bd8111a2b52e57f15758f0e1d7b3f5c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#a1bd8111a2b52e57f15758f0e1d7b3f5c">AssignSharedDependent</a> (IDependent *_this, T *&dest, T *newPtr)</td></tr>
|
|
<tr class="separator:a1bd8111a2b52e57f15758f0e1d7b3f5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a785dfd10645feff83d9c49db1a2df56c" id="r_a785dfd10645feff83d9c49db1a2df56c"><td class="memTemplParams" colspan="2">template<class T> </td></tr>
|
|
<tr class="memitem:a785dfd10645feff83d9c49db1a2df56c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#a785dfd10645feff83d9c49db1a2df56c">AssignSharedDependent</a> (IDependent *_this, IPtr< T > &dest, T *newPtr)</td></tr>
|
|
<tr class="separator:a785dfd10645feff83d9c49db1a2df56c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb5bf71aafd7a70c707c9f0a9f64eb0b" id="r_afb5bf71aafd7a70c707c9f0a9f64eb0b"><td class="memTemplParams" colspan="2">template<class T> </td></tr>
|
|
<tr class="memitem:afb5bf71aafd7a70c707c9f0a9f64eb0b"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#afb5bf71aafd7a70c707c9f0a9f64eb0b">SafeReleaseDependent</a> (IDependent *_this, T *&dest)</td></tr>
|
|
<tr class="separator:afb5bf71aafd7a70c707c9f0a9f64eb0b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa23406c35d7e68e9717fee2dd47b8c27" id="r_aa23406c35d7e68e9717fee2dd47b8c27"><td class="memTemplParams" colspan="2">template<class T> </td></tr>
|
|
<tr class="memitem:aa23406c35d7e68e9717fee2dd47b8c27"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#aa23406c35d7e68e9717fee2dd47b8c27">SafeReleaseDependent</a> (IDependent *_this, IPtr< T > &dest)</td></tr>
|
|
<tr class="separator:aa23406c35d7e68e9717fee2dd47b8c27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6e6c857d3abf9d8ef37ef8d465c9977" id="r_ad6e6c857d3abf9d8ef37ef8d465c9977"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg_1_1Singleton.html#ad6e6c857d3abf9d8ef37ef8d465c9977">registerInstance</a> (<a class="el" href="classSteinberg_1_1FObject.html">FObject</a> **o)</td></tr>
|
|
<tr class="memdesc:ad6e6c857d3abf9d8ef37ef8d465c9977"><td class="mdescLeft"> </td><td class="mdescRight">registers an instance (type <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a>) <br /></td></tr>
|
|
<tr class="separator:ad6e6c857d3abf9d8ef37ef8d465c9977"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84acfabb69fd8f78cc6afad4301357b7" id="r_a84acfabb69fd8f78cc6afad4301357b7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg_1_1Singleton.html#a84acfabb69fd8f78cc6afad4301357b7">isTerminated</a> ()</td></tr>
|
|
<tr class="memdesc:a84acfabb69fd8f78cc6afad4301357b7"><td class="mdescLeft"> </td><td class="mdescRight">Returns true when singleton instances were already released. <br /></td></tr>
|
|
<tr class="separator:a84acfabb69fd8f78cc6afad4301357b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1612cf2b7b00489ee4cd0af7999ff7ac" id="r_a1612cf2b7b00489ee4cd0af7999ff7ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg_1_1Singleton.html#a1612cf2b7b00489ee4cd0af7999ff7ac">lockRegister</a> ()</td></tr>
|
|
<tr class="memdesc:a1612cf2b7b00489ee4cd0af7999ff7ac"><td class="mdescLeft"> </td><td class="mdescRight">lock and unlock the singleton registration for multi-threading safety <br /></td></tr>
|
|
<tr class="separator:a1612cf2b7b00489ee4cd0af7999ff7ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2aad80bf0469cb9153a7666f2b2b4817" id="r_a2aad80bf0469cb9153a7666f2b2b4817"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg_1_1Singleton.html#a2aad80bf0469cb9153a7666f2b2b4817">unlockRegister</a> ()</td></tr>
|
|
<tr class="separator:a2aad80bf0469cb9153a7666f2b2b4817"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Convenience methods that call release or delete respectively</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p>on a pointer if it is non-zero, and then set the pointer to zero.</p>
|
|
<p>Note: you should prefer using IPtr or OPtr instead of these methods whenever possible. <b>Examples:</b> </p><div class="fragment"><div class="line">~Foo ()</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="comment">// instead of ...</span></div>
|
|
<div class="line"> <span class="keywordflow">if</span> (somePointer)</div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> somePointer->release ();</div>
|
|
<div class="line"> somePointer = 0;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="comment">// ... just being lazy I write</span></div>
|
|
<div class="line"> <a class="code hl_function" href="namespaceSteinberg.html#a69050516521be935150d7cc9cbdd6d07">SafeRelease</a> (somePointer)</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="anamespaceSteinberg_html_a69050516521be935150d7cc9cbdd6d07"><div class="ttname"><a href="namespaceSteinberg.html#a69050516521be935150d7cc9cbdd6d07">Steinberg::SafeRelease</a></div><div class="ttdeci">void SafeRelease(I *&ptr)</div><div class="ttdef"><b>Definition</b> fobject.h:255</div></div>
|
|
</div><!-- fragment --> </div></td></tr>
|
|
<tr class="memitem:a69050516521be935150d7cc9cbdd6d07" id="r_a69050516521be935150d7cc9cbdd6d07"><td class="memTemplParams" colspan="2">template<class I> </td></tr>
|
|
<tr class="memitem:a69050516521be935150d7cc9cbdd6d07"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#a69050516521be935150d7cc9cbdd6d07">SafeRelease</a> (I *&ptr)</td></tr>
|
|
<tr class="separator:a69050516521be935150d7cc9cbdd6d07"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7bc17c908b6a840c80c88cf97ccd49f4" id="r_a7bc17c908b6a840c80c88cf97ccd49f4"><td class="memTemplParams" colspan="2">template<class I> </td></tr>
|
|
<tr class="memitem:a7bc17c908b6a840c80c88cf97ccd49f4"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#a7bc17c908b6a840c80c88cf97ccd49f4">SafeRelease</a> (IPtr< I > &ptr)</td></tr>
|
|
<tr class="separator:a7bc17c908b6a840c80c88cf97ccd49f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7003153d08b04bbbd48f67260561b7ae" id="r_a7003153d08b04bbbd48f67260561b7ae"><td class="memTemplParams" colspan="2">template<class T> </td></tr>
|
|
<tr class="memitem:a7003153d08b04bbbd48f67260561b7ae"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceSteinberg.html#a7003153d08b04bbbd48f67260561b7ae">SafeDelete</a> (T *&ptr)</td></tr>
|
|
<tr class="separator:a7003153d08b04bbbd48f67260561b7ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Basic Object implementing FUnknown. </p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="acc5dd3332b6e78cc206fe66cdd96f347" name="acc5dd3332b6e78cc206fe66cdd96f347"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc5dd3332b6e78cc206fe66cdd96f347">◆ </a></span>SMTG_DEPENDENCY_COUNT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SMTG_DEPENDENCY_COUNT   DEVELOPMENT</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a69f2b09f8941011cb853819558eff4a7" name="a69f2b09f8941011cb853819558eff4a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a69f2b09f8941011cb853819558eff4a7">◆ </a></span>SINGLETON</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SINGLETON</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>ClassName</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">static</span> ClassName* instance (<span class="keywordtype">bool</span> create = <span class="keyword">true</span>) \</div>
|
|
<div class="line"> { \</div>
|
|
<div class="line"> <span class="keyword">static</span> <a class="code hl_class" href="classSteinberg_1_1FObject.html">Steinberg::FObject</a>* inst = <span class="keyword">nullptr</span>; \</div>
|
|
<div class="line"> if (inst == <span class="keyword">nullptr</span> && create && <a class="code hl_function" href="namespaceSteinberg_1_1Singleton.html#a84acfabb69fd8f78cc6afad4301357b7">Steinberg::Singleton::isTerminated</a> () == <span class="keyword">false</span>) \</div>
|
|
<div class="line"> { \</div>
|
|
<div class="line"> Steinberg::Singleton::lockRegister (); \</div>
|
|
<div class="line"> if (inst == <span class="keyword">nullptr</span>) \</div>
|
|
<div class="line"> { \</div>
|
|
<div class="line"> inst = <a class="code hl_define" href="fdebug_8h.html#ab6bca16ed021b1e211fde8669758f199">NEW</a> ClassName; \</div>
|
|
<div class="line"> Steinberg::Singleton::registerInstance (&inst); \</div>
|
|
<div class="line"> } \</div>
|
|
<div class="line"> Steinberg::Singleton::unlockRegister (); \</div>
|
|
<div class="line"> } \</div>
|
|
<div class="line"> return (ClassName*)inst; \</div>
|
|
<div class="line"> }</div>
|
|
<div class="ttc" id="aclassSteinberg_1_1FObject_html"><div class="ttname"><a href="classSteinberg_1_1FObject.html">Steinberg::FObject</a></div><div class="ttdoc">Implements FUnknown and IDependent.</div><div class="ttdef"><b>Definition</b> fobject.h:65</div></div>
|
|
<div class="ttc" id="afdebug_8h_html_ab6bca16ed021b1e211fde8669758f199"><div class="ttname"><a href="fdebug_8h.html#ab6bca16ed021b1e211fde8669758f199">NEW</a></div><div class="ttdeci">#define NEW</div><div class="ttdef"><b>Definition</b> fdebug.h:197</div></div>
|
|
<div class="ttc" id="anamespaceSteinberg_1_1Singleton_html_a84acfabb69fd8f78cc6afad4301357b7"><div class="ttname"><a href="namespaceSteinberg_1_1Singleton.html#a84acfabb69fd8f78cc6afad4301357b7">Steinberg::Singleton::isTerminated</a></div><div class="ttdeci">bool isTerminated()</div><div class="ttdoc">Returns true when singleton instances were already released.</div><div class="ttdef"><b>Definition</b> fobject.cpp:222</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a5a6e2365f969f95aee286638cf6164c7" name="a5a6e2365f969f95aee286638cf6164c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a6e2365f969f95aee286638cf6164c7">◆ </a></span>OBJ_METHODS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define OBJ_METHODS</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>className</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>baseClass</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code hl_typedef" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">Steinberg::FClassID</a> getFClassID () {<span class="keywordflow">return</span> (#className);} \</div>
|
|
<div class="line"> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">Steinberg::FClassID</a> isA () const SMTG_OVERRIDE {<span class="keywordflow">return</span> className::getFClassID ();} \</div>
|
|
<div class="line"> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isA (<a class="code hl_typedef" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">Steinberg::FClassID</a> s) <span class="keyword">const</span> SMTG_OVERRIDE {<span class="keywordflow">return</span> isTypeOf (s, <span class="keyword">false</span>);} \</div>
|
|
<div class="line"> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isTypeOf (<a class="code hl_typedef" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">Steinberg::FClassID</a> s, <span class="keywordtype">bool</span> askBaseClass = <span class="keyword">true</span>) const SMTG_OVERRIDE \</div>
|
|
<div class="line"> { <span class="keywordflow">return</span> (FObject::classIDsEqual (s, #className) ? <span class="keyword">true</span> : (askBaseClass ? baseClass::isTypeOf (s, <span class="keyword">true</span>) : <span class="keyword">false</span>)); }</div>
|
|
<div class="ttc" id="anamespaceSteinberg_html_ab36f267af0b3dc88ce9135a0c3b4f170"><div class="ttname"><a href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">Steinberg::FClassID</a></div><div class="ttdeci">FIDString FClassID</div><div class="ttdef"><b>Definition</b> fobject.h:35</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aebbb3846780fdaf18f8ee89b73ff149d" name="aebbb3846780fdaf18f8ee89b73ff149d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebbb3846780fdaf18f8ee89b73ff149d">◆ </a></span>REFCOUNT_METHODS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define REFCOUNT_METHODS</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">virtual</span> Steinberg::uint32 PLUGIN_API addRef ()SMTG_OVERRIDE{ <span class="keywordflow">return</span> BaseClass::addRef (); } \</div>
|
|
<div class="line"><span class="keyword">virtual</span> Steinberg::uint32 PLUGIN_API release ()SMTG_OVERRIDE{ <span class="keywordflow">return</span> BaseClass::release (); }</div>
|
|
</div><!-- fragment -->
|
|
<p>Delegate refcount functions to BaseClass. </p>
|
|
<p>BaseClase must implement ref counting. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c0ce0ce836f44d269b414624e3e0971" name="a3c0ce0ce836f44d269b414624e3e0971"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c0ce0ce836f44d269b414624e3e0971">◆ </a></span>DEFINE_INTERFACES</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define DEFINE_INTERFACES</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line">Steinberg::tresult PLUGIN_API queryInterface (<span class="keyword">const</span> Steinberg::TUID iid, <span class="keywordtype">void</span>** obj) SMTG_OVERRIDE \</div>
|
|
<div class="line">{</div>
|
|
</div><!-- fragment -->
|
|
<p>Start defining interfaces. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a53e7d200032b573e38e925748fdb89e3" name="a53e7d200032b573e38e925748fdb89e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a53e7d200032b573e38e925748fdb89e3">◆ </a></span>DEF_INTERFACE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define DEF_INTERFACE</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> QUERY_INTERFACE (iid, obj, Steinberg::getTUID<InterfaceName> (), InterfaceName)</div>
|
|
</div><!-- fragment -->
|
|
<p>Add a interfaces. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7991876302dbc825f493930c856dbd83" name="a7991876302dbc825f493930c856dbd83"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7991876302dbc825f493930c856dbd83">◆ </a></span>END_DEFINE_INTERFACES</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define END_DEFINE_INTERFACES</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">return</span> BaseClass::queryInterface (iid, obj); \</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment -->
|
|
<p>End defining interfaces. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aba57dd99d0ef259ecc04fc3d05734e88" name="aba57dd99d0ef259ecc04fc3d05734e88"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba57dd99d0ef259ecc04fc3d05734e88">◆ </a></span>DEF_INTERFACES_1</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define DEF_INTERFACES_1</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line">DEFINE_INTERFACES \</div>
|
|
<div class="line">DEF_INTERFACE (InterfaceName) \</div>
|
|
<div class="line">END_DEFINE_INTERFACES (BaseClass)</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a334b586ec792ec3bcd90863cc61eb27c" name="a334b586ec792ec3bcd90863cc61eb27c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a334b586ec792ec3bcd90863cc61eb27c">◆ </a></span>DEF_INTERFACES_2</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define DEF_INTERFACES_2</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName1</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName2</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line">DEFINE_INTERFACES \</div>
|
|
<div class="line">DEF_INTERFACE (InterfaceName1) \</div>
|
|
<div class="line">DEF_INTERFACE (InterfaceName2) \</div>
|
|
<div class="line">END_DEFINE_INTERFACES (BaseClass)</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a06f8f8494473247c3a89e0627600b0ad" name="a06f8f8494473247c3a89e0627600b0ad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a06f8f8494473247c3a89e0627600b0ad">◆ </a></span>DEF_INTERFACES_3</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define DEF_INTERFACES_3</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName1</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName2</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName3</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line">DEFINE_INTERFACES \</div>
|
|
<div class="line">DEF_INTERFACE (InterfaceName1) \</div>
|
|
<div class="line">DEF_INTERFACE (InterfaceName2) \</div>
|
|
<div class="line">DEF_INTERFACE (InterfaceName3) \</div>
|
|
<div class="line">END_DEFINE_INTERFACES (BaseClass)</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a8fa73969db52bf1e78aaea1b2175128e" name="a8fa73969db52bf1e78aaea1b2175128e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8fa73969db52bf1e78aaea1b2175128e">◆ </a></span>DEF_INTERFACES_4</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define DEF_INTERFACES_4</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName1</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName2</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName3</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName4</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> DEFINE_INTERFACES \</div>
|
|
<div class="line"> DEF_INTERFACE (InterfaceName1) \</div>
|
|
<div class="line"> DEF_INTERFACE (InterfaceName2) \</div>
|
|
<div class="line"> DEF_INTERFACE (InterfaceName3) \</div>
|
|
<div class="line"> DEF_INTERFACE (InterfaceName4) \</div>
|
|
<div class="line"> END_DEFINE_INTERFACES (BaseClass)</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a1ad212b9357c288b64de6b6a46c19a57" name="a1ad212b9357c288b64de6b6a46c19a57"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ad212b9357c288b64de6b6a46c19a57">◆ </a></span>FUNKNOWN_METHODS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FUNKNOWN_METHODS</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#aba57dd99d0ef259ecc04fc3d05734e88">DEF_INTERFACES_1</a>(InterfaceName,BaseClass) \</div>
|
|
<div class="line">REFCOUNT_METHODS(BaseClass)</div>
|
|
<div class="ttc" id="afobject_8h_html_aba57dd99d0ef259ecc04fc3d05734e88"><div class="ttname"><a href="#aba57dd99d0ef259ecc04fc3d05734e88">DEF_INTERFACES_1</a></div><div class="ttdeci">#define DEF_INTERFACES_1(InterfaceName, BaseClass)</div><div class="ttdef"><b>Definition</b> fobject.h:453</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ad07f904465df9375353c5ca367a5dfb2" name="ad07f904465df9375353c5ca367a5dfb2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad07f904465df9375353c5ca367a5dfb2">◆ </a></span>FUNKNOWN_METHODS2</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FUNKNOWN_METHODS2</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName1</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName2</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#a334b586ec792ec3bcd90863cc61eb27c">DEF_INTERFACES_2</a>(InterfaceName1,InterfaceName2,BaseClass) \</div>
|
|
<div class="line">REFCOUNT_METHODS(BaseClass)</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aa888a63aad080dec3651edbb764cd8bd" name="aa888a63aad080dec3651edbb764cd8bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa888a63aad080dec3651edbb764cd8bd">◆ </a></span>FUNKNOWN_METHODS3</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FUNKNOWN_METHODS3</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName1</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName2</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName3</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#a06f8f8494473247c3a89e0627600b0ad">DEF_INTERFACES_3</a>(InterfaceName1,InterfaceName2,InterfaceName3,BaseClass) \</div>
|
|
<div class="line">REFCOUNT_METHODS(BaseClass)</div>
|
|
<div class="ttc" id="afobject_8h_html_a06f8f8494473247c3a89e0627600b0ad"><div class="ttname"><a href="#a06f8f8494473247c3a89e0627600b0ad">DEF_INTERFACES_3</a></div><div class="ttdeci">#define DEF_INTERFACES_3(InterfaceName1, InterfaceName2, InterfaceName3, BaseClass)</div><div class="ttdef"><b>Definition</b> fobject.h:466</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a41a8ea197ab9208b554473144f6572fd" name="a41a8ea197ab9208b554473144f6572fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41a8ea197ab9208b554473144f6572fd">◆ </a></span>FUNKNOWN_METHODS4</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define FUNKNOWN_METHODS4</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName1</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName2</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName3</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>InterfaceName4</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>BaseClass</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#a8fa73969db52bf1e78aaea1b2175128e">DEF_INTERFACES_4</a>(InterfaceName1,InterfaceName2,InterfaceName3,InterfaceName4,BaseClass) \</div>
|
|
<div class="line">REFCOUNT_METHODS(BaseClass)</div>
|
|
<div class="ttc" id="afobject_8h_html_a8fa73969db52bf1e78aaea1b2175128e"><div class="ttname"><a href="#a8fa73969db52bf1e78aaea1b2175128e">DEF_INTERFACES_4</a></div><div class="ttdeci">#define DEF_INTERFACES_4(InterfaceName1, InterfaceName2, InterfaceName3, InterfaceName4, BaseClass)</div><div class="ttdef"><b>Definition</b> fobject.h:474</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>
|