xaymar/VST2SDK
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases 9 Wiki Activity
Files
documentation
VST2SDK/structvst__event__t.html
T
GitHub Actions 9a93120a4e 339d4f3159
2025-08-18 01:26:19 +00:00

208 lines
12 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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VST2SDK: vst_event_t 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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
</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">VST2SDK
</div>
<div id="projectbrief">A recreation of the popular Steinberg VST 2.x SDK.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" 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');
$(document).ready(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 */
$(document).ready(function(){initNavTree('structvst__event__t.html',''); initResizable(); });
/* @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-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">vst_event_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A generic event.
<a href="structvst__event__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vst_8h_source.html">vst.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a3260509d68d4e9328ba7f69d48b8c77a" id="r_a3260509d68d4e9328ba7f69d48b8c77a"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__event__t.html#a3260509d68d4e9328ba7f69d48b8c77a">type</a></td></tr>
<tr class="memdesc:a3260509d68d4e9328ba7f69d48b8c77a"><td class="mdescLeft">&#160;</td><td class="mdescRight">What event type was triggered? Any of <a class="el" href="vst_8h.html#a06cdf00c4eb074ac3677408d259616bf">VST_EVENT_TYPE</a>. <br /></td></tr>
<tr class="separator:a3260509d68d4e9328ba7f69d48b8c77a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a636047a7d1be3154bad83ce187ecf6e5" id="r_a636047a7d1be3154bad83ce187ecf6e5"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__event__t.html#a636047a7d1be3154bad83ce187ecf6e5">size</a></td></tr>
<tr class="memdesc:a636047a7d1be3154bad83ce187ecf6e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Content size in bytes. <br /></td></tr>
<tr class="separator:a636047a7d1be3154bad83ce187ecf6e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5409ce4236e5de3f33be066972171643" id="r_a5409ce4236e5de3f33be066972171643"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__event__t.html#a5409ce4236e5de3f33be066972171643">offset</a></td></tr>
<tr class="memdesc:a5409ce4236e5de3f33be066972171643"><td class="mdescLeft">&#160;</td><td class="mdescRight">Offset of the event relative to some position. <br /></td></tr>
<tr class="separator:a5409ce4236e5de3f33be066972171643"><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>A generic event. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structvst__events__t.html" title="A collection of events.">vst_events_t</a> </dd>
<dd>
<a class="el" href="structvst__host__supports__t.html#a4cf927ab8060c5afc39c4940e8d3b4aa" title="Host can send events to plug-in.">vst_host_supports_t.sendVstEvents</a> </dd>
<dd>
<a class="el" href="structvst__host__supports__t.html#aa373ce1fbc010668609eceb8b5b8d380" title="Host can receive events from plug-in.">vst_host_supports_t.receiveVstEvents</a> </dd>
<dd>
<a class="el" href="structvst__effect__supports__t.html#a6a4bc33d77e38c2a6dcb2338f80adbcd" title="Plug-in can send events to host.">vst_effect_supports_t.sendVstEvents</a> </dd>
<dd>
<a class="el" href="structvst__effect__supports__t.html#a9b59e445c1974d4936b04a38aed6d9c8" title="Plug-in can receive events from host.">vst_effect_supports_t.receiveVstEvents</a> </dd>
<dd>
<a class="el" href="vst_8h.html#abfb1cdba3c236829cb63d4196f33d696a9f3b153f7398c429a3fc6d64e2fed9a6">VST_EFFECT_OPCODE_EVENT</a> </dd>
<dd>
<a class="el" href="vst_8h.html#a223eb6814e8e03b7f89687280db8b8eca088c2539d52fbb2469a3bca15fd73b52">VST_HOST_OPCODE_EVENT</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00855">855</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a5409ce4236e5de3f33be066972171643" name="a5409ce4236e5de3f33be066972171643"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5409ce4236e5de3f33be066972171643">&#9670;&#160;</a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t vst_event_t::offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>Offset of the event relative to some position. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>What position is this relative to? </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00875">875</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<a id="a636047a7d1be3154bad83ce187ecf6e5" name="a636047a7d1be3154bad83ce187ecf6e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a636047a7d1be3154bad83ce187ecf6e5">&#9670;&#160;</a></span>size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t vst_event_t::size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Content size in bytes. </p>
<p>The size is calculated excluding <a class="el" href="structvst__event__t.html#a3260509d68d4e9328ba7f69d48b8c77a">type</a> and <a class="el" href="structvst__event__t.html#a636047a7d1be3154bad83ce187ecf6e5">size</a>. </p><div class="fragment"><div class="line"><a class="code hl_struct" href="structvst__event__t.html">vst_event_t</a> myevent;</div>
<div class="line">myevent.<a class="code hl_variable" href="structvst__event__t.html#a636047a7d1be3154bad83ce187ecf6e5">size</a> = <span class="keyword">sizeof</span>(<a class="code hl_struct" href="structvst__event__t.html">vst_event_t</a>) - <span class="keyword">sizeof</span>(<a class="code hl_struct" href="structvst__event__t.html">vst_event_t</a>.<a class="code hl_variable" href="structvst__event__t.html#a3260509d68d4e9328ba7f69d48b8c77a">type</a>) - <span class="keyword">sizeof</span>(<a class="code hl_struct" href="structvst__event__t.html">vst_event_t</a>.<a class="code hl_variable" href="structvst__event__t.html#a636047a7d1be3154bad83ce187ecf6e5">size</a>);</div>
<div class="ttc" id="astructvst__event__t_html"><div class="ttname"><a href="structvst__event__t.html">vst_event_t</a></div><div class="ttdoc">A generic event.</div><div class="ttdef"><b>Definition</b> <a href="vst_8h_source.html#l00855">vst.h:855</a></div></div>
<div class="ttc" id="astructvst__event__t_html_a3260509d68d4e9328ba7f69d48b8c77a"><div class="ttname"><a href="structvst__event__t.html#a3260509d68d4e9328ba7f69d48b8c77a">vst_event_t::type</a></div><div class="ttdeci">int32_t type</div><div class="ttdoc">What event type was triggered? Any of VST_EVENT_TYPE.</div><div class="ttdef"><b>Definition</b> <a href="vst_8h_source.html#l00859">vst.h:859</a></div></div>
<div class="ttc" id="astructvst__event__t_html_a636047a7d1be3154bad83ce187ecf6e5"><div class="ttname"><a href="structvst__event__t.html#a636047a7d1be3154bad83ce187ecf6e5">vst_event_t::size</a></div><div class="ttdeci">int32_t size</div><div class="ttdoc">Content size in bytes.</div><div class="ttdef"><b>Definition</b> <a href="vst_8h_source.html#l00869">vst.h:869</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00869">869</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<a id="a3260509d68d4e9328ba7f69d48b8c77a" name="a3260509d68d4e9328ba7f69d48b8c77a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3260509d68d4e9328ba7f69d48b8c77a">&#9670;&#160;</a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t vst_event_t::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>What event type was triggered? Any of <a class="el" href="vst_8h.html#a06cdf00c4eb074ac3677408d259616bf">VST_EVENT_TYPE</a>. </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00859">859</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="vst_8h_source.html">vst.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structvst__event__t.html">vst_event_t</a></li>
<li class="footer">Generated on Mon Aug 18 2025 01:26:19 for VST2SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink