mirror of
https://github.com/wiiu-env/wut.git
synced 2024-12-05 03:24:17 +01:00
772 lines
52 KiB
HTML
772 lines
52 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">
|
|
<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.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>wut: ProcUI</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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">wut
|
|
 <span id="projectnumber">1.0.0-beta9</span>
|
|
</div>
|
|
<div id="projectbrief">Wii U Toolchain</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<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">ProcUI<div class="ingroups"><a class="el" href="group__proc__ui.html">proc_ui</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gae08f8396cbc4f5a1fc92eb3d70643078"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gae08f8396cbc4f5a1fc92eb3d70643078">ProcUISaveCallback</a>) (void)</td></tr>
|
|
<tr class="memdesc:gae08f8396cbc4f5a1fc92eb3d70643078"><td class="mdescLeft"> </td><td class="mdescRight">Called when the application needs to save. <a href="group__proc__ui__procui.html#gae08f8396cbc4f5a1fc92eb3d70643078">More...</a><br /></td></tr>
|
|
<tr class="separator:gae08f8396cbc4f5a1fc92eb3d70643078"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaad92b1b2283d9e294ca4ee0b4f42fd92"><td class="memItemLeft" align="right" valign="top">typedef uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gaad92b1b2283d9e294ca4ee0b4f42fd92">ProcUISaveCallbackEx</a>) (void *)</td></tr>
|
|
<tr class="memdesc:gaad92b1b2283d9e294ca4ee0b4f42fd92"><td class="mdescLeft"> </td><td class="mdescRight">Called when the application needs to save. <a href="group__proc__ui__procui.html#gaad92b1b2283d9e294ca4ee0b4f42fd92">More...</a><br /></td></tr>
|
|
<tr class="separator:gaad92b1b2283d9e294ca4ee0b4f42fd92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6e0e50365a94d1ddb93f85fc85d9e3fa"><td class="memItemLeft" align="right" valign="top">typedef uint32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga6e0e50365a94d1ddb93f85fc85d9e3fa">ProcUICallback</a>) (void *)</td></tr>
|
|
<tr class="memdesc:ga6e0e50365a94d1ddb93f85fc85d9e3fa"><td class="mdescLeft"> </td><td class="mdescRight">Generic ProcUI callback. <a href="group__proc__ui__procui.html#ga6e0e50365a94d1ddb93f85fc85d9e3fa">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6e0e50365a94d1ddb93f85fc85d9e3fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga325accfd3f65aaa794340dc4f10af313"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga325accfd3f65aaa794340dc4f10af313">ProcUICallbackType</a></td></tr>
|
|
<tr class="separator:ga325accfd3f65aaa794340dc4f10af313"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga733548de8bed0d01aff55e74b783b25a"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga733548de8bed0d01aff55e74b783b25a">ProcUIStatus</a></td></tr>
|
|
<tr class="separator:ga733548de8bed0d01aff55e74b783b25a"><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:ga9eba9de3b8f84c2482c358a1493ecda8"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a> { <br />
|
|
  <a class="el" href="group__proc__ui__procui.html#gga9eba9de3b8f84c2482c358a1493ecda8a14172ef5b73cf100d2d87f90ff63af94">PROCUI_CALLBACK_ACQUIRE</a>,
|
|
<br />
|
|
  <a class="el" href="group__proc__ui__procui.html#gga9eba9de3b8f84c2482c358a1493ecda8a2fa189187f6095d962eccd00231be94e">PROCUI_CALLBACK_RELEASE</a>,
|
|
<br />
|
|
  <a class="el" href="group__proc__ui__procui.html#gga9eba9de3b8f84c2482c358a1493ecda8afe1590ca1394fd33548bc1fc6d5f33c8">PROCUI_CALLBACK_EXIT</a>,
|
|
<br />
|
|
  <a class="el" href="group__proc__ui__procui.html#gga9eba9de3b8f84c2482c358a1493ecda8aa4a9e50cd1bb571f73ce31a9dfbe0eeb">PROCUI_CALLBACK_NET_IO_START</a>,
|
|
<br />
|
|
  <a class="el" href="group__proc__ui__procui.html#gga9eba9de3b8f84c2482c358a1493ecda8a577edd8076d43ce61ce10f140ca136af">PROCUI_CALLBACK_NET_IO_STOP</a>,
