290 lines
16 KiB
HTML
290 lines
16 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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libctru: include/3ds/allocator/linear.h File Reference</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">libctru
|
|
 <span id="projectnumber">v2.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<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','.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: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>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_6dafe9e8493a4966457f520acc17aa32.html">allocator</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">linear.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Linear memory allocator.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <stddef.h></code><br />
|
|
</div>
|
|
<p><a href="linear_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a73a6bd0b398a08f695e16e07267a7424"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="linear_8h.html#a73a6bd0b398a08f695e16e07267a7424">linearAlloc</a> (size_t size)</td></tr>
|
|
<tr class="memdesc:a73a6bd0b398a08f695e16e07267a7424"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a 0x80-byte aligned buffer. <a href="linear_8h.html#a73a6bd0b398a08f695e16e07267a7424">More...</a><br /></td></tr>
|
|
<tr class="separator:a73a6bd0b398a08f695e16e07267a7424"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9fe68cfcd17878cbcd7f6d08d846798d"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="linear_8h.html#a9fe68cfcd17878cbcd7f6d08d846798d">linearMemAlign</a> (size_t size, size_t alignment)</td></tr>
|
|
<tr class="memdesc:a9fe68cfcd17878cbcd7f6d08d846798d"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a buffer aligned to the given size. <a href="linear_8h.html#a9fe68cfcd17878cbcd7f6d08d846798d">More...</a><br /></td></tr>
|
|
<tr class="separator:a9fe68cfcd17878cbcd7f6d08d846798d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e40b7ae9d3faccf4fcd137cf1952b92"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="linear_8h.html#a4e40b7ae9d3faccf4fcd137cf1952b92">linearRealloc</a> (void *mem, size_t size)</td></tr>
|
|
<tr class="memdesc:a4e40b7ae9d3faccf4fcd137cf1952b92"><td class="mdescLeft"> </td><td class="mdescRight">Reallocates a buffer. <a href="linear_8h.html#a4e40b7ae9d3faccf4fcd137cf1952b92">More...</a><br /></td></tr>
|
|
<tr class="separator:a4e40b7ae9d3faccf4fcd137cf1952b92"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39e3e3dd46f82252a4470f84d75c8f47"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="linear_8h.html#a39e3e3dd46f82252a4470f84d75c8f47">linearGetSize</a> (void *mem)</td></tr>
|
|
<tr class="memdesc:a39e3e3dd46f82252a4470f84d75c8f47"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the allocated size of a buffer. <a href="linear_8h.html#a39e3e3dd46f82252a4470f84d75c8f47">More...</a><br /></td></tr>
|
|
<tr class="separator:a39e3e3dd46f82252a4470f84d75c8f47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb28d4069fd209e0067ac185fb9b83e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="linear_8h.html#aeb28d4069fd209e0067ac185fb9b83e2">linearFree</a> (void *mem)</td></tr>
|
|
<tr class="memdesc:aeb28d4069fd209e0067ac185fb9b83e2"><td class="mdescLeft"> </td><td class="mdescRight">Frees a buffer. <a href="linear_8h.html#aeb28d4069fd209e0067ac185fb9b83e2">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb28d4069fd209e0067ac185fb9b83e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8d8493cef4d6b8b58e2f07f12f5e090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="linear_8h.html#ab8d8493cef4d6b8b58e2f07f12f5e090">linearSpaceFree</a> (void)</td></tr>
|
|
<tr class="memdesc:ab8d8493cef4d6b8b58e2f07f12f5e090"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current linear free space. <a href="linear_8h.html#ab8d8493cef4d6b8b58e2f07f12f5e090">More...</a><br /></td></tr>
|
|
<tr class="separator:ab8d8493cef4d6b8b58e2f07f12f5e090"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Linear memory allocator. </p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a73a6bd0b398a08f695e16e07267a7424"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73a6bd0b398a08f695e16e07267a7424">◆ </a></span>linearAlloc()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* linearAlloc </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocates a 0x80-byte aligned buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Size of the buffer to allocate. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The allocated buffer. </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a6">audio/filters/source/main.c</a>, <a class="el" href="audio_2mic_2source_2main_8c-example.html#a7">audio/mic/source/main.c</a>, <a class="el" href="audio_2streaming_2source_2main_8c-example.html#a6">audio/streaming/source/main.c</a>, <a class="el" href="graphics_2gpu_2both_screens_2source_2main_8c-example.html#a9">graphics/gpu/both_screens/source/main.c</a>, <a class="el" href="graphics_2gpu_2fragment_light_2source_2main_8c-example.html#a9">graphics/gpu/fragment_light/source/main.c</a>, <a class="el" href="graphics_2gpu_2geoshader_2source_2main_8c-example.html#a10">graphics/gpu/geoshader/source/main.c</a>, <a class="el" href="graphics_2gpu_2lenny_2source_2main_8c-example.html#a9">graphics/gpu/lenny/source/main.c</a>, <a class="el" href="graphics_2gpu_2loop_subdivision_2source_2main_8c-example.html#a12">graphics/gpu/loop_subdivision/source/main.c</a>, <a class="el" href="graphics_2gpu_2mipmap_fog_2source_2main_8c-example.html#a9">graphics/gpu/mipmap_fog/source/main.c</a>, <a class="el" href="graphics_2gpu_2particles_2source_2main_8c-example.html#a16">graphics/gpu/particles/source/main.c</a>, <a class="el" href="graphics_2gpu_2simple_tri_2source_2main_8c-example.html#a9">graphics/gpu/simple_tri/source/main.c</a>, <a class="el" href="graphics_2gpu_2textured_cube_2source_2main_8c-example.html#a9">graphics/gpu/textured_cube/source/main.c</a>, and <a class="el" href="graphics_2gpu_2toon_shading_2source_2main_8c-example.html#a9">graphics/gpu/toon_shading/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeb28d4069fd209e0067ac185fb9b83e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeb28d4069fd209e0067ac185fb9b83e2">◆ </a></span>linearFree()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void linearFree </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>mem</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Frees a buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mem</td><td>Buffer to free. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a36">audio/filters/source/main.c</a>, <a class="el" href="audio_2mic_2source_2main_8c-example.html#a30">audio/mic/source/main.c</a>, <a class="el" href="audio_2streaming_2source_2main_8c-example.html#a28">audio/streaming/source/main.c</a>, <a class="el" href="graphics_2gpu_2both_screens_2source_2main_8c-example.html#a14">graphics/gpu/both_screens/source/main.c</a>, <a class="el" href="graphics_2gpu_2fragment_light_2source_2main_8c-example.html#a17">graphics/gpu/fragment_light/source/main.c</a>, <a class="el" href="graphics_2gpu_2geoshader_2source_2main_8c-example.html#a15">graphics/gpu/geoshader/source/main.c</a>, <a class="el" href="graphics_2gpu_2lenny_2source_2main_8c-example.html#a17">graphics/gpu/lenny/source/main.c</a>, <a class="el" href="graphics_2gpu_2loop_subdivision_2source_2main_8c-example.html#a22">graphics/gpu/loop_subdivision/source/main.c</a>, <a class="el" href="graphics_2gpu_2mipmap_fog_2source_2main_8c-example.html#a19">graphics/gpu/mipmap_fog/source/main.c</a>, <a class="el" href="graphics_2gpu_2particles_2source_2main_8c-example.html#a30">graphics/gpu/particles/source/main.c</a>, <a class="el" href="graphics_2gpu_2simple_tri_2source_2main_8c-example.html#a14">graphics/gpu/simple_tri/source/main.c</a>, <a class="el" href="graphics_2gpu_2textured_cube_2source_2main_8c-example.html#a19">graphics/gpu/textured_cube/source/main.c</a>, <a class="el" href="graphics_2gpu_2toon_shading_2source_2main_8c-example.html#a21">graphics/gpu/toon_shading/source/main.c</a>, and <a class="el" href="mvd_2source_2main_8c-example.html#a43">mvd/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a39e3e3dd46f82252a4470f84d75c8f47"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a39e3e3dd46f82252a4470f84d75c8f47">◆ </a></span>linearGetSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t linearGetSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>mem</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the allocated size of a buffer. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The size of the buffer. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9fe68cfcd17878cbcd7f6d08d846798d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9fe68cfcd17878cbcd7f6d08d846798d">◆ </a></span>linearMemAlign()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* linearMemAlign </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>alignment</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocates a buffer aligned to the given size. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Size of the buffer to allocate. </td></tr>
|
|
<tr><td class="paramname">alignment</td><td>Alignment to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The allocated buffer. </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="mvd_2source_2main_8c-example.html#a38">mvd/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e40b7ae9d3faccf4fcd137cf1952b92"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e40b7ae9d3faccf4fcd137cf1952b92">◆ </a></span>linearRealloc()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* linearRealloc </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>mem</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reallocates a buffer. </p>
|
|
<p>Note: Not implemented yet. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mem</td><td>Buffer to reallocate. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the buffer to allocate. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The reallocated buffer. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab8d8493cef4d6b8b58e2f07f12f5e090"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8d8493cef4d6b8b58e2f07f12f5e090">◆ </a></span>linearSpaceFree()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> linearSpaceFree </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current linear free space. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current linear free space. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|