161 lines
18 KiB
HTML
161 lines
18 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 Source File</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="headertitle">
|
|
<div class="title">vram.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="vram_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file vram.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief VRAM allocator.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> vramAllocPos</div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> {</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  VRAM_ALLOC_A = <a class="code" href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a>(0),</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  VRAM_ALLOC_B = <a class="code" href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a>(1),</div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  VRAM_ALLOC_ANY = VRAM_ALLOC_A | VRAM_ALLOC_B,</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> } vramAllocPos;</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * @brief Allocates a 0x80-byte aligned buffer.</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * @param size Size of the buffer to allocate.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * @return The allocated buffer.</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="vram_8h.html#a00b84b8d38c127d8af9a89b9b7e2a5a4"> 19</a></span> <span class="keywordtype">void</span>* <a class="code" href="vram_8h.html#a00b84b8d38c127d8af9a89b9b7e2a5a4">vramAlloc</a>(<span class="keywordtype">size_t</span> size);</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @brief Allocates a 0x80-byte aligned buffer in the given VRAM bank.</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @param size Size of the buffer to allocate.</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @param pos VRAM bank to use (see \ref vramAllocPos).</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * @return The allocated buffer.</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="vram_8h.html#a4c1e150c4927ea04eeff144d47a5c09d"> 27</a></span> <span class="keywordtype">void</span>* <a class="code" href="vram_8h.html#a4c1e150c4927ea04eeff144d47a5c09d">vramAllocAt</a>(<span class="keywordtype">size_t</span> size, vramAllocPos pos);</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * @brief Allocates a buffer aligned to the given size.</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * @param size Size of the buffer to allocate.</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @param alignment Alignment to use.</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @return The allocated buffer.</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="vram_8h.html#a0d6d17e0944fd2303b7bb6c8da5ecef6"> 35</a></span> <span class="keywordtype">void</span>* <a class="code" href="vram_8h.html#a0d6d17e0944fd2303b7bb6c8da5ecef6">vramMemAlign</a>(<span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> alignment);</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @brief Allocates a buffer aligned to the given size in the given VRAM bank.</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @param size Size of the buffer to allocate.</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @param alignment Alignment to use.</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @param pos VRAM bank to use (see \ref vramAllocPos).</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @return The allocated buffer.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="vram_8h.html#a38a51d518cc71ec6576d3efeea775c89"> 44</a></span> <span class="keywordtype">void</span>* <a class="code" href="vram_8h.html#a38a51d518cc71ec6576d3efeea775c89">vramMemAlignAt</a>(<span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> alignment, vramAllocPos pos);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @brief Reallocates a buffer.</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * Note: Not implemented yet.</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param mem Buffer to reallocate.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @param size Size of the buffer to allocate.</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @return The reallocated buffer.</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="vram_8h.html#ab5bec40d445d439bddd2b66c7fdfbfd7"> 53</a></span> <span class="keywordtype">void</span>* <a class="code" href="vram_8h.html#ab5bec40d445d439bddd2b66c7fdfbfd7">vramRealloc</a>(<span class="keywordtype">void</span>* mem, <span class="keywordtype">size_t</span> size);</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @brief Retrieves the allocated size of a buffer.</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @return The size of the buffer.</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="vram_8h.html#af56a9ec04d837e21374d285e5351772a"> 59</a></span> <span class="keywordtype">size_t</span> <a class="code" href="vram_8h.html#af56a9ec04d837e21374d285e5351772a">vramGetSize</a>(<span class="keywordtype">void</span>* mem);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @brief Frees a buffer.</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @param mem Buffer to free.</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="vram_8h.html#a867318cde93cdd997588d6dcbfc584e1"> 65</a></span> <span class="keywordtype">void</span> <a class="code" href="vram_8h.html#a867318cde93cdd997588d6dcbfc584e1">vramFree</a>(<span class="keywordtype">void</span>* mem);</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @brief Gets the current VRAM free space.</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @return The current VRAM free space.</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="vram_8h.html#a62360e978f102480949259420e975c7f"> 71</a></span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="vram_8h.html#a62360e978f102480949259420e975c7f">vramSpaceFree</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="ttc" id="atypes_8h_html_a3a8ea58898cb58fc96013383d39f482c"><div class="ttname"><a href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a></div><div class="ttdeci">#define BIT(n)</div><div class="ttdoc">Creates a bitmask from a bit number.</div><div class="ttdef"><b>Definition:</b> types.h:47</div></div>
|
|
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
|
|
<div class="ttc" id="avram_8h_html_a00b84b8d38c127d8af9a89b9b7e2a5a4"><div class="ttname"><a href="vram_8h.html#a00b84b8d38c127d8af9a89b9b7e2a5a4">vramAlloc</a></div><div class="ttdeci">void * vramAlloc(size_t size)</div><div class="ttdoc">Allocates a 0x80-byte aligned buffer.</div></div>
|
|
<div class="ttc" id="avram_8h_html_a0d6d17e0944fd2303b7bb6c8da5ecef6"><div class="ttname"><a href="vram_8h.html#a0d6d17e0944fd2303b7bb6c8da5ecef6">vramMemAlign</a></div><div class="ttdeci">void * vramMemAlign(size_t size, size_t alignment)</div><div class="ttdoc">Allocates a buffer aligned to the given size.</div></div>
|
|
<div class="ttc" id="avram_8h_html_a38a51d518cc71ec6576d3efeea775c89"><div class="ttname"><a href="vram_8h.html#a38a51d518cc71ec6576d3efeea775c89">vramMemAlignAt</a></div><div class="ttdeci">void * vramMemAlignAt(size_t size, size_t alignment, vramAllocPos pos)</div><div class="ttdoc">Allocates a buffer aligned to the given size in the given VRAM bank.</div></div>
|
|
<div class="ttc" id="avram_8h_html_a4c1e150c4927ea04eeff144d47a5c09d"><div class="ttname"><a href="vram_8h.html#a4c1e150c4927ea04eeff144d47a5c09d">vramAllocAt</a></div><div class="ttdeci">void * vramAllocAt(size_t size, vramAllocPos pos)</div><div class="ttdoc">Allocates a 0x80-byte aligned buffer in the given VRAM bank.</div></div>
|
|
<div class="ttc" id="avram_8h_html_a62360e978f102480949259420e975c7f"><div class="ttname"><a href="vram_8h.html#a62360e978f102480949259420e975c7f">vramSpaceFree</a></div><div class="ttdeci">u32 vramSpaceFree(void)</div><div class="ttdoc">Gets the current VRAM free space.</div></div>
|
|
<div class="ttc" id="avram_8h_html_a867318cde93cdd997588d6dcbfc584e1"><div class="ttname"><a href="vram_8h.html#a867318cde93cdd997588d6dcbfc584e1">vramFree</a></div><div class="ttdeci">void vramFree(void *mem)</div><div class="ttdoc">Frees a buffer.</div></div>
|
|
<div class="ttc" id="avram_8h_html_ab5bec40d445d439bddd2b66c7fdfbfd7"><div class="ttname"><a href="vram_8h.html#ab5bec40d445d439bddd2b66c7fdfbfd7">vramRealloc</a></div><div class="ttdeci">void * vramRealloc(void *mem, size_t size)</div><div class="ttdoc">Reallocates a buffer.</div></div>
|
|
<div class="ttc" id="avram_8h_html_af56a9ec04d837e21374d285e5351772a"><div class="ttname"><a href="vram_8h.html#af56a9ec04d837e21374d285e5351772a">vramGetSize</a></div><div class="ttdeci">size_t vramGetSize(void *mem)</div><div class="ttdoc">Retrieves the allocated size of a buffer.</div></div>
|
|
</div><!-- fragment --></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>
|