385 lines
17 KiB
HTML
385 lines
17 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/vram.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="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">vram.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>VRAM allocator.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="vram_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="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:a54434d1829c3f0f2cb7ea4001bff917c"><td class="memItemLeft" align="right" valign="top"><a id="a54434d1829c3f0f2cb7ea4001bff917c"></a>enum  </td><td class="memItemRight" valign="bottom"><b>vramAllocPos</b> { <br />
|
|
  <b>VRAM_ALLOC_A</b> = BIT(0)
|
|
, <br />
|
|
  <b>VRAM_ALLOC_B</b> = BIT(1)
|
|
, <br />
|
|
  <b>VRAM_ALLOC_ANY</b> = VRAM_ALLOC_A | VRAM_ALLOC_B
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a54434d1829c3f0f2cb7ea4001bff917c"><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:a00b84b8d38c127d8af9a89b9b7e2a5a4"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="vram_8h.html#a00b84b8d38c127d8af9a89b9b7e2a5a4">vramAlloc</a> (size_t size)</td></tr>
|
|
<tr class="memdesc:a00b84b8d38c127d8af9a89b9b7e2a5a4"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a 0x80-byte aligned buffer. <a href="vram_8h.html#a00b84b8d38c127d8af9a89b9b7e2a5a4">More...</a><br /></td></tr>
|
|
<tr class="separator:a00b84b8d38c127d8af9a89b9b7e2a5a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c1e150c4927ea04eeff144d47a5c09d"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="vram_8h.html#a4c1e150c4927ea04eeff144d47a5c09d">vramAllocAt</a> (size_t size, vramAllocPos pos)</td></tr>
|
|
<tr class="memdesc:a4c1e150c4927ea04eeff144d47a5c09d"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a 0x80-byte aligned buffer in the given VRAM bank. <a href="vram_8h.html#a4c1e150c4927ea04eeff144d47a5c09d">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c1e150c4927ea04eeff144d47a5c09d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d6d17e0944fd2303b7bb6c8da5ecef6"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="vram_8h.html#a0d6d17e0944fd2303b7bb6c8da5ecef6">vramMemAlign</a> (size_t size, size_t alignment)</td></tr>
|
|
<tr class="memdesc:a0d6d17e0944fd2303b7bb6c8da5ecef6"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a buffer aligned to the given size. <a href="vram_8h.html#a0d6d17e0944fd2303b7bb6c8da5ecef6">More...</a><br /></td></tr>
|
|
<tr class="separator:a0d6d17e0944fd2303b7bb6c8da5ecef6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38a51d518cc71ec6576d3efeea775c89"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="vram_8h.html#a38a51d518cc71ec6576d3efeea775c89">vramMemAlignAt</a> (size_t size, size_t alignment, vramAllocPos pos)</td></tr>
|
|
<tr class="memdesc:a38a51d518cc71ec6576d3efeea775c89"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a buffer aligned to the given size in the given VRAM bank. <a href="vram_8h.html#a38a51d518cc71ec6576d3efeea775c89">More...</a><br /></td></tr>
|
|
<tr class="separator:a38a51d518cc71ec6576d3efeea775c89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab5bec40d445d439bddd2b66c7fdfbfd7"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="vram_8h.html#ab5bec40d445d439bddd2b66c7fdfbfd7">vramRealloc</a> (void *mem, size_t size)</td></tr>
|
|
<tr class="memdesc:ab5bec40d445d439bddd2b66c7fdfbfd7"><td class="mdescLeft"> </td><td class="mdescRight">Reallocates a buffer. <a href="vram_8h.html#ab5bec40d445d439bddd2b66c7fdfbfd7">More...</a><br /></td></tr>
|
|
<tr class="separator:ab5bec40d445d439bddd2b66c7fdfbfd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af56a9ec04d837e21374d285e5351772a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="vram_8h.html#af56a9ec04d837e21374d285e5351772a">vramGetSize</a> (void *mem)</td></tr>
|
|
<tr class="memdesc:af56a9ec04d837e21374d285e5351772a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the allocated size of a buffer. <a href="vram_8h.html#af56a9ec04d837e21374d285e5351772a">More...</a><br /></td></tr>
|
|
<tr class="separator:af56a9ec04d837e21374d285e5351772a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a867318cde93cdd997588d6dcbfc584e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vram_8h.html#a867318cde93cdd997588d6dcbfc584e1">vramFree</a> (void *mem)</td></tr>
|
|
<tr class="memdesc:a867318cde93cdd997588d6dcbfc584e1"><td class="mdescLeft"> </td><td class="mdescRight">Frees a buffer. <a href="vram_8h.html#a867318cde93cdd997588d6dcbfc584e1">More...</a><br /></td></tr>
|
|
<tr class="separator:a867318cde93cdd997588d6dcbfc584e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62360e978f102480949259420e975c7f"><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="vram_8h.html#a62360e978f102480949259420e975c7f">vramSpaceFree</a> (void)</td></tr>
|
|
<tr class="memdesc:a62360e978f102480949259420e975c7f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current VRAM free space. <a href="vram_8h.html#a62360e978f102480949259420e975c7f">More...</a><br /></td></tr>
|
|
<tr class="separator:a62360e978f102480949259420e975c7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>VRAM allocator. </p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a00b84b8d38c127d8af9a89b9b7e2a5a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a00b84b8d38c127d8af9a89b9b7e2a5a4">◆ </a></span>vramAlloc()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* vramAlloc </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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c1e150c4927ea04eeff144d47a5c09d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c1e150c4927ea04eeff144d47a5c09d">◆ </a></span>vramAllocAt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* vramAllocAt </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">vramAllocPos </td>
|
|
<td class="paramname"><em>pos</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocates a 0x80-byte aligned buffer in the given VRAM bank. </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">pos</td><td>VRAM bank to use (see vramAllocPos). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The allocated buffer. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a867318cde93cdd997588d6dcbfc584e1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a867318cde93cdd997588d6dcbfc584e1">◆ </a></span>vramFree()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void vramFree </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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af56a9ec04d837e21374d285e5351772a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af56a9ec04d837e21374d285e5351772a">◆ </a></span>vramGetSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t vramGetSize </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="a0d6d17e0944fd2303b7bb6c8da5ecef6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0d6d17e0944fd2303b7bb6c8da5ecef6">◆ </a></span>vramMemAlign()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* vramMemAlign </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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a38a51d518cc71ec6576d3efeea775c89"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a38a51d518cc71ec6576d3efeea775c89">◆ </a></span>vramMemAlignAt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* vramMemAlignAt </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 class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vramAllocPos </td>
|
|
<td class="paramname"><em>pos</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 in the given VRAM bank. </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>
|
|
<tr><td class="paramname">pos</td><td>VRAM bank to use (see vramAllocPos). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The allocated buffer. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab5bec40d445d439bddd2b66c7fdfbfd7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab5bec40d445d439bddd2b66c7fdfbfd7">◆ </a></span>vramRealloc()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* vramRealloc </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="a62360e978f102480949259420e975c7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62360e978f102480949259420e975c7f">◆ </a></span>vramSpaceFree()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> vramSpaceFree </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 VRAM free space. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current VRAM 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>
|