285 lines
17 KiB
HTML
285 lines
17 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>Interface Technology Basics: Steinberg::U Namespace 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">Interface Technology Basics<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('namespaceSteinberg_1_1U.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="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Steinberg::U Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Shortcut namespace for implementing <a class="el" href="classSteinberg_1_1FUnknown.html" title="The basic interface of all interfaces.">FUnknown</a> based objects.
|
|
<a href="#details">More...</a></p>
|
|
<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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSteinberg_1_1U_1_1Directly.html">Directly</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This struct is used to group a list of interfaces from which should be inherited and which should be available via the <code>queryInterface</code> method. <a href="structSteinberg_1_1U_1_1Directly.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSteinberg_1_1U_1_1Indirectly.html">Indirectly</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This struct is used to group a list of interfaces from which should not be inherited but which should be available via the <code>queryInterface</code> method. <a href="structSteinberg_1_1U_1_1Indirectly.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSteinberg_1_1U_1_1UID.html">UID</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This class provides a compile-time uid and enables interfaces to specify a <a class="el" href="structSteinberg_1_1U_1_1UID.html" title="This class provides a compile-time uid and enables interfaces to specify a UID as a simple typedef.">UID</a> as a simple typedef. <a href="structSteinberg_1_1U_1_1UID.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="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:a68f6e121eb237b7f588f0036b056b43b" id="r_a68f6e121eb237b7f588f0036b056b43b"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a68f6e121eb237b7f588f0036b056b43b">Unknown</a> = <a class="el" href="structSteinberg_1_1FUnknownImpl_1_1HideIIDBase.html">FUnknownImpl::HideIIDBase</a></td></tr>
|
|
<tr class="separator:a68f6e121eb237b7f588f0036b056b43b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7c3d8fc183de6c65cb7209c4edda8a7" id="r_ad7c3d8fc183de6c65cb7209c4edda8a7"><td class="memTemplParams" colspan="2">template<typename BaseClass, typename D, typename I = Indirectly<>> </td></tr>
|
|
<tr class="memitem:ad7c3d8fc183de6c65cb7209c4edda8a7"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ad7c3d8fc183de6c65cb7209c4edda8a7">Extends</a></td></tr>
|
|
<tr class="memdesc:ad7c3d8fc183de6c65cb7209c4edda8a7"><td class="mdescLeft"> </td><td class="mdescRight">This typedef enables using a custom base class with the interface implementation. <br /></td></tr>
|
|
<tr class="separator:ad7c3d8fc183de6c65cb7209c4edda8a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa97fe0c3b9d688a3e43da776dec431c6" id="r_aa97fe0c3b9d688a3e43da776dec431c6"><td class="memTemplParams" colspan="2">template<typename D, typename I = Indirectly<>> </td></tr>
|
|
<tr class="memitem:aa97fe0c3b9d688a3e43da776dec431c6"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa97fe0c3b9d688a3e43da776dec431c6">Implements</a></td></tr>
|
|
<tr class="memdesc:aa97fe0c3b9d688a3e43da776dec431c6"><td class="mdescLeft"> </td><td class="mdescRight">This typedef provides the interface implementation. <br /></td></tr>
|
|
<tr class="separator:aa97fe0c3b9d688a3e43da776dec431c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a33d524a00593b41664bf5a7be2aaf204" id="r_a33d524a00593b41664bf5a7be2aaf204"><td class="memTemplParams" colspan="2">template<typename D, typename I = Indirectly<>> </td></tr>
|
|
<tr class="memitem:a33d524a00593b41664bf5a7be2aaf204"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a33d524a00593b41664bf5a7be2aaf204">ImplementsNonDestroyable</a></td></tr>
|
|
<tr class="memdesc:a33d524a00593b41664bf5a7be2aaf204"><td class="mdescLeft"> </td><td class="mdescRight">This typedef provides the interface implementation for objects which should not be destroyed via <a class="el" href="classSteinberg_1_1FUnknown.html#a58847c78bf6142f01ce214c2802cb146" title="Releases a reference and returns the new reference count.">FUnknown::release</a> (like singletons). <br /></td></tr>
|
|
<tr class="separator:a33d524a00593b41664bf5a7be2aaf204"><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:a689771ba01c7847cc229ae30e227b638" id="r_a689771ba01c7847cc229ae30e227b638"><td class="memTemplParams" colspan="2">template<typename I> </td></tr>
|
|
<tr class="memitem:a689771ba01c7847cc229ae30e227b638"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classSteinberg_1_1IPtr.html">IPtr</a>< I > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a689771ba01c7847cc229ae30e227b638">cast</a> (<a class="el" href="#a68f6e121eb237b7f588f0036b056b43b">Unknown</a> *u)</td></tr>
|
|
<tr class="memdesc:a689771ba01c7847cc229ae30e227b638"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the given <a class="el" href="#a68f6e121eb237b7f588f0036b056b43b">Unknown</a> can provide the specified interface and returns it in an <a class="el" href="classSteinberg_1_1IPtr.html" title="IPtr - Smart pointer template class.">IPtr</a>. <br /></td></tr>
|
|
<tr class="separator:a689771ba01c7847cc229ae30e227b638"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab5c714b140d499f304e042e746ca9b1b" id="r_ab5c714b140d499f304e042e746ca9b1b"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:ab5c714b140d499f304e042e746ca9b1b"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="group__pluginBase.html#ga6935af93744bfe4ecc455f274ef1ec36">TUID</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab5c714b140d499f304e042e746ca9b1b">getTUID</a> ()</td></tr>
|
|
<tr class="separator:ab5c714b140d499f304e042e746ca9b1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Shortcut namespace for implementing <a class="el" href="classSteinberg_1_1FUnknown.html" title="The basic interface of all interfaces.">FUnknown</a> based objects. </p>
|
|
</div><h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="a68f6e121eb237b7f588f0036b056b43b" name="a68f6e121eb237b7f588f0036b056b43b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68f6e121eb237b7f588f0036b056b43b">◆ </a></span>Unknown</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="#a68f6e121eb237b7f588f0036b056b43b">Unknown</a> = <a class="el" href="structSteinberg_1_1FUnknownImpl_1_1HideIIDBase.html">FUnknownImpl::HideIIDBase</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7c3d8fc183de6c65cb7209c4edda8a7" name="ad7c3d8fc183de6c65cb7209c4edda8a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7c3d8fc183de6c65cb7209c4edda8a7">◆ </a></span>Extends</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename BaseClass, typename D, typename I = Indirectly<>> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="namespaceSteinberg_1_1FUnknownImpl.html#ad7c3d8fc183de6c65cb7209c4edda8a7">Extends</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This typedef enables using a custom base class with the interface implementation. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa97fe0c3b9d688a3e43da776dec431c6" name="aa97fe0c3b9d688a3e43da776dec431c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa97fe0c3b9d688a3e43da776dec431c6">◆ </a></span>Implements</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename D, typename I = Indirectly<>> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="namespaceSteinberg_1_1FUnknownImpl.html#aa97fe0c3b9d688a3e43da776dec431c6">Implements</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This typedef provides the interface implementation. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a33d524a00593b41664bf5a7be2aaf204" name="a33d524a00593b41664bf5a7be2aaf204"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a33d524a00593b41664bf5a7be2aaf204">◆ </a></span>ImplementsNonDestroyable</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename D, typename I = Indirectly<>> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="namespaceSteinberg_1_1FUnknownImpl.html#a33d524a00593b41664bf5a7be2aaf204">ImplementsNonDestroyable</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This typedef provides the interface implementation for objects which should not be destroyed via <a class="el" href="classSteinberg_1_1FUnknown.html#a58847c78bf6142f01ce214c2802cb146" title="Releases a reference and returns the new reference count.">FUnknown::release</a> (like singletons). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a689771ba01c7847cc229ae30e227b638" name="a689771ba01c7847cc229ae30e227b638"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a689771ba01c7847cc229ae30e227b638">◆ </a></span>cast()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename I> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSteinberg_1_1IPtr.html">IPtr</a>< I > cast </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#a68f6e121eb237b7f588f0036b056b43b">Unknown</a> *</td> <td class="paramname"><span class="paramname"><em>u</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if the given <a class="el" href="#a68f6e121eb237b7f588f0036b056b43b">Unknown</a> can provide the specified interface and returns it in an <a class="el" href="classSteinberg_1_1IPtr.html" title="IPtr - Smart pointer template class.">IPtr</a>. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>an <a class="el" href="classSteinberg_1_1IPtr.html" title="IPtr - Smart pointer template class.">IPtr</a> pointing to an instance of the requested interface or nullptr in case the object does not provide the interface. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab5c714b140d499f304e042e746ca9b1b" name="ab5c714b140d499f304e042e746ca9b1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab5c714b140d499f304e042e746ca9b1b">◆ </a></span>getTUID()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="group__pluginBase.html#ga6935af93744bfe4ecc455f274ef1ec36">TUID</a> & getTUID </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="group__pluginBase.html#ga6935af93744bfe4ecc455f274ef1ec36" title="plain UID type">TUID</a> for an interface. </dd></dl>
|
|
|
|
</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>
|