civ/hot-step-cpp-ROCm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial release

Browse Source
This commit is contained in:
civ
2026-08-16 18:24:52 +07:00
commit 876886a39a
13244 changed files with 2353959 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
engine/vendor/vst3sdk/doc/vstsdk/namespaceVST3.html
Vendored
+446
View File
@@ -0,0 +1,446 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VST 3 SDK: VST3 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">VST 3 SDK<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('namespaceVST3.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="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">VST3 Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVST3_1_1Hosting.html">Hosting</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVST3_1_1IO.html">IO</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceVST3_1_1StringConvert.html">StringConvert</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVST3_1_1Optional.html">Optional</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVST3_1_1UID.html">UID</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVST3_1_1Version.html">Version</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVST3_1_1Vst2xProgram.html">Vst2xProgram</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">structure holding the content of a vst2 fxp format stream <a href="structVST3_1_1Vst2xProgram.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structVST3_1_1Vst2xState.html">Vst2xState</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">structure holding the content of a vst2 fxb format stream <a href="structVST3_1_1Vst2xState.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:ae40166dd2c8a5e7b724178bf1d8b4289" id="r_ae40166dd2c8a5e7b724178bf1d8b4289"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae40166dd2c8a5e7b724178bf1d8b4289">Vst2xChunk</a> = std::vector&lt;int8_t&gt;</td></tr>
<tr class="separator:ae40166dd2c8a5e7b724178bf1d8b4289"><td class="memSeparator" colspan="2">&#160;</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:a95dc6a5264c9ebdbe258038891ed15b0" id="r_a95dc6a5264c9ebdbe258038891ed15b0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a95dc6a5264c9ebdbe258038891ed15b0">SMTG_DEPRECATED_MSG</a> (&quot;Use <a class="elRef" href="../vstinterfaces/namespaceSteinberg_1_1Vst.html#a55bd8c3496825340789fb380cd6a9dee">Steinberg::Vst::toTChar</a> (...)&quot;) inline const Steinberg</td></tr>
<tr class="separator:a95dc6a5264c9ebdbe258038891ed15b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f8f0d41f800cd4a1dc66d1e6775b241" id="r_a3f8f0d41f800cd4a1dc66d1e6775b241"><td class="memTemplParams" colspan="2">template&lt;typename NumberT&gt; </td></tr>
<tr class="memitem:a3f8f0d41f800cd4a1dc66d1e6775b241"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a3f8f0d41f800cd4a1dc66d1e6775b241">SMTG_DEPRECATED_MSG</a> (&quot;Use <a class="elRef" href="../vstinterfaces/namespaceSteinberg_1_1Vst.html#a450e4b1073502d7b8346a6c0bb856c2d">Steinberg::Vst::toString</a> (...)&quot;) std</td></tr>
<tr class="separator:a3f8f0d41f800cd4a1dc66d1e6775b241"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae01b731f55016701b6d06b9234715889" id="r_ae01b731f55016701b6d06b9234715889"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae01b731f55016701b6d06b9234715889">operator==</a> (const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;uid1, const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;uid2)</td></tr>
<tr class="separator:ae01b731f55016701b6d06b9234715889"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e2936b1c1337e565525459714a83ad7" id="r_a5e2936b1c1337e565525459714a83ad7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5e2936b1c1337e565525459714a83ad7">operator!=</a> (const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;uid1, const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;uid2)</td></tr>
<tr class="separator:a5e2936b1c1337e565525459714a83ad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a837b78a345f5f39cce8b52631e371613" id="r_a837b78a345f5f39cce8b52631e371613"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a837b78a345f5f39cce8b52631e371613">operator&lt;</a> (const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;uid1, const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;uid2)</td></tr>
<tr class="separator:a837b78a345f5f39cce8b52631e371613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadc6b99109a9b056a0176f49f9220822" id="r_aadc6b99109a9b056a0176f49f9220822"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVST3_1_1Optional.html">Optional</a>&lt; <a class="el" href="structVST3_1_1Vst2xState.html">Vst2xState</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aadc6b99109a9b056a0176f49f9220822">tryVst2StateLoad</a> (<a class="elRef" href="../base/classSteinberg_1_1IBStream.html">Steinberg::IBStream</a> &amp;stream, <a class="el" href="structVST3_1_1Optional.html">Optional</a>&lt; int32_t &gt; vst2xUniqueID={}) noexcept</td></tr>
<tr class="memdesc:aadc6b99109a9b056a0176f49f9220822"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try loading the state from an old vst2 fxb format stream. <br /></td></tr>
<tr class="separator:aadc6b99109a9b056a0176f49f9220822"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4c57cb866e8a8343d790c6d60c8a21b" id="r_af4c57cb866e8a8343d790c6d60c8a21b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af4c57cb866e8a8343d790c6d60c8a21b">writeVst2State</a> (const <a class="el" href="structVST3_1_1Vst2xState.html">Vst2xState</a> &amp;state, <a class="elRef" href="../base/classSteinberg_1_1IBStream.html">Steinberg::IBStream</a> &amp;stream, bool writeBypassState=true) noexcept</td></tr>
<tr class="memdesc:af4c57cb866e8a8343d790c6d60c8a21b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a vst2 fxb stream. <br /></td></tr>
<tr class="separator:af4c57cb866e8a8343d790c6d60c8a21b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab373c1cff2f2f5cbb560d5631ca9cf11" id="r_ab373c1cff2f2f5cbb560d5631ca9cf11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVST3_1_1Optional.html">Optional</a>&lt; <a class="el" href="structVST3_1_1Vst2xProgram.html">Vst2xProgram</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab373c1cff2f2f5cbb560d5631ca9cf11">tryVst2ProgramLoad</a> (<a class="elRef" href="../base/classSteinberg_1_1IBStream.html">Steinberg::IBStream</a> &amp;stream, <a class="el" href="structVST3_1_1Optional.html">Optional</a>&lt; int32_t &gt; vst2xUniqueID) noexcept</td></tr>
<tr class="memdesc:ab373c1cff2f2f5cbb560d5631ca9cf11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try loading the state from on old vst2 fxp format stream. <br /></td></tr>
<tr class="separator:ab373c1cff2f2f5cbb560d5631ca9cf11"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ae40166dd2c8a5e7b724178bf1d8b4289" name="ae40166dd2c8a5e7b724178bf1d8b4289"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae40166dd2c8a5e7b724178bf1d8b4289">&#9670;&#160;</a></span>Vst2xChunk</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#ae40166dd2c8a5e7b724178bf1d8b4289">Vst2xChunk</a> = std::vector&lt;int8_t&gt;</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a95dc6a5264c9ebdbe258038891ed15b0" name="a95dc6a5264c9ebdbe258038891ed15b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95dc6a5264c9ebdbe258038891ed15b0">&#9670;&#160;</a></span>SMTG_DEPRECATED_MSG() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SMTG_DEPRECATED_MSG </td>
<td>(</td>
<td class="paramtype">&quot;Use <a class="elRef" href="../vstinterfaces/namespaceSteinberg_1_1Vst.html#a55bd8c3496825340789fb380cd6a9dee">Steinberg::Vst::toTChar</a> (...)&quot;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3f8f0d41f800cd4a1dc66d1e6775b241" name="a3f8f0d41f800cd4a1dc66d1e6775b241"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f8f0d41f800cd4a1dc66d1e6775b241">&#9670;&#160;</a></span>SMTG_DEPRECATED_MSG() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename NumberT&gt; </div>
<table class="memname">
<tr>
<td class="memname">SMTG_DEPRECATED_MSG </td>
<td>(</td>
<td class="paramtype">&quot;Use <a class="elRef" href="../vstinterfaces/namespaceSteinberg_1_1Vst.html#a450e4b1073502d7b8346a6c0bb856c2d">Steinberg::Vst::toString</a> (...)&quot;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae01b731f55016701b6d06b9234715889" name="ae01b731f55016701b6d06b9234715889"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae01b731f55016701b6d06b9234715889">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>uid1</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>uid2</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">
</div>
</div>
<a id="a5e2936b1c1337e565525459714a83ad7" name="a5e2936b1c1337e565525459714a83ad7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e2936b1c1337e565525459714a83ad7">&#9670;&#160;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>uid1</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>uid2</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">
</div>
</div>
<a id="a837b78a345f5f39cce8b52631e371613" name="a837b78a345f5f39cce8b52631e371613"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a837b78a345f5f39cce8b52631e371613">&#9670;&#160;</a></span>operator&lt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator&lt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>uid1</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structVST3_1_1UID.html">UID</a> &amp;</td> <td class="paramname"><span class="paramname"><em>uid2</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">
</div>
</div>
<a id="aadc6b99109a9b056a0176f49f9220822" name="aadc6b99109a9b056a0176f49f9220822"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadc6b99109a9b056a0176f49f9220822">&#9670;&#160;</a></span>tryVst2StateLoad()</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="structVST3_1_1Optional.html">Optional</a>&lt; <a class="el" href="structVST3_1_1Vst2xState.html">Vst2xState</a> &gt; tryVst2StateLoad </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="../base/classSteinberg_1_1IBStream.html">Steinberg::IBStream</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVST3_1_1Optional.html">Optional</a>&lt; int32_t &gt;</td> <td class="paramname"><span class="paramname"><em>vst2xUniqueID</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Try loading the state from an old vst2 fxb format stream. </p>
<p>If successfully loaded, the state has either a chunk or programs but not both The <a class="el" href="structVST3_1_1Vst2xState.html#a3853469785c92d06af40d625b0906984">Vst2xState::isBypassed</a> boolean will be set if a <a class="el" href="namespaceSteinberg.html" title="A replacement for InitModule and DeinitModule.">Steinberg</a> host has written the state into a project and the plug-in was bypassed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>the input stream </td></tr>
<tr><td class="paramname">vst2xUniqueID</td><td>vst2 unique id expected to be stored in the stream [optional]. If present the fxb unique id header entry must be the same as this otherwise the return value is empty. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>on success the optional has a <a class="el" href="structVST3_1_1Vst2xState.html" title="structure holding the content of a vst2 fxb format stream">Vst2xState</a> object with the data </dd></dl>
</div>
</div>
<a id="af4c57cb866e8a8343d790c6d60c8a21b" name="af4c57cb866e8a8343d790c6d60c8a21b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4c57cb866e8a8343d790c6d60c8a21b">&#9670;&#160;</a></span>writeVst2State()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool writeVst2State </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structVST3_1_1Vst2xState.html">Vst2xState</a> &amp;</td> <td class="paramname"><span class="paramname"><em>state</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="../base/classSteinberg_1_1IBStream.html">Steinberg::IBStream</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>writeBypassState</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a vst2 fxb stream. </p>
<p>Writes the state into stream as a vst2 fxb format</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>the state which should be written </td></tr>
<tr><td class="paramname">stream</td><td>the stream where the state should be written into </td></tr>
<tr><td class="paramname">writeBypassState</td><td>write extra chunk with bypass state </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
</div>
</div>
<a id="ab373c1cff2f2f5cbb560d5631ca9cf11" name="ab373c1cff2f2f5cbb560d5631ca9cf11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab373c1cff2f2f5cbb560d5631ca9cf11">&#9670;&#160;</a></span>tryVst2ProgramLoad()</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="structVST3_1_1Optional.html">Optional</a>&lt; <a class="el" href="structVST3_1_1Vst2xProgram.html">Vst2xProgram</a> &gt; tryVst2ProgramLoad </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="../base/classSteinberg_1_1IBStream.html">Steinberg::IBStream</a> &amp;</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVST3_1_1Optional.html">Optional</a>&lt; int32_t &gt;</td> <td class="paramname"><span class="paramname"><em>vst2xUniqueID</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Try loading the state from on old vst2 fxp format stream. </p>
<p>If successfully loaded, the program has either a chunk or plain values but not both</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>the input stream </td></tr>
<tr><td class="paramname">vst2xUniqueID</td><td>vst2 unique id expected to be stored in the stream </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>on success the optional has a <a class="el" href="structVST3_1_1Vst2xProgram.html" title="structure holding the content of a vst2 fxp format stream">Vst2xProgram</a> object with the data </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 &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>