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__proc__ui__memory.html

292 lines
14 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: ProcUI Memory Operations</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">ProcUI Memory Operations<div class="ingroups"><a class="el" href="group__proc__ui.html">proc_ui</a></div></div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for ProcUI Memory Operations:</div>
<div class="dyncontent">
<div class="center"><img src="group__proc__ui__memory.png" border="0" usemap="#agroup____proc____ui____memory" alt=""/></div>
<map name="agroup____proc____ui____memory" id="agroup____proc____ui____memory">
<area shape="rect" href="group__proc__ui.html" title="Process management library used for managing transitions between foreground and background applicatio..." alt="" coords="5,5,75,31"/>
<area shape="rect" title=" " alt="" coords="123,5,320,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:ga029291bcedc350a422b2b407e2b550ac" id="r_ga029291bcedc350a422b2b407e2b550ac"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__memory.html#ga029291bcedc350a422b2b407e2b550ac">ProcUICalcMemorySize</a> (uint32_t numCallbacks)</td></tr>
<tr class="memdesc:ga029291bcedc350a422b2b407e2b550ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the required size for the memory pool. <br /></td></tr>
<tr class="separator:ga029291bcedc350a422b2b407e2b550ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2bd7ccf969409cb127a677cba4353cde" id="r_ga2bd7ccf969409cb127a677cba4353cde"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__memory.html#ga2bd7ccf969409cb127a677cba4353cde">ProcUISetMemoryPool</a> (void *pool, uint32_t size)</td></tr>
<tr class="memdesc:ga2bd7ccf969409cb127a677cba4353cde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a custom memory pool. <br /></td></tr>
<tr class="separator:ga2bd7ccf969409cb127a677cba4353cde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3ee27a7a81c71dbc68e3c0da2d10d6bc" id="r_ga3ee27a7a81c71dbc68e3c0da2d10d6bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__memory.html#ga3ee27a7a81c71dbc68e3c0da2d10d6bc">ProcUISetCallbackStackSize</a> (uint32_t size)</td></tr>
<tr class="memdesc:ga3ee27a7a81c71dbc68e3c0da2d10d6bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the stack size for the callback threads. <br /></td></tr>
<tr class="separator:ga3ee27a7a81c71dbc68e3c0da2d10d6bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa165fd797427c8d05c060655cc9465a6" id="r_gaa165fd797427c8d05c060655cc9465a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__memory.html#gaa165fd797427c8d05c060655cc9465a6">ProcUISetBucketStorage</a> (void *buf, uint32_t size)</td></tr>
<tr class="memdesc:gaa165fd797427c8d05c060655cc9465a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a buffer to store the foreground bucket data after losing foreground. <br /></td></tr>
<tr class="separator:gaa165fd797427c8d05c060655cc9465a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga02653d414302457aed3c0fbc71655430" id="r_ga02653d414302457aed3c0fbc71655430"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__proc__ui__memory.html#ga02653d414302457aed3c0fbc71655430">ProcUISetMEM1Storage</a> (void *buf, uint32_t size)</td></tr>
<tr class="memdesc:ga02653d414302457aed3c0fbc71655430"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a buffer to store the MEM1 data after losing foreground. <br /></td></tr>
<tr class="separator:ga02653d414302457aed3c0fbc71655430"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga029291bcedc350a422b2b407e2b550ac" name="ga029291bcedc350a422b2b407e2b550ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga029291bcedc350a422b2b407e2b550ac">&#9670;&#160;</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&#160;</td>
<td class="paramname"><em>numCallbacks</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the required size for the memory pool. </p>
<dl class="section see"><dt>See also</dt><dd><ul>
<li><a class="el" href="group__proc__ui__memory.html#ga2bd7ccf969409cb127a677cba4353cde" title="Set a custom memory pool.">ProcUISetMemoryPool()</a></li>
</ul>
</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numCallbacks</td><td>The amount of callbacks which can be registered for each type.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The amount of memory required for the memory pool. </dd></dl>
</div>
</div>
<a id="ga2bd7ccf969409cb127a677cba4353cde" name="ga2bd7ccf969409cb127a677cba4353cde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2bd7ccf969409cb127a677cba4353cde">&#9670;&#160;</a></span>ProcUISetMemoryPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ProcUISetMemoryPool </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>pool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a custom memory pool. </p>
<p>By default all allocations are done from the default heap.</p>
<dl class="section see"><dt>See also</dt><dd><ul>
<li><a class="el" href="group__proc__ui__memory.html#ga029291bcedc350a422b2b407e2b550ac" title="Calculate the required size for the memory pool.">ProcUICalcMemorySize()</a></li>
</ul>
</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pool</td><td>The allocated memory pool.</td></tr>
<tr><td class="paramname">size</td><td>The size of the pool.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>0</code> on success, negative value on error. </dd></dl>
</div>
</div>
<a id="ga3ee27a7a81c71dbc68e3c0da2d10d6bc" name="ga3ee27a7a81c71dbc68e3c0da2d10d6bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3ee27a7a81c71dbc68e3c0da2d10d6bc">&#9670;&#160;</a></span>ProcUISetCallbackStackSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ProcUISetCallbackStackSize </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the stack size for the callback threads. </p>
<p>Default: <code>0x2000</code> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The stack size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa165fd797427c8d05c060655cc9465a6" name="gaa165fd797427c8d05c060655cc9465a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa165fd797427c8d05c060655cc9465a6">&#9670;&#160;</a></span>ProcUISetBucketStorage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ProcUISetBucketStorage </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a buffer to store the foreground bucket data after losing foreground. </p>
<p>Will be automatically restored after re-entering foreground.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>Allocated buffer in MEM2 to store the data.</td></tr>
<tr><td class="paramname">size</td><td>The size of the buffer. Use <a class="el" href="group__coreinit__memory.html#ga381f32576f1c11cc6398be6b350a8619">OSGetForegroundBucketFreeArea</a> to determine the size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga02653d414302457aed3c0fbc71655430" name="ga02653d414302457aed3c0fbc71655430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga02653d414302457aed3c0fbc71655430">&#9670;&#160;</a></span>ProcUISetMEM1Storage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ProcUISetMEM1Storage </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a buffer to store the MEM1 data after losing foreground. </p>
<p>Will be automatically restored after re-entering foreground.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>Allocated buffer in MEM2 to store the data.</td></tr>
<tr><td class="paramname">size</td><td>The size of the buffer. Use <a class="el" href="group__coreinit__memory.html#ga4ca445b0dbea2a2063b1a84bb5b0ad40">OSGetMemBound</a> for <a class="el" href="group__coreinit__memory.html#gga5adafa4b1651c95c686848b6873866eca46057099b28a70b64cfcaa5949d7a79d">OS_MEM1</a> to determine the size. </td></tr>
</table>
</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