<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>WUT: Event Object</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="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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">WUT
 <span id="projectnumber">0.1</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Event Object<div class="ingroups"><a class="el" href="group__coreinit.html">coreinit</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_o_s_event.html">OSEvent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga2a99a920404e118e9b530e940ebf1b93"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga2a99a920404e118e9b530e940ebf1b93">OS_EVENT_TAG</a>   0x65566E54u</td></tr>
<tr class="separator:ga2a99a920404e118e9b530e940ebf1b93"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga6dff053541cf60f3a34ab013e503382b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_o_s_event.html">OSEvent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga6dff053541cf60f3a34ab013e503382b">OSEvent</a></td></tr>
<tr class="separator:ga6dff053541cf60f3a34ab013e503382b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2c31a79682965fde4cdf1b841f3b6e48"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga2c31a79682965fde4cdf1b841f3b6e48">OSEventMode</a></td></tr>
<tr class="separator:ga2c31a79682965fde4cdf1b841f3b6e48"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga2d1b8c1aaa6e238daac84212cd597d02"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> <tr class="separator:ga2d1b8c1aaa6e238daac84212cd597d02"><td class="memSeparator" colspan="2"> </td></tr>
</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8acaa46f677e69f110a19a2e956ddcd6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga8acaa46f677e69f110a19a2e956ddcd6">OSInitEvent</a> (<a class="el" href="struct_o_s_event.html">OSEvent</a> *event, <a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> value, <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> mode)</td></tr>
<tr class="separator:ga8acaa46f677e69f110a19a2e956ddcd6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga152505eccadef17efdd8b6cca2f8ce2f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga152505eccadef17efdd8b6cca2f8ce2f">OSInitEventEx</a> (<a class="el" href="struct_o_s_event.html">OSEvent</a> *event, <a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> value, <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> mode, char *name)</td></tr>
<tr class="separator:ga152505eccadef17efdd8b6cca2f8ce2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga18f11bbc98f004476e1b7ef5b72b20b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga18f11bbc98f004476e1b7ef5b72b20b4">OSSignalEvent</a> (<a class="el" href="struct_o_s_event.html">OSEvent</a> *event)</td></tr>
<tr class="separator:ga18f11bbc98f004476e1b7ef5b72b20b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e66a2b0c064dd3b280fbb474dd4d083"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga8e66a2b0c064dd3b280fbb474dd4d083">OSSignalEventAll</a> (<a class="el" href="struct_o_s_event.html">OSEvent</a> *event)</td></tr>
<tr class="separator:ga8e66a2b0c064dd3b280fbb474dd4d083"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3c1778dbfa0b9ae29248d4b8fe481c11"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga3c1778dbfa0b9ae29248d4b8fe481c11">OSWaitEvent</a> (<a class="el" href="struct_o_s_event.html">OSEvent</a> *event)</td></tr>
<tr class="separator:ga3c1778dbfa0b9ae29248d4b8fe481c11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga27699986af3f6eee35c6cda0033d071c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#ga27699986af3f6eee35c6cda0033d071c">OSResetEvent</a> (<a class="el" href="struct_o_s_event.html">OSEvent</a> *event)</td></tr>
<tr class="separator:ga27699986af3f6eee35c6cda0033d071c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf35db0845e7b82bff1376df3564174b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__event.html#gaf35db0845e7b82bff1376df3564174b4">OSWaitEventWithTimeout</a> (<a class="el" href="struct_o_s_event.html">OSEvent</a> *event, <a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> timeout)</td></tr>
<tr class="separator:gaf35db0845e7b82bff1376df3564174b4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Standard event object implementation. There are two supported event object modes, check OSEventMode.</p>
<p>Similar to Windows <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms682655(v=vs.85).aspx">Event Objects</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga2a99a920404e118e9b530e940ebf1b93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OS_EVENT_TAG   0x65566E54u</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="coreinit_2event_8h_source.html#l00031">31</a> of file <a class="el" href="coreinit_2event_8h_source.html">event.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga6dff053541cf60f3a34ab013e503382b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct_o_s_event.html">OSEvent</a> <a class="el" href="struct_o_s_event.html">OSEvent</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="coreinit_2event_8h_source.html#l00020">20</a> of file <a class="el" href="coreinit_2event_8h_source.html">event.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga2c31a79682965fde4cdf1b841f3b6e48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga2d1b8c1aaa6e238daac84212cd597d02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga2d1b8c1aaa6e238daac84212cd597d02a15b47b989cf26fdc0bfc7739dd62cbca"></a>OS_EVENT_MODE_MANUAL </td><td class="fielddoc">
<p>A manual event will only reset when OSResetEvent is called. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga2d1b8c1aaa6e238daac84212cd597d02a58aa26fa59ff73667a320f9eca1c6fd6"></a>OS_EVENT_MODE_AUTO </td><td class="fielddoc">
<p>An auto event will reset everytime a thread is woken. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="coreinit_2event_8h_source.html#l00022">22</a> of file <a class="el" href="coreinit_2event_8h_source.html">event.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga8acaa46f677e69f110a19a2e956ddcd6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSInitEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_o_s_event.html">OSEvent</a> * </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialise an event object with value and mode. </p>
</div>
</div>
<a class="anchor" id="ga152505eccadef17efdd8b6cca2f8ce2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSInitEventEx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_o_s_event.html">OSEvent</a> * </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__event.html#ga2d1b8c1aaa6e238daac84212cd597d02">OSEventMode</a> </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialise an event object with value, mode and name. </p>
</div>
</div>
<a class="anchor" id="ga18f11bbc98f004476e1b7ef5b72b20b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSSignalEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_o_s_event.html">OSEvent</a> * </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signals the event.</p>
<p>If no threads are waiting the event value is set.</p>
<p>If the event mode is OS_EVENT_MODE_MANUAL this will wake all waiting threads and the event will remain set until OSResetEvent is called.</p>
<p>If the event mode is OS_EVENT_MODE_AUTO this will wake only one thread and the event will be reset immediately.</p>
<p>Similar to <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms686211(v=vs.85).aspx">SetEvent</a>. </p>
</div>
</div>
<a class="anchor" id="ga8e66a2b0c064dd3b280fbb474dd4d083"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSSignalEventAll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_o_s_event.html">OSEvent</a> * </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signals all threads waiting on an event.</p>
<p>If no threads are waiting the event value is set.</p>
<p>If the event mode is OS_EVENT_MODE_MANUAL this will wake all waiting threads and the event will remain set until OSResetEvent is called.</p>
<p>If the event mode is OS_EVENT_MODE_AUTO this will wake all waiting threads and the event will be reset. </p>
</div>
</div>
<a class="anchor" id="ga3c1778dbfa0b9ae29248d4b8fe481c11"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSWaitEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_o_s_event.html">OSEvent</a> * </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait until an event is signalled.</p>
<p>If the event is already set, this returns immediately.</p>
<p>If the event mode is OS_EVENT_MODE_AUTO the event will be reset before returning from this method.</p>
<p>Similar to <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms687032(v=vs.85).aspx">WaitForSingleObject</a>. </p>
</div>
</div>
<a class="anchor" id="ga27699986af3f6eee35c6cda0033d071c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSResetEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_o_s_event.html">OSEvent</a> * </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the event object.</p>
<p>Similar to <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms685081(v=vs.85).aspx">ResetEvent</a>. </p>
</div>
</div>
<a class="anchor" id="gaf35db0845e7b82bff1376df3564174b4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a050c65e107f0c828f856a231f4b4e788">BOOL</a> OSWaitEventWithTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_o_s_event.html">OSEvent</a> * </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__time.html#ga4d4f771188f6c29e758ed6b3b8347b4d">OSTime</a> </td>
<td class="paramname"><em>timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait until an event is signalled or a timeout has occurred.</p>
<p>Similar to <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/ms687032(v=vs.85).aspx">WaitForSingleObject</a>. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>