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

240 lines
12 KiB
HTML
Raw 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: FConditionalBoolSetter Struct 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_1FConditionalBoolSetter.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_1FConditionalBoolSetter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">FConditionalBoolSetter Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Class definition for objects that help setting boolean variables.
<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:a46c5ce3d2063724dc2cac0a21fef7529" id="r_a46c5ce3d2063724dc2cac0a21fef7529"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a46c5ce3d2063724dc2cac0a21fef7529">FConditionalBoolSetter</a> (bool &amp;_toSet, bool condition)</td></tr>
<tr class="memdesc:a46c5ce3d2063724dc2cac0a21fef7529"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a46c5ce3d2063724dc2cac0a21fef7529"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a619a26a5580c9ea4043a887063b8b6b7" id="r_a619a26a5580c9ea4043a887063b8b6b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a619a26a5580c9ea4043a887063b8b6b7">~FConditionalBoolSetter</a> ()</td></tr>
<tr class="memdesc:a619a26a5580c9ea4043a887063b8b6b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. Resets the at construction time passed boolean to FALSE. <br /></td></tr>
<tr class="separator:a619a26a5580c9ea4043a887063b8b6b7"><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:a9ace53f30ba43c34f8512bf5e92d2097" id="r_a9ace53f30ba43c34f8512bf5e92d2097"><td class="memItemLeft" align="right" valign="top">bool &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9ace53f30ba43c34f8512bf5e92d2097">toSet</a></td></tr>
<tr class="memdesc:a9ace53f30ba43c34f8512bf5e92d2097"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remembers the boolean that is to be reset during destruction. <br /></td></tr>
<tr class="separator:a9ace53f30ba43c34f8512bf5e92d2097"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class definition for objects that help setting boolean variables. </p>
<p>A stack allocated object of this type automatically sets an at construction time passed boolean variable to TRUE if the given condition is met. At the end of its own scope the stack object will reset the same boolean variable to FALSE, if it wasn't set so already. <br />
<br />
Intended usage: </p><div class="fragment"><div class="line"><span class="keywordtype">bool</span> theBoolean = <span class="keyword">false</span>;</div>
<div class="line">{</div>
<div class="line"> <span class="keywordtype">bool</span> creativityFirst = <span class="keyword">true</span>;</div>
<div class="line"> <a class="code hl_struct" href="structSteinberg_1_1FConditionalBoolSetter.html">Steinberg::FConditionalBoolSetter</a> theCBSetter (theBoolean, creativityFirst);</div>
<div class="line"> <span class="comment">// Here the constructor of theCBSetter sets theBoolean to the value of creativityFirst.</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Do something.</span></div>
<div class="line"> </div>
<div class="line">} <span class="comment">// Here the destructor of theCBSetter resets theBoolean to FALSE.</span></div>
<div class="ttc" id="astructSteinberg_1_1FConditionalBoolSetter_html"><div class="ttname"><a href="structSteinberg_1_1FConditionalBoolSetter.html">Steinberg::FConditionalBoolSetter</a></div><div class="ttdoc">Class definition for objects that help setting boolean variables.</div><div class="ttdef"><b>Definition</b> fcleanup.h:191</div></div>
</div><!-- fragment --> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a46c5ce3d2063724dc2cac0a21fef7529" name="a46c5ce3d2063724dc2cac0a21fef7529"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46c5ce3d2063724dc2cac0a21fef7529">&#9670;&#160;</a></span>FConditionalBoolSetter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSteinberg_1_1FConditionalBoolSetter.html">FConditionalBoolSetter</a> </td>
<td>(</td>
<td class="paramtype">bool &amp;</td> <td class="paramname"><span class="paramname"><em>_toSet</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>condition</em></span>&#160;)</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>_toSet is a reference to the boolean that is to be set. If the in the second parameter given condition is TRUE then also _toSet is set to TRUE immediately. </p>
</div>
</div>
<a id="a619a26a5580c9ea4043a887063b8b6b7" name="a619a26a5580c9ea4043a887063b8b6b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a619a26a5580c9ea4043a887063b8b6b7">&#9670;&#160;</a></span>~FConditionalBoolSetter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="structSteinberg_1_1FConditionalBoolSetter.html">FConditionalBoolSetter</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. Resets the at construction time passed boolean to FALSE. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9ace53f30ba43c34f8512bf5e92d2097" name="a9ace53f30ba43c34f8512bf5e92d2097"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ace53f30ba43c34f8512bf5e92d2097">&#9670;&#160;</a></span>toSet</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool&amp; toSet</td>
</tr>
</table>
</div><div class="memdoc">
<p>Remembers the boolean that is to be reset 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