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/group__coreinit__core.html

204 lines
9.7 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: Core</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>
</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">
<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="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Core<div class="ingroups"><a class="el" href="group__coreinit.html">coreinit</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Provides information about each core of the system's processor.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Core:</div>
<div class="dyncontent">
<div class="center"><img src="group__coreinit__core.png" border="0" usemap="#agroup____coreinit____core" alt=""/></div>
<map name="agroup____coreinit____core" id="agroup____coreinit____core">
<area shape="rect" href="group__coreinit.html" title="Contains all core operating system functions such as threads, synchronisation objects,..." alt="" coords="5,5,76,31"/>
<area shape="rect" title="Provides information about each core of the system&#39;s processor." alt="" coords="124,5,176,31"/>
</map>
</div>
<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:gad2736cecb831e8d817d4520ddbe2199e" id="r_gad2736cecb831e8d817d4520ddbe2199e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__core.html#gad2736cecb831e8d817d4520ddbe2199e">OSGetCoreCount</a> ()</td></tr>
<tr class="memdesc:gad2736cecb831e8d817d4520ddbe2199e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of cores in the system. <br /></td></tr>
<tr class="separator:gad2736cecb831e8d817d4520ddbe2199e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae46ae66c00e018f914ba43df11035651" id="r_gae46ae66c00e018f914ba43df11035651"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__core.html#gae46ae66c00e018f914ba43df11035651">OSGetCoreId</a> ()</td></tr>
<tr class="memdesc:gae46ae66c00e018f914ba43df11035651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the core executing the current thread. <br /></td></tr>
<tr class="separator:gae46ae66c00e018f914ba43df11035651"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga03db251f12f03a71015d824212f53044" id="r_ga03db251f12f03a71015d824212f53044"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__core.html#ga03db251f12f03a71015d824212f53044">OSGetMainCoreId</a> ()</td></tr>
<tr class="memdesc:ga03db251f12f03a71015d824212f53044"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the main core of the system. <br /></td></tr>
<tr class="separator:ga03db251f12f03a71015d824212f53044"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb060ef03e7d812f07709738601b004e" id="r_gaeb060ef03e7d812f07709738601b004e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__core.html#gaeb060ef03e7d812f07709738601b004e">OSIsMainCore</a> ()</td></tr>
<tr class="memdesc:gaeb060ef03e7d812f07709738601b004e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines whether the current thread is running on the main core. <br /></td></tr>
<tr class="separator:gaeb060ef03e7d812f07709738601b004e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Provides information about each core of the system's processor. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad2736cecb831e8d817d4520ddbe2199e" name="gad2736cecb831e8d817d4520ddbe2199e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad2736cecb831e8d817d4520ddbe2199e">&#9670;&#160;</a></span>OSGetCoreCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t OSGetCoreCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the number of cores in the system. </p>
<p>On a retail Wii U, this is always 3.</p>
<dl class="section return"><dt>Returns</dt><dd>The core count of the system. </dd></dl>
</div>
</div>
<a id="gae46ae66c00e018f914ba43df11035651" name="gae46ae66c00e018f914ba43df11035651"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae46ae66c00e018f914ba43df11035651">&#9670;&#160;</a></span>OSGetCoreId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t OSGetCoreId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the core executing the current thread. </p>
<dl class="section return"><dt>Returns</dt><dd>The ID of the current core. </dd></dl>
</div>
</div>
<a id="ga03db251f12f03a71015d824212f53044" name="ga03db251f12f03a71015d824212f53044"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03db251f12f03a71015d824212f53044">&#9670;&#160;</a></span>OSGetMainCoreId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t OSGetMainCoreId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the main core of the system. </p>
<p>On a retail Wii U, this is always core 1.</p>
<dl class="section return"><dt>Returns</dt><dd>The ID of the main core. </dd></dl>
</div>
</div>
<a id="gaeb060ef03e7d812f07709738601b004e" name="gaeb060ef03e7d812f07709738601b004e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb060ef03e7d812f07709738601b004e">&#9670;&#160;</a></span>OSIsMainCore()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> OSIsMainCore </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether the current thread is running on the main core. </p>
<p>On a retail Wii U, the main core is always core 1.</p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the current core is the main core.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><ul>
<li>
<a class="el" href="group__coreinit__core.html#ga03db251f12f03a71015d824212f53044">OSGetMainCoreId</a></li>
</ul>
</dd></dl>
</div>
</div>
</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