Leahnaya/wut
1
0
Fork 0
mirror of https://github.com/devkitPro/wut.git synced 2026-03-21 17:34:47 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
gh-pages
wut/condition_8h_source.html

157 lines
16 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>wut: /home/runner/work/wut/wut/include/coreinit/condition.h Source File</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>
<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">wut<span id="projectnumber">&#160;v1.9.1</span>
</div>
<div id="projectbrief">Wii U Toolchain</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @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"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_5050f3de292bd66075be80c4b119f1df.html">coreinit</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">condition.h</div></div>
</div><!--header-->
<div class="contents">
<a href="condition_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;<a class="code" href="wut_8h.html">wut.h</a>&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;<a class="code" href="threadqueue_8h.html">threadqueue.h</a>&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#ga00db74c3d6ce5f40511557e92df133eb"> 19</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a> <a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#ga42b7c5a07043d7f6c8324f51ac1747c8"> 20</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a> <a class="code hl_struct" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#ga9d3012d9d937bcd9fcfc12824af9011d"> 22</a></span><span class="preprocessor">#define OS_CONDITION_TAG 0x634E6456u</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="foldopen" id="foldopen00024" data-start="{" data-end="};">
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html"> 24</a></span><span class="keyword">struct </span><a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>{</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#a1c50fcd1195659821729f52af8f3bb7d"> 27</a></span> uint32_t <a class="code hl_variable" href="group__coreinit__cond.html#a1c50fcd1195659821729f52af8f3bb7d">tag</a>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#a8f8f80d37794cde9472343e4487ba3eb"> 30</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="group__coreinit__cond.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> WUT_UNKNOWN_BYTES(4);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#a4c72ffd2d6a41665aa8203649acbb46d"> 35</a></span> <a class="code hl_struct" href="group__coreinit__threadq.html#structOSThreadQueue">OSThreadQueue</a> <a class="code hl_variable" href="group__coreinit__cond.html#a4c72ffd2d6a41665aa8203649acbb46d">queue</a>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>};</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>WUT_CHECK_OFFSET(<a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a>, 0x00, tag);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>WUT_CHECK_OFFSET(<a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a>, 0x04, name);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>WUT_CHECK_OFFSET(<a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a>, 0x0c, queue);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>WUT_CHECK_SIZE(<a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a>, 0x1c);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#ga3380e1614dffb59637175a508d6f8395"> 47</a></span><a class="code hl_function" href="group__coreinit__cond.html#ga3380e1614dffb59637175a508d6f8395">OSInitCond</a>(<a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a> *condition);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#ga3fb5e451c43c561142042258ab65650d"> 54</a></span><a class="code hl_function" href="group__coreinit__cond.html#ga3fb5e451c43c561142042258ab65650d">OSInitCondEx</a>(<a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a> *condition,</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#gab0defea1070e1f129578d98dc023f05d"> 67</a></span><a class="code hl_function" href="group__coreinit__cond.html#gab0defea1070e1f129578d98dc023f05d">OSWaitCond</a>(<a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a> *condition,</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_struct" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a> *mutex);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="group__coreinit__cond.html#ga4ad088d1be5fd1558263491a65b48984"> 77</a></span><a class="code hl_function" href="group__coreinit__cond.html#ga4ad088d1be5fd1558263491a65b48984">OSSignalCond</a>(<a class="code hl_struct" href="group__coreinit__cond.html#structOSCondition">OSCondition</a> *condition);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>}</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="ttc" id="agroup__coreinit__cond_html_a1c50fcd1195659821729f52af8f3bb7d"><div class="ttname"><a href="group__coreinit__cond.html#a1c50fcd1195659821729f52af8f3bb7d">OSCondition::tag</a></div><div class="ttdeci">uint32_t tag</div><div class="ttdoc">Should always be set to the value OS_CONDITION_TAG.</div><div class="ttdef"><b>Definition</b> <a href="condition_8h_source.html#l00027">condition.h:27</a></div></div>
<div class="ttc" id="agroup__coreinit__cond_html_a4c72ffd2d6a41665aa8203649acbb46d"><div class="ttname"><a href="group__coreinit__cond.html#a4c72ffd2d6a41665aa8203649acbb46d">OSCondition::queue</a></div><div class="ttdeci">OSThreadQueue queue</div><div class="ttdoc">Queue of threads currently waiting on condition with OSWaitCond.</div><div class="ttdef"><b>Definition</b> <a href="condition_8h_source.html#l00035">condition.h:35</a></div></div>
<div class="ttc" id="agroup__coreinit__cond_html_a8f8f80d37794cde9472343e4487ba3eb"><div class="ttname"><a href="group__coreinit__cond.html#a8f8f80d37794cde9472343e4487ba3eb">OSCondition::name</a></div><div class="ttdeci">const char * name</div><div class="ttdoc">Name set by OSInitCondEx.</div><div class="ttdef"><b>Definition</b> <a href="condition_8h_source.html#l00030">condition.h:30</a></div></div>
<div class="ttc" id="agroup__coreinit__cond_html_ga3380e1614dffb59637175a508d6f8395"><div class="ttname"><a href="group__coreinit__cond.html#ga3380e1614dffb59637175a508d6f8395">OSInitCond</a></div><div class="ttdeci">void OSInitCond(OSCondition *condition)</div><div class="ttdoc">Initialise a condition variable structure.</div></div>
<div class="ttc" id="agroup__coreinit__cond_html_ga3fb5e451c43c561142042258ab65650d"><div class="ttname"><a href="group__coreinit__cond.html#ga3fb5e451c43c561142042258ab65650d">OSInitCondEx</a></div><div class="ttdeci">void OSInitCondEx(OSCondition *condition, const char *name)</div><div class="ttdoc">Initialise a condition variable structure with a name.</div></div>
<div class="ttc" id="agroup__coreinit__cond_html_ga4ad088d1be5fd1558263491a65b48984"><div class="ttname"><a href="group__coreinit__cond.html#ga4ad088d1be5fd1558263491a65b48984">OSSignalCond</a></div><div class="ttdeci">void OSSignalCond(OSCondition *condition)</div><div class="ttdoc">Will wake up any threads waiting on the condition with OSWaitCond.</div></div>
<div class="ttc" id="agroup__coreinit__cond_html_gab0defea1070e1f129578d98dc023f05d"><div class="ttname"><a href="group__coreinit__cond.html#gab0defea1070e1f129578d98dc023f05d">OSWaitCond</a></div><div class="ttdeci">void OSWaitCond(OSCondition *condition, OSMutex *mutex)</div><div class="ttdoc">Sleep the current thread until the condition variable has been signalled.</div></div>
<div class="ttc" id="agroup__coreinit__cond_html_structOSCondition"><div class="ttname"><a href="group__coreinit__cond.html#structOSCondition">OSCondition</a></div><div class="ttdef"><b>Definition</b> <a href="condition_8h_source.html#l00024">condition.h:25</a></div></div>
<div class="ttc" id="agroup__coreinit__mutex_html_structOSMutex"><div class="ttname"><a href="group__coreinit__mutex.html#structOSMutex">OSMutex</a></div><div class="ttdef"><b>Definition</b> <a href="mutex_8h_source.html#l00035">mutex.h:36</a></div></div>
<div class="ttc" id="agroup__coreinit__threadq_html_structOSThreadQueue"><div class="ttname"><a href="group__coreinit__threadq.html#structOSThreadQueue">OSThreadQueue</a></div><div class="ttdef"><b>Definition</b> <a href="threadqueue_8h_source.html#l00029">threadqueue.h:30</a></div></div>
<div class="ttc" id="athreadqueue_8h_html"><div class="ttname"><a href="threadqueue_8h.html">threadqueue.h</a></div></div>
<div class="ttc" id="awut_8h_html"><div class="ttname"><a href="wut_8h.html">wut.h</a></div></div>
</div><!-- fragment --></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.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink