civ/hot-step-cpp-ROCm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
hot-step-cpp-ROCm/engine/vendor/vst3sdk/doc/basemodule/structSteinberg_1_1FNuller.html
T
civ 876886a39a Initial release
2026-08-16 18:24:52 +07:00

242 lines
11 KiB
HTML
Raw Permalink Blame History

<!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: FNuller&lt; T &gt; Struct Template 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">&#160;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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('structSteinberg_1_1FNuller.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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structSteinberg_1_1FNuller-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">FNuller&lt; T &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Template definition for classes that help resetting an object's value.
<a href="#details">More...</a></p>
<p><code>#include &lt;fcleanup.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9fd1a507ebc6f2535cd3130e5bf7cb04" id="r_a9fd1a507ebc6f2535cd3130e5bf7cb04"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9fd1a507ebc6f2535cd3130e5bf7cb04">FNuller</a> (T &amp;_toNull)</td></tr>
<tr class="memdesc:a9fd1a507ebc6f2535cd3130e5bf7cb04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a9fd1a507ebc6f2535cd3130e5bf7cb04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9191536eaf9f59f8fe55bad97cf001d" id="r_ab9191536eaf9f59f8fe55bad97cf001d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab9191536eaf9f59f8fe55bad97cf001d">~FNuller</a> ()</td></tr>
<tr class="memdesc:ab9191536eaf9f59f8fe55bad97cf001d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. Assigns 0 to the at construction time passed object reference. <br /></td></tr>
<tr class="separator:ab9191536eaf9f59f8fe55bad97cf001d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab041bd5c32608007e7a8f433b9d9e861" id="r_ab041bd5c32608007e7a8f433b9d9e861"><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab041bd5c32608007e7a8f433b9d9e861">toNull</a></td></tr>
<tr class="memdesc:ab041bd5c32608007e7a8f433b9d9e861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remembers the object that is to be assigned 0 during destruction. <br /></td></tr>
<tr class="separator:ab041bd5c32608007e7a8f433b9d9e861"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T&gt;<br />
struct Steinberg::FNuller&lt; T &gt;</div><p>Template definition for classes that help resetting an object's value. </p>
<p>A stack allocated object of this type automatically resets the value of an at construction time passed object to null when it reaches the end of its scope. <br />
<br />
Intended usage: </p><div class="fragment"><div class="line"> <span class="keywordtype">int</span> theObject</div>
<div class="line">= 0;</div>
<div class="line"> {</div>
<div class="line"> <a class="code hl_struct" href="structSteinberg_1_1FNuller.html">Steinberg::FNuller&lt;int&gt;</a> theNuller (theObject);</div>
<div class="line"> </div>
<div class="line"> theObject = 1;</div>
<div class="line"> </div>
<div class="line"> } <span class="comment">// Here the destructor of theNuller resets the value of theObject to 0.</span></div>
<div class="ttc" id="astructSteinberg_1_1FNuller_html"><div class="ttname"><a href="structSteinberg_1_1FNuller.html">Steinberg::FNuller</a></div><div class="ttdoc">Template definition for classes that help resetting an object&#39;s value.</div><div class="ttdef"><b>Definition</b> fcleanup.h:130</div></div>
</div><!-- fragment --> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9fd1a507ebc6f2535cd3130e5bf7cb04" name="a9fd1a507ebc6f2535cd3130e5bf7cb04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fd1a507ebc6f2535cd3130e5bf7cb04">&#9670;&#160;</a></span>FNuller()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSteinberg_1_1FNuller.html">FNuller</a> </td>
<td>(</td>
<td class="paramtype">T &amp;</td> <td class="paramname"><span class="paramname"><em>_toNull</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>_toNull is a reference to the object that is to be assigned 0 when this <a class="el" href="structSteinberg_1_1FNuller.html" title="Template definition for classes that help resetting an object&#39;s value.">FNuller</a> object's destructor is executed. </p>
</div>
</div>
<a id="ab9191536eaf9f59f8fe55bad97cf001d" name="ab9191536eaf9f59f8fe55bad97cf001d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9191536eaf9f59f8fe55bad97cf001d">&#9670;&#160;</a></span>~FNuller()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="structSteinberg_1_1FNuller.html">FNuller</a> </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. Assigns 0 to the at construction time passed object reference. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab041bd5c32608007e7a8f433b9d9e861" name="ab041bd5c32608007e7a8f433b9d9e861"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab041bd5c32608007e7a8f433b9d9e861">&#9670;&#160;</a></span>toNull</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
<tr>
<td class="memname">T&amp; toNull</td>
</tr>
</table>
</div><div class="memdoc">
<p>Remembers the object that is to be assigned 0 during destruction. </p>
</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 &copy;<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>
Reference in New Issue View Git Blame Copy Permalink