|
|
<br />
|
|
  <a class="el" href="group__proc__ui__procui.html#gga9eba9de3b8f84c2482c358a1493ecda8a651ffc0a735522261ba2e33ae71e05ed">PROCUI_CALLBACK_HOME_BUTTON_DENIED</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:ga9eba9de3b8f84c2482c358a1493ecda8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gade66d5052242731e3eac46278b7a4f2b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a> { <br />
|
|
  <a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba71de7c3c1b9407f64cea7bb9036c3d36">PROCUI_STATUS_IN_FOREGROUND</a>,
|
|
<br />
|
|
  <a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba7cb4dd11068823c46ebd543f51d3844b">PROCUI_STATUS_IN_BACKGROUND</a>,
|
|
<br />
|
|
  <a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba3a9c97294e921391b07c5ead02678030">PROCUI_STATUS_RELEASE_FOREGROUND</a>,
|
|
<br />
|
|
  <a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2baed39f119bca7f219c93a9dd075d71bcf">PROCUI_STATUS_EXITING</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:gade66d5052242731e3eac46278b7a4f2b"><td class="memSeparator" colspan="2"> </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:gaee2fb9350ecb48ef24704401a4431ca6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gaee2fb9350ecb48ef24704401a4431ca6">ProcUICalcMemorySize</a> (uint32_t unk)</td></tr>
|
|
<tr class="separator:gaee2fb9350ecb48ef24704401a4431ca6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6509e620feaf54dc2e2f7d23313e2f79"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga6509e620feaf54dc2e2f7d23313e2f79">ProcUIClearCallbacks</a> ()</td></tr>
|
|
<tr class="memdesc:ga6509e620feaf54dc2e2f7d23313e2f79"><td class="mdescLeft"> </td><td class="mdescRight">Unregister all ProcUI callbacks. <a href="group__proc__ui__procui.html#ga6509e620feaf54dc2e2f7d23313e2f79">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6509e620feaf54dc2e2f7d23313e2f79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae89a764a7dedc01cfa80ec3a6733c229"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gae89a764a7dedc01cfa80ec3a6733c229">ProcUIDrawDoneRelease</a> ()</td></tr>
|
|
<tr class="memdesc:gae89a764a7dedc01cfa80ec3a6733c229"><td class="mdescLeft"> </td><td class="mdescRight">Signifies to ProcUI that the current application has released all foreground resources, drawn its last frame, and is ready to be moved into the background. <a href="group__proc__ui__procui.html#gae89a764a7dedc01cfa80ec3a6733c229">More...</a><br /></td></tr>
|
|
<tr class="separator:gae89a764a7dedc01cfa80ec3a6733c229"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabeabd14866cfdea46181526148f25727"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gabeabd14866cfdea46181526148f25727">ProcUIInForeground</a> ()</td></tr>
|
|
<tr class="memdesc:gabeabd14866cfdea46181526148f25727"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the application is in the foreground. <a href="group__proc__ui__procui.html#gabeabd14866cfdea46181526148f25727">More...</a><br /></td></tr>
|
|
<tr class="separator:gabeabd14866cfdea46181526148f25727"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga32550ec8e2a44fa047ccd0ed0c2af67c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga32550ec8e2a44fa047ccd0ed0c2af67c">ProcUIInShutdown</a> ()</td></tr>
|
|
<tr class="memdesc:ga32550ec8e2a44fa047ccd0ed0c2af67c"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the application is in shutdown and should quit. <a href="group__proc__ui__procui.html#ga32550ec8e2a44fa047ccd0ed0c2af67c">More...</a><br /></td></tr>
|
|
<tr class="separator:ga32550ec8e2a44fa047ccd0ed0c2af67c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae02b06d5d7a51f364abbfde02cfa14ef"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gae02b06d5d7a51f364abbfde02cfa14ef">ProcUIInit</a> (<a class="el" href="group__proc__ui__procui.html#gae08f8396cbc4f5a1fc92eb3d70643078">ProcUISaveCallback</a> saveCallback)</td></tr>
|
|
<tr class="memdesc:gae02b06d5d7a51f364abbfde02cfa14ef"><td class="mdescLeft"> </td><td class="mdescRight">Initialises the ProcUI library for use. <a href="group__proc__ui__procui.html#gae02b06d5d7a51f364abbfde02cfa14ef">More...</a><br /></td></tr>
|
|
<tr class="separator:gae02b06d5d7a51f364abbfde02cfa14ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga25e6a2ffe24eb8f466869352e619fc3f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga25e6a2ffe24eb8f466869352e619fc3f">ProcUIInitEx</a> (<a class="el" href="group__proc__ui__procui.html#gaad92b1b2283d9e294ca4ee0b4f42fd92">ProcUISaveCallbackEx</a> saveCallback, void *arg)</td></tr>
|
|
<tr class="memdesc:ga25e6a2ffe24eb8f466869352e619fc3f"><td class="mdescLeft"> </td><td class="mdescRight">Initialises the ProcUI library for use; using a save callback that takes arguments. <a href="group__proc__ui__procui.html#ga25e6a2ffe24eb8f466869352e619fc3f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga25e6a2ffe24eb8f466869352e619fc3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga918dbc5c465f8c5f2b9f376cd9354df9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga918dbc5c465f8c5f2b9f376cd9354df9">ProcUIIsRunning</a> ()</td></tr>
|
|
<tr class="memdesc:ga918dbc5c465f8c5f2b9f376cd9354df9"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the application is running. <a href="group__proc__ui__procui.html#ga918dbc5c465f8c5f2b9f376cd9354df9">More...</a><br /></td></tr>
|
|
<tr class="separator:ga918dbc5c465f8c5f2b9f376cd9354df9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab32d41d50911feff627b2b2bc535d00f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gab32d41d50911feff627b2b2bc535d00f">ProcUIProcessMessages</a> (<a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> block)</td></tr>
|
|
<tr class="memdesc:gab32d41d50911feff627b2b2bc535d00f"><td class="mdescLeft"> </td><td class="mdescRight">Main runloop for ProcUI. <a href="group__proc__ui__procui.html#gab32d41d50911feff627b2b2bc535d00f">More...</a><br /></td></tr>
|
|
<tr class="separator:gab32d41d50911feff627b2b2bc535d00f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafe451bcd44c4f7b967b2beec38df0517"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gafe451bcd44c4f7b967b2beec38df0517">ProcUIRegisterCallback</a> (<a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a> type, <a class="el" href="group__proc__ui__procui.html#ga6e0e50365a94d1ddb93f85fc85d9e3fa">ProcUICallback</a> callback, void *param, uint32_t priority)</td></tr>
|
|
<tr class="memdesc:gafe451bcd44c4f7b967b2beec38df0517"><td class="mdescLeft"> </td><td class="mdescRight">Register a callback for certain ProcUI events. <a href="group__proc__ui__procui.html#gafe451bcd44c4f7b967b2beec38df0517">More...</a><br /></td></tr>
|
|
<tr class="separator:gafe451bcd44c4f7b967b2beec38df0517"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaecc3b07dce458491d7c331958ffff701"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#gaecc3b07dce458491d7c331958ffff701">ProcUIRegisterCallbackCore</a> (<a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a> type, <a class="el" href="group__proc__ui__procui.html#ga6e0e50365a94d1ddb93f85fc85d9e3fa">ProcUICallback</a> callback, void *param, uint32_t priority, uint32_t core)</td></tr>
|
|
<tr class="memdesc:gaecc3b07dce458491d7c331958ffff701"><td class="mdescLeft"> </td><td class="mdescRight">Register a callback for certain ProcUI events, executed on the given core. <a href="group__proc__ui__procui.html#gaecc3b07dce458491d7c331958ffff701">More...</a><br /></td></tr>
|
|
<tr class="separator:gaecc3b07dce458491d7c331958ffff701"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1f3302a943ee4921b17d702d5e4c7f59"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga1f3302a943ee4921b17d702d5e4c7f59">ProcUISetSaveCallback</a> (<a class="el" href="group__proc__ui__procui.html#gaad92b1b2283d9e294ca4ee0b4f42fd92">ProcUISaveCallbackEx</a> saveCallback, void *arg)</td></tr>
|
|
<tr class="memdesc:ga1f3302a943ee4921b17d702d5e4c7f59"><td class="mdescLeft"> </td><td class="mdescRight">Sets the save callback. <a href="group__proc__ui__procui.html#ga1f3302a943ee4921b17d702d5e4c7f59">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1f3302a943ee4921b17d702d5e4c7f59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6eee334c8cccc14367c7d972d6d00987"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga6eee334c8cccc14367c7d972d6d00987">ProcUIShutdown</a> ()</td></tr>
|
|
<tr class="memdesc:ga6eee334c8cccc14367c7d972d6d00987"><td class="mdescLeft"> </td><td class="mdescRight">Shut down the ProcUI library for the current application. <a href="group__proc__ui__procui.html#ga6eee334c8cccc14367c7d972d6d00987">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6eee334c8cccc14367c7d972d6d00987"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga93dbed34ef225ecf734045b191b51375"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__procui.html#ga93dbed34ef225ecf734045b191b51375">ProcUISubProcessMessages</a> (<a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> block)</td></tr>
|
|
<tr class="memdesc:ga93dbed34ef225ecf734045b191b51375"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="group__proc__ui__procui.html#gab32d41d50911feff627b2b2bc535d00f" title="Main runloop for ProcUI.">ProcUIProcessMessages()</a>, but for secondary cores. <a href="group__proc__ui__procui.html#ga93dbed34ef225ecf734045b191b51375">More...</a><br /></td></tr>
|
|
<tr class="separator:ga93dbed34ef225ecf734045b191b51375"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>The ProcUI group of functions provide an interface to manage transitions between the different states of an application.</p>
|
|
<p>After calling <a class="el" href="group__proc__ui__procui.html#gae02b06d5d7a51f364abbfde02cfa14ef" title="Initialises the ProcUI library for use.">ProcUIInit()</a> or <a class="el" href="group__proc__ui__procui.html#ga25e6a2ffe24eb8f466869352e619fc3f" title="Initialises the ProcUI library for use; using a save callback that takes arguments.">ProcUIInitEx()</a>, an application may call <a class="el" href="group__proc__ui__procui.html#gab32d41d50911feff627b2b2bc535d00f" title="Main runloop for ProcUI.">ProcUIProcessMessages()</a> to process and update its state. These states may include:</p><ul>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba71de7c3c1b9407f64cea7bb9036c3d36" title="The application is in the foreground. All resources may be used.">PROCUI_STATUS_IN_FOREGROUND</a> - The default state of an application. All system resources and hardware is available, and the application runs without any serious restrictions.</li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba7cb4dd11068823c46ebd543f51d3844b" title="The application is in the background, only limited resources are usable.">PROCUI_STATUS_IN_BACKGROUND</a> - When the user instructs the OS to switch to a secondary application (HOME menu overlay, Internet Browser, etc.) the application enters this background state. Background applications are heavily restricted - they get a small amount of CPU time on core 2 (all other threads are suspended), access to filesystems, and some network IO. They have no access to graphics, inputs or user interaction of any kind.</li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba3a9c97294e921391b07c5ead02678030" title="The application must release the foregound - see ProcUIDrawDoneRelease()">PROCUI_STATUS_RELEASE_FOREGROUND</a> - The user has requested a foreground switch. The current application must release all foreground-only resources, calling <a class="el" href="group__proc__ui__procui.html#gae89a764a7dedc01cfa80ec3a6733c229" title="Signifies to ProcUI that the current application has released all foreground resources,...">ProcUIDrawDoneRelease()</a> when it's ready to go into the background.</li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2baed39f119bca7f219c93a9dd075d71bcf" title="The application must release all resources (including ProcUI) and quit.">PROCUI_STATUS_EXITING</a> - The application must release all resources, call <a class="el" href="group__proc__ui__procui.html#ga6eee334c8cccc14367c7d972d6d00987" title="Shut down the ProcUI library for the current application.">ProcUIShutdown()</a>, and exit.</li>
|
|
</ul>
|
|
<p>An application can determine its state by either examining <a class="el" href="group__proc__ui__procui.html#gab32d41d50911feff627b2b2bc535d00f" title="Main runloop for ProcUI.">ProcUIProcessMessages()</a>'s return value, or using callbacks via <a class="el" href="group__proc__ui__procui.html#gafe451bcd44c4f7b967b2beec38df0517" title="Register a callback for certain ProcUI events.">ProcUIRegisterCallback()</a>. </p>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="gae08f8396cbc4f5a1fc92eb3d70643078"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae08f8396cbc4f5a1fc92eb3d70643078">◆ </a></span>ProcUISaveCallback</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef void(* ProcUISaveCallback) (void)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Called when the application needs to save. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="procui_8h_source.html#l00046">46</a> of file <a class="el" href="procui_8h_source.html">procui.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaad92b1b2283d9e294ca4ee0b4f42fd92"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaad92b1b2283d9e294ca4ee0b4f42fd92">◆ </a></span>ProcUISaveCallbackEx</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef uint32_t(* ProcUISaveCallbackEx) (void *)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Called when the application needs to save. </p>
|
|
<p>void* argument is provided in <a class="el" href="group__proc__ui__procui.html#ga25e6a2ffe24eb8f466869352e619fc3f" title="Initialises the ProcUI library for use; using a save callback that takes arguments.">ProcUIInitEx()</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="procui_8h_source.html#l00051">51</a> of file <a class="el" href="procui_8h_source.html">procui.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6e0e50365a94d1ddb93f85fc85d9e3fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6e0e50365a94d1ddb93f85fc85d9e3fa">◆ </a></span>ProcUICallback</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef uint32_t(* ProcUICallback) (void *)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generic ProcUI callback. </p>
|
|
<p>void* argument is provided in <a class="el" href="group__proc__ui__procui.html#gafe451bcd44c4f7b967b2beec38df0517" title="Register a callback for certain ProcUI events.">ProcUIRegisterCallback()</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="procui_8h_source.html#l00056">56</a> of file <a class="el" href="procui_8h_source.html">procui.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga325accfd3f65aaa794340dc4f10af313"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga325accfd3f65aaa794340dc4f10af313">◆ </a></span>ProcUICallbackType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a> <a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga733548de8bed0d01aff55e74b783b25a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga733548de8bed0d01aff55e74b783b25a">◆ </a></span>ProcUIStatus</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a> <a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ga9eba9de3b8f84c2482c358a1493ecda8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9eba9de3b8f84c2482c358a1493ecda8">◆ </a></span>ProcUICallbackType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9eba9de3b8f84c2482c358a1493ecda8a14172ef5b73cf100d2d87f90ff63af94"></a>PROCUI_CALLBACK_ACQUIRE </td><td class="fielddoc"><p>Application acquires the foreground. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9eba9de3b8f84c2482c358a1493ecda8a2fa189187f6095d962eccd00231be94e"></a>PROCUI_CALLBACK_RELEASE </td><td class="fielddoc"><p>Application must release the foreground. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9eba9de3b8f84c2482c358a1493ecda8afe1590ca1394fd33548bc1fc6d5f33c8"></a>PROCUI_CALLBACK_EXIT </td><td class="fielddoc"><p>Application must exit. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9eba9de3b8f84c2482c358a1493ecda8aa4a9e50cd1bb571f73ce31a9dfbe0eeb"></a>PROCUI_CALLBACK_NET_IO_START </td><td class="fielddoc"><p>Application may start using networking. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9eba9de3b8f84c2482c358a1493ecda8a577edd8076d43ce61ce10f140ca136af"></a>PROCUI_CALLBACK_NET_IO_STOP </td><td class="fielddoc"><p>Application must stop using networking. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9eba9de3b8f84c2482c358a1493ecda8a651ffc0a735522261ba2e33ae71e05ed"></a>PROCUI_CALLBACK_HOME_BUTTON_DENIED </td><td class="fielddoc"><p>The user attempted to press the HOME button but was denied. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="procui_8h_source.html#l00058">58</a> of file <a class="el" href="procui_8h_source.html">procui.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gade66d5052242731e3eac46278b7a4f2b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gade66d5052242731e3eac46278b7a4f2b">◆ </a></span>ProcUIStatus</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggade66d5052242731e3eac46278b7a4f2ba71de7c3c1b9407f64cea7bb9036c3d36"></a>PROCUI_STATUS_IN_FOREGROUND </td><td class="fielddoc"><p>The application is in the foreground. All resources may be used. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggade66d5052242731e3eac46278b7a4f2ba7cb4dd11068823c46ebd543f51d3844b"></a>PROCUI_STATUS_IN_BACKGROUND </td><td class="fielddoc"><p>The application is in the background, only limited resources are usable. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggade66d5052242731e3eac46278b7a4f2ba3a9c97294e921391b07c5ead02678030"></a>PROCUI_STATUS_RELEASE_FOREGROUND </td><td class="fielddoc"><p>The application must release the foregound - see <a class="el" href="group__proc__ui__procui.html#gae89a764a7dedc01cfa80ec3a6733c229" title="Signifies to ProcUI that the current application has released all foreground resources,...">ProcUIDrawDoneRelease()</a> </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggade66d5052242731e3eac46278b7a4f2baed39f119bca7f219c93a9dd075d71bcf"></a>PROCUI_STATUS_EXITING </td><td class="fielddoc"><p>The application must release all resources (including ProcUI) and quit. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="procui_8h_source.html#l00074">74</a> of file <a class="el" href="procui_8h_source.html">procui.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gaee2fb9350ecb48ef24704401a4431ca6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaee2fb9350ecb48ef24704401a4431ca6">◆ </a></span>ProcUICalcMemorySize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t ProcUICalcMemorySize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>unk</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6509e620feaf54dc2e2f7d23313e2f79"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6509e620feaf54dc2e2f7d23313e2f79">◆ </a></span>ProcUIClearCallbacks()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ProcUIClearCallbacks </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unregister all ProcUI callbacks. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><ul>
|
|
<li><a class="el" href="group__proc__ui__procui.html#gafe451bcd44c4f7b967b2beec38df0517" title="Register a callback for certain ProcUI events.">ProcUIRegisterCallback()</a> </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae89a764a7dedc01cfa80ec3a6733c229"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae89a764a7dedc01cfa80ec3a6733c229">◆ </a></span>ProcUIDrawDoneRelease()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ProcUIDrawDoneRelease </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Signifies to ProcUI that the current application has released all foreground resources, drawn its last frame, and is ready to be moved into the background. </p>
|
|
<p>Should only be called when the application is in the <a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba3a9c97294e921391b07c5ead02678030" title="The application must release the foregound - see ProcUIDrawDoneRelease()">PROCUI_STATUS_RELEASE_FOREGROUND</a> state.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>After calling this function, the context will switch next time <a class="el" href="group__proc__ui__procui.html#gab32d41d50911feff627b2b2bc535d00f" title="Main runloop for ProcUI.">ProcUIProcessMessages()</a> is called. All user threads on core 0 and 1 will be suspended once this happens.</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Do not attempt to use foreground-only resources after calling this function and its accompanying <a class="el" href="group__proc__ui__procui.html#gab32d41d50911feff627b2b2bc535d00f" title="Main runloop for ProcUI.">ProcUIProcessMessages()</a>. You should wait until ProcUI indicates <a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba71de7c3c1b9407f64cea7bb9036c3d36" title="The application is in the foreground. All resources may be used.">PROCUI_STATUS_IN_FOREGROUND</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gabeabd14866cfdea46181526148f25727"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabeabd14866cfdea46181526148f25727">◆ </a></span>ProcUIInForeground()</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> ProcUIInForeground </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines whether the application is in the foreground. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the application status is <a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba71de7c3c1b9407f64cea7bb9036c3d36" title="The application is in the foreground. All resources may be used.">PROCUI_STATUS_IN_FOREGROUND</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><ul>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2ba71de7c3c1b9407f64cea7bb9036c3d36" title="The application is in the foreground. All resources may be used.">PROCUI_STATUS_IN_FOREGROUND</a></li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#gafe451bcd44c4f7b967b2beec38df0517" title="Register a callback for certain ProcUI events.">ProcUIRegisterCallback()</a> </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga32550ec8e2a44fa047ccd0ed0c2af67c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga32550ec8e2a44fa047ccd0ed0c2af67c">◆ </a></span>ProcUIInShutdown()</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> ProcUIInShutdown </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines whether the application is in shutdown and should quit. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the application status is <a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2baed39f119bca7f219c93a9dd075d71bcf" title="The application must release all resources (including ProcUI) and quit.">PROCUI_STATUS_EXITING</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><ul>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ggade66d5052242731e3eac46278b7a4f2baed39f119bca7f219c93a9dd075d71bcf" title="The application must release all resources (including ProcUI) and quit.">PROCUI_STATUS_EXITING</a></li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#gafe451bcd44c4f7b967b2beec38df0517" title="Register a callback for certain ProcUI events.">ProcUIRegisterCallback()</a> </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae02b06d5d7a51f364abbfde02cfa14ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae02b06d5d7a51f364abbfde02cfa14ef">◆ </a></span>ProcUIInit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ProcUIInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__proc__ui__procui.html#gae08f8396cbc4f5a1fc92eb3d70643078">ProcUISaveCallback</a> </td>
|
|
<td class="paramname"><em>saveCallback</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialises the ProcUI library for use. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">saveCallback</td><td>A callback to be called when the application needs to save. The callback cannot be NULL and it must call <a class="el" href="group__coreinit__foreground.html#ga41ce26ec13d7c37f0a46e1eb2d5cbcf7">OSSavesDone_ReadyToRelease()</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><ul>
|
|
<li><a class="el" href="group__coreinit__foreground.html#ga41ce26ec13d7c37f0a46e1eb2d5cbcf7">OSSavesDone_ReadyToRelease()</a></li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ga1f3302a943ee4921b17d702d5e4c7f59" title="Sets the save callback.">ProcUISetSaveCallback()</a></li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ga6eee334c8cccc14367c7d972d6d00987" title="Shut down the ProcUI library for the current application.">ProcUIShutdown()</a> </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga25e6a2ffe24eb8f466869352e619fc3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga25e6a2ffe24eb8f466869352e619fc3f">◆ </a></span>ProcUIInitEx()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ProcUIInitEx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__proc__ui__procui.html#gaad92b1b2283d9e294ca4ee0b4f42fd92">ProcUISaveCallbackEx</a> </td>
|
|
<td class="paramname"><em>saveCallback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>arg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialises the ProcUI library for use; using a save callback that takes arguments. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">saveCallback</td><td>A callback to be called when the application needs to save. The callback cannot be NULL and it must call <a class="el" href="group__coreinit__foreground.html#ga41ce26ec13d7c37f0a46e1eb2d5cbcf7">OSSavesDone_ReadyToRelease()</a>.</td></tr>
|
|
<tr><td class="paramname">arg</td><td>An argument to pass into saveCallbackEx.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><ul>
|
|
<li><a class="el" href="group__coreinit__foreground.html#ga41ce26ec13d7c37f0a46e1eb2d5cbcf7">OSSavesDone_ReadyToRelease()</a></li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ga1f3302a943ee4921b17d702d5e4c7f59" title="Sets the save callback.">ProcUISetSaveCallback()</a></li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ga6eee334c8cccc14367c7d972d6d00987" title="Shut down the ProcUI library for the current application.">ProcUIShutdown()</a> </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga918dbc5c465f8c5f2b9f376cd9354df9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga918dbc5c465f8c5f2b9f376cd9354df9">◆ </a></span>ProcUIIsRunning()</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> ProcUIIsRunning </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determines whether the application is running. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the application is running. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab32d41d50911feff627b2b2bc535d00f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab32d41d50911feff627b2b2bc535d00f">◆ </a></span>ProcUIProcessMessages()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a> ProcUIProcessMessages </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> </td>
|
|
<td class="paramname"><em>block</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Main runloop for ProcUI. </p>
|
|
<p>This function processes messages from the OS and provides it an opportinity to take control (to open the HOME menu overlay, for example). Returns the current state of the application.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">block</td><td>Determines whether the function should block before returning. If <code>false</code>, the function returns immediately and all messages and callbacks are processed asynchronously.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current state of the program. See <a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a>. If block is <code>false</code>, this value is undefined and should be ignored.</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>ProcUI's non-blocking mode is not widely used and may have undocumented behaviour. Be careful with callbacks and the return value.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This function should only be called from the main core. See <a class="el" href="group__coreinit__core.html#gaeb060ef03e7d812f07709738601b004e" title="Determines whether the current thread is running on the main core.">OSIsMainCore()</a> and <a class="el" href="group__proc__ui__procui.html#ga93dbed34ef225ecf734045b191b51375" title="ProcUIProcessMessages(), but for secondary cores.">ProcUISubProcessMessages()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gafe451bcd44c4f7b967b2beec38df0517"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gafe451bcd44c4f7b967b2beec38df0517">◆ </a></span>ProcUIRegisterCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ProcUIRegisterCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a> </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__proc__ui__procui.html#ga6e0e50365a94d1ddb93f85fc85d9e3fa">ProcUICallback</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>priority</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Register a callback for certain ProcUI events. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">type</td><td>The event to register a callback for. See <a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a>.</td></tr>
|
|
<tr><td class="paramname">callback</td><td>Function pointer for the callback to call when the given event occurs.</td></tr>
|
|
<tr><td class="paramname">param</td><td>Argument for the callback. This will be passed in as the <em>second</em> argument.</td></tr>
|
|
<tr><td class="paramname">priority</td><td>The priority of the callback.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><ul>
|
|
<li><a class="el" href="group__proc__ui__procui.html#gaecc3b07dce458491d7c331958ffff701" title="Register a callback for certain ProcUI events, executed on the given core.">ProcUIRegisterCallbackCore()</a> </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaecc3b07dce458491d7c331958ffff701"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaecc3b07dce458491d7c331958ffff701">◆ </a></span>ProcUIRegisterCallbackCore()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ProcUIRegisterCallbackCore </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a> </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__proc__ui__procui.html#ga6e0e50365a94d1ddb93f85fc85d9e3fa">ProcUICallback</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>priority</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>core</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Register a callback for certain ProcUI events, executed on the given core. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">type</td><td>The event to register a callback for. See <a class="el" href="group__proc__ui__procui.html#ga9eba9de3b8f84c2482c358a1493ecda8">ProcUICallbackType</a>.</td></tr>
|
|
<tr><td class="paramname">callback</td><td>Function pointer for the callback to call when the given event occurs.</td></tr>
|
|
<tr><td class="paramname">param</td><td>Argument for the callback. This will be passed in as the <em>second</em> argument.</td></tr>
|
|
<tr><td class="paramname">priority</td><td>The priority of the callback.</td></tr>
|
|
<tr><td class="paramname">core</td><td>The core ID to run the callback on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><ul>
|
|
<li><a class="el" href="group__proc__ui__procui.html#gafe451bcd44c4f7b967b2beec38df0517" title="Register a callback for certain ProcUI events.">ProcUIRegisterCallback()</a> </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1f3302a943ee4921b17d702d5e4c7f59"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1f3302a943ee4921b17d702d5e4c7f59">◆ </a></span>ProcUISetSaveCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ProcUISetSaveCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__proc__ui__procui.html#gaad92b1b2283d9e294ca4ee0b4f42fd92">ProcUISaveCallbackEx</a> </td>
|
|
<td class="paramname"><em>saveCallback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>arg</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the save callback. </p>
|
|
<p>Unlike <a class="el" href="group__proc__ui__procui.html#ga25e6a2ffe24eb8f466869352e619fc3f" title="Initialises the ProcUI library for use; using a save callback that takes arguments.">ProcUIInitEx()</a>, this function can be called while ProcUI is already running.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">saveCallback</td><td>A callback to be called when the application needs to save. The callback cannot be NULL and it must call <a class="el" href="group__coreinit__foreground.html#ga41ce26ec13d7c37f0a46e1eb2d5cbcf7">OSSavesDone_ReadyToRelease()</a>.</td></tr>
|
|
<tr><td class="paramname">arg</td><td>An argument to pass into saveCallbackEx.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><ul>
|
|
<li><a class="el" href="group__coreinit__foreground.html#ga41ce26ec13d7c37f0a46e1eb2d5cbcf7">OSSavesDone_ReadyToRelease()</a></li>
|
|
<li><a class="el" href="group__proc__ui__procui.html#ga25e6a2ffe24eb8f466869352e619fc3f" title="Initialises the ProcUI library for use; using a save callback that takes arguments.">ProcUIInitEx()</a> </li>
|
|
</ul>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6eee334c8cccc14367c7d972d6d00987"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6eee334c8cccc14367c7d972d6d00987">◆ </a></span>ProcUIShutdown()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ProcUIShutdown </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Shut down the ProcUI library for the current application. </p>
|
|
<p>This should be called before the app exits.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Do not attempt to use any ProcUI library functions after calling this function, except for <a class="el" href="group__proc__ui__procui.html#gae02b06d5d7a51f364abbfde02cfa14ef" title="Initialises the ProcUI library for use.">ProcUIInit()</a> or <a class="el" href="group__proc__ui__procui.html#ga25e6a2ffe24eb8f466869352e619fc3f" title="Initialises the ProcUI library for use; using a save callback that takes arguments.">ProcUIInitEx()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga93dbed34ef225ecf734045b191b51375"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga93dbed34ef225ecf734045b191b51375">◆ </a></span>ProcUISubProcessMessages()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a> ProcUISubProcessMessages </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> </td>
|
|
<td class="paramname"><em>block</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="group__proc__ui__procui.html#gab32d41d50911feff627b2b2bc535d00f" title="Main runloop for ProcUI.">ProcUIProcessMessages()</a>, but for secondary cores. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">block</td><td>Determines whether the function should block before returning. If <code>false</code>, the function returns immediately and all messages and callbacks are processed asynchronously.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current state of the program - see <a class="el" href="group__proc__ui__procui.html#gade66d5052242731e3eac46278b7a4f2b">ProcUIStatus</a>. If block is <code>false</code>, this value is undefined and should be ignored.</dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>ProcUI's non-blocking mode is not widely used and may have undocumented behaviour. Be careful with callbacks and the return value. </dd></dl>
|
|
|
|
</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.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|