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

503 lines
28 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: Allocator</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="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Allocator<div class="ingroups"><a class="el" href="group__coreinit.html">coreinit</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Functions for managing generic allocator objects.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Allocator:</div>
<div class="dyncontent">
<div class="center"><img src="group__coreinit__memallocator.png" border="0" usemap="#agroup____coreinit____memallocator" alt=""/></div>
<map name="agroup____coreinit____memallocator" id="agroup____coreinit____memallocator">
<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="Functions for managing generic allocator objects." alt="" coords="124,5,204,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structMEMAllocator" id="r_structMEMAllocator"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a></td></tr>
<tr class="memdesc:structMEMAllocator"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds context information that will be used to allocate and free memory. <a href="group__coreinit__memallocator.html#structMEMAllocator">More...</a><br /></td></tr>
<tr class="separator:structMEMAllocator"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structMEMAllocatorFunctions" id="r_structMEMAllocatorFunctions"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#structMEMAllocatorFunctions">MEMAllocatorFunctions</a></td></tr>
<tr class="memdesc:structMEMAllocatorFunctions"><td class="mdescLeft">&#160;</td><td class="mdescRight">The alloc/free functions. <a href="group__coreinit__memallocator.html#structMEMAllocatorFunctions">More...</a><br /></td></tr>
<tr class="separator:structMEMAllocatorFunctions"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga216a066acb384fada6d227ba5570b22b" id="r_ga216a066acb384fada6d227ba5570b22b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__memallocator.html#structMEMAllocatorFunctions">MEMAllocatorFunctions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#ga216a066acb384fada6d227ba5570b22b">MEMAllocatorFunctions</a></td></tr>
<tr class="separator:ga216a066acb384fada6d227ba5570b22b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f8db7649b9786b9048cfb37b05151ac" id="r_ga7f8db7649b9786b9048cfb37b05151ac"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#ga7f8db7649b9786b9048cfb37b05151ac">MEMAllocator</a></td></tr>
<tr class="separator:ga7f8db7649b9786b9048cfb37b05151ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9afb33d7a7f12ba59debb055b8acf157" id="r_ga9afb33d7a7f12ba59debb055b8acf157"><td class="memItemLeft" align="right" valign="top">typedef void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#ga9afb33d7a7f12ba59debb055b8acf157">MEMAllocatorAllocFn</a>) (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, uint32_t size)</td></tr>
<tr class="separator:ga9afb33d7a7f12ba59debb055b8acf157"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaebbcd1077bda5b691dbc621eda89474" id="r_gaaebbcd1077bda5b691dbc621eda89474"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#gaaebbcd1077bda5b691dbc621eda89474">MEMAllocatorFreeFn</a>) (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, void *ptr)</td></tr>
<tr class="separator:gaaebbcd1077bda5b691dbc621eda89474"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ga126587c359d2195fa72ef0540982896c" id="r_ga126587c359d2195fa72ef0540982896c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#ga126587c359d2195fa72ef0540982896c">MEMAllocFromAllocator</a> (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, uint32_t size)</td></tr>
<tr class="memdesc:ga126587c359d2195fa72ef0540982896c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates memory from the allocator. <br /></td></tr>
<tr class="separator:ga126587c359d2195fa72ef0540982896c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad690a1a0f3306ba6d4b19606015cfae5" id="r_gad690a1a0f3306ba6d4b19606015cfae5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#gad690a1a0f3306ba6d4b19606015cfae5">MEMFreeToAllocator</a> (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, void *ptr)</td></tr>
<tr class="memdesc:gad690a1a0f3306ba6d4b19606015cfae5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees memory back to the allocator. <br /></td></tr>
<tr class="separator:gad690a1a0f3306ba6d4b19606015cfae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ad741a0b8d5957abb23c43836641206" id="r_ga9ad741a0b8d5957abb23c43836641206"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#ga9ad741a0b8d5957abb23c43836641206">MEMInitAllocatorForExpHeap</a> (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, <a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> heap, uint32_t alignment)</td></tr>
<tr class="memdesc:ga9ad741a0b8d5957abb23c43836641206"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes an allocator from an Expanded Heap. <br /></td></tr>
<tr class="separator:ga9ad741a0b8d5957abb23c43836641206"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae20714b2aab4d982f7256a59fafa641a" id="r_gae20714b2aab4d982f7256a59fafa641a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#gae20714b2aab4d982f7256a59fafa641a">MEMInitAllocatorForFrmHeap</a> (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, <a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> heap, uint32_t alignment)</td></tr>
<tr class="memdesc:gae20714b2aab4d982f7256a59fafa641a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes an allocator from a Frame Heap. <br /></td></tr>
<tr class="separator:gae20714b2aab4d982f7256a59fafa641a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5be6952a78f7e20ab984b897147a048a" id="r_ga5be6952a78f7e20ab984b897147a048a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#ga5be6952a78f7e20ab984b897147a048a">MEMInitAllocatorForUnitHeap</a> (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, <a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> heap)</td></tr>
<tr class="memdesc:ga5be6952a78f7e20ab984b897147a048a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes an allocator from a Unit Heap. <br /></td></tr>
<tr class="separator:ga5be6952a78f7e20ab984b897147a048a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf350a66da4bac29f9a1d6f13748aa339" id="r_gaf350a66da4bac29f9a1d6f13748aa339"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#gaf350a66da4bac29f9a1d6f13748aa339">MEMInitAllocatorForDefaultHeap</a> (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator)</td></tr>
<tr class="memdesc:gaf350a66da4bac29f9a1d6f13748aa339"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes an allocator from the Default Heap. <br /></td></tr>
<tr class="separator:gaf350a66da4bac29f9a1d6f13748aa339"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga973e10e454cdc427a6d4e92292f134db" id="r_ga973e10e454cdc427a6d4e92292f134db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__memallocator.html#ga973e10e454cdc427a6d4e92292f134db">MEMInitAllocatorForBlockHeap</a> (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, <a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a> heap, uint32_t alignment)</td></tr>
<tr class="memdesc:ga973e10e454cdc427a6d4e92292f134db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes an allocator from a Block Heap. <br /></td></tr>
<tr class="separator:ga973e10e454cdc427a6d4e92292f134db"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions for managing generic allocator objects. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structMEMAllocator" id="structMEMAllocator"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structMEMAllocator">&#9670;&#160;</a></span>MEMAllocator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct MEMAllocator</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Holds context information that will be used to allocate and free memory. </p>
<p class="definition">Definition at line <a class="el" href="memallocator_8h_source.html#l00024">24</a> of file <a class="el" href="memallocator_8h_source.html">memallocator.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a3c836c1d989b5543cbf19300e25e2071" name="a3c836c1d989b5543cbf19300e25e2071"></a><a class="el" href="group__coreinit__memallocator.html#structMEMAllocatorFunctions">MEMAllocatorFunctions</a> *</td>
<td class="fieldname">
funcs</td>
<td class="fielddoc">
Points to the alloc/free functions. </td></tr>
<tr><td class="fieldtype">
<a id="a895a604b52e99ffe949053a1172596f2" name="a895a604b52e99ffe949053a1172596f2"></a><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a></td>
<td class="fieldname">
heap</td>
<td class="fielddoc">
The heap handle. </td></tr>
<tr><td class="fieldtype">
<a id="a4864c3686205158c9cab83fa95c2a15a" name="a4864c3686205158c9cab83fa95c2a15a"></a>uint32_t</td>
<td class="fieldname">
align</td>
<td class="fielddoc">
The alignment the allocator will use. </td></tr>
</table>
</div>
</div>
<a name="structMEMAllocatorFunctions" id="structMEMAllocatorFunctions"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structMEMAllocatorFunctions">&#9670;&#160;</a></span>MEMAllocatorFunctions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct MEMAllocatorFunctions</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>The alloc/free functions. </p>
<p class="definition">Definition at line <a class="el" href="memallocator_8h_source.html#l00040">40</a> of file <a class="el" href="memallocator_8h_source.html">memallocator.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a2f092db829a0467a1f1401a6f089ffc6" name="a2f092db829a0467a1f1401a6f089ffc6"></a><a class="el" href="group__coreinit__memallocator.html#ga9afb33d7a7f12ba59debb055b8acf157">MEMAllocatorAllocFn</a></td>
<td class="fieldname">
alloc</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="a632dcb7af99e35944c841fc79e2c00de" name="a632dcb7af99e35944c841fc79e2c00de"></a><a class="el" href="group__coreinit__memallocator.html#gaaebbcd1077bda5b691dbc621eda89474">MEMAllocatorFreeFn</a></td>
<td class="fieldname">
free</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga216a066acb384fada6d227ba5570b22b" name="ga216a066acb384fada6d227ba5570b22b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga216a066acb384fada6d227ba5570b22b">&#9670;&#160;</a></span>MEMAllocatorFunctions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__coreinit__memallocator.html#structMEMAllocatorFunctions">MEMAllocatorFunctions</a> <a class="el" href="group__coreinit__memallocator.html#structMEMAllocatorFunctions">MEMAllocatorFunctions</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memallocator_8h_source.html#l00017">17</a> of file <a class="el" href="memallocator_8h_source.html">memallocator.h</a>.</p>
</div>
</div>
<a id="ga7f8db7649b9786b9048cfb37b05151ac" name="ga7f8db7649b9786b9048cfb37b05151ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7f8db7649b9786b9048cfb37b05151ac">&#9670;&#160;</a></span>MEMAllocator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> <a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memallocator_8h_source.html#l00018">18</a> of file <a class="el" href="memallocator_8h_source.html">memallocator.h</a>.</p>
</div>
</div>
<a id="ga9afb33d7a7f12ba59debb055b8acf157" name="ga9afb33d7a7f12ba59debb055b8acf157"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9afb33d7a7f12ba59debb055b8acf157">&#9670;&#160;</a></span>MEMAllocatorAllocFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void *(* MEMAllocatorAllocFn) (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, uint32_t size)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memallocator_8h_source.html#l00020">20</a> of file <a class="el" href="memallocator_8h_source.html">memallocator.h</a>.</p>
</div>
</div>
<a id="gaaebbcd1077bda5b691dbc621eda89474" name="gaaebbcd1077bda5b691dbc621eda89474"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaebbcd1077bda5b691dbc621eda89474">&#9670;&#160;</a></span>MEMAllocatorFreeFn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* MEMAllocatorFreeFn) (<a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *allocator, void *ptr)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memallocator_8h_source.html#l00021">21</a> of file <a class="el" href="memallocator_8h_source.html">memallocator.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga126587c359d2195fa72ef0540982896c" name="ga126587c359d2195fa72ef0540982896c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga126587c359d2195fa72ef0540982896c">&#9670;&#160;</a></span>MEMAllocFromAllocator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * MEMAllocFromAllocator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *&#160;</td>
<td class="paramname"><em>allocator</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>Allocates memory from the allocator. </p>
<dl class="section return"><dt>Returns</dt><dd><code>allocator-&gt;funcs.alloc(allocator, size)</code>. </dd></dl>
</div>
</div>
<a id="gad690a1a0f3306ba6d4b19606015cfae5" name="gad690a1a0f3306ba6d4b19606015cfae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad690a1a0f3306ba6d4b19606015cfae5">&#9670;&#160;</a></span>MEMFreeToAllocator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MEMFreeToAllocator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *&#160;</td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees memory back to the allocator. </p>
<p>It simply calls <code>allocator-&gt;funcs.free(allocator, ptr)</code>. </p>
</div>
</div>
<a id="ga9ad741a0b8d5957abb23c43836641206" name="ga9ad741a0b8d5957abb23c43836641206"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ad741a0b8d5957abb23c43836641206">&#9670;&#160;</a></span>MEMInitAllocatorForExpHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MEMInitAllocatorForExpHeap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *&#160;</td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td>
<td class="paramname"><em>heap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>alignment</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes an allocator from an Expanded Heap. </p>
</div>
</div>
<a id="gae20714b2aab4d982f7256a59fafa641a" name="gae20714b2aab4d982f7256a59fafa641a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae20714b2aab4d982f7256a59fafa641a">&#9670;&#160;</a></span>MEMInitAllocatorForFrmHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MEMInitAllocatorForFrmHeap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *&#160;</td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td>
<td class="paramname"><em>heap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>alignment</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes an allocator from a Frame Heap. </p>
</div>
</div>
<a id="ga5be6952a78f7e20ab984b897147a048a" name="ga5be6952a78f7e20ab984b897147a048a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5be6952a78f7e20ab984b897147a048a">&#9670;&#160;</a></span>MEMInitAllocatorForUnitHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MEMInitAllocatorForUnitHeap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *&#160;</td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td>
<td class="paramname"><em>heap</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes an allocator from a Unit Heap. </p>
</div>
</div>
<a id="gaf350a66da4bac29f9a1d6f13748aa339" name="gaf350a66da4bac29f9a1d6f13748aa339"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf350a66da4bac29f9a1d6f13748aa339">&#9670;&#160;</a></span>MEMInitAllocatorForDefaultHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MEMInitAllocatorForDefaultHeap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *&#160;</td>
<td class="paramname"><em>allocator</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes an allocator from the Default Heap. </p>
</div>
</div>
<a id="ga973e10e454cdc427a6d4e92292f134db" name="ga973e10e454cdc427a6d4e92292f134db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga973e10e454cdc427a6d4e92292f134db">&#9670;&#160;</a></span>MEMInitAllocatorForBlockHeap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MEMInitAllocatorForBlockHeap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__memallocator.html#structMEMAllocator">MEMAllocator</a> *&#160;</td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__memheap.html#ga3f18df06d1c3949e74a4b7bcb1c0b88c">MEMHeapHandle</a>&#160;</td>
<td class="paramname"><em>heap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>alignment</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes an allocator from a Block Heap. </p>
</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