OpenShaderDesigner/Documentation/html/struct_open_shader_designer_1_1_event.html

159 lines
7.9 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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenShaderDesigner: OpenShaderDesigner::Event 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="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" />
</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">OpenShaderDesigner<span id="projectnumber">&#160;0.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>OpenShaderDesigner</b></li><li class="navelem"><a class="el" href="struct_open_shader_designer_1_1_event.html">Event</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="struct_open_shader_designer_1_1_event-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">OpenShaderDesigner::Event Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Base <a class="el" href="struct_open_shader_designer_1_1_event.html" title="Base Event class for sending events to the Engine.">Event</a> class for sending events to the <a class="el" href="class_open_shader_designer_1_1_engine.html">Engine</a>.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_event_system_8h_source.html">EventSystem.h</a>&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:a1920b3e03c8e47a463f403cd7c29dc26" id="r_a1920b3e03c8e47a463f403cd7c29dc26"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1920b3e03c8e47a463f403cd7c29dc26">GetID</a> () const =0</td></tr>
<tr class="memdesc:a1920b3e03c8e47a463f403cd7c29dc26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="struct_open_shader_designer_1_1_event.html" title="Base Event class for sending events to the Engine.">Event</a>'s type ID. <br /></td></tr>
<tr class="separator:a1920b3e03c8e47a463f403cd7c29dc26"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:afd225c2e1322d9341d0ad50ab4d7d979" id="r_afd225c2e1322d9341d0ad50ab4d7d979"><td class="memTemplParams" colspan="2"><a id="afd225c2e1322d9341d0ad50ab4d7d979" name="afd225c2e1322d9341d0ad50ab4d7d979"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:afd225c2e1322d9341d0ad50ab4d7d979"><td class="memTemplItemLeft" align="right" valign="top">static uint8_t&#160;</td><td class="memTemplItemRight" valign="bottom"><b>TypeOf</b> ()</td></tr>
<tr class="separator:afd225c2e1322d9341d0ad50ab4d7d979"><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>Base <a class="el" href="struct_open_shader_designer_1_1_event.html" title="Base Event class for sending events to the Engine.">Event</a> class for sending events to the <a class="el" href="class_open_shader_designer_1_1_engine.html">Engine</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1920b3e03c8e47a463f403cd7c29dc26" name="a1920b3e03c8e47a463f403cd7c29dc26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1920b3e03c8e47a463f403cd7c29dc26">&#9670;&#160;</a></span>GetID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t OpenShaderDesigner::Event::GetID </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the <a class="el" href="struct_open_shader_designer_1_1_event.html" title="Base Event class for sending events to the Engine.">Event</a>'s type ID. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the <a class="el" href="struct_open_shader_designer_1_1_event.html" title="Base Event class for sending events to the Engine.">Event</a> type ID. </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>Include/Core/<a class="el" href="_event_system_8h_source.html">EventSystem.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>