166 lines
20 KiB
HTML
166 lines
20 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/env.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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">env.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="env_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 env.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief Homebrew environment information.</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> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/// System run-flags.</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span><span class="keyword">enum</span> {</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635ad5366df45cecac4dad1f375eaa0555ab"> 9</a></span>  <a class="code" href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635ad5366df45cecac4dad1f375eaa0555ab">RUNFLAG_APTWORKAROUND</a> = <a class="code" href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a>(0), <span class="comment">///< Use APT workaround.</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635a426e94cb64bcd44449b1a13d3a977df8"> 10</a></span>  <a class="code" href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635a426e94cb64bcd44449b1a13d3a977df8">RUNFLAG_APTREINIT</a> = <a class="code" href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a>(1), <span class="comment">///< Reinitialize APT.</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635a5eedd97be189872a5f91a561fbe33c88"> 11</a></span>  <a class="code" href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635a5eedd97be189872a5f91a561fbe33c88">RUNFLAG_APTCHAINLOAD</a> = <a class="code" href="types_8h.html#a3a8ea58898cb58fc96013383d39f482c">BIT</a>(2), <span class="comment">///< Chainload APT on return.</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> };</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 Gets whether the application was launched from a homebrew environment.</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * @return Whether the application was launched from a homebrew environment.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="env_8h.html#a50c57dd1aacb61a98605a295d3789f11"> 18</a></span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="env_8h.html#a50c57dd1aacb61a98605a295d3789f11">envIsHomebrew</a>(<span class="keywordtype">void</span>) {</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">extern</span> <span class="keywordtype">void</span>* __service_ptr;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordflow">return</span> __service_ptr != NULL;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> }</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @brief Retrieves a handle from the environment handle list.</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * @param name Name of the handle.</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @return The retrieved handle.</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="env_8h.html#ae1721df1d000407fa538b00259de262e"> 28</a></span> <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> <a class="code" href="env_8h.html#ae1721df1d000407fa538b00259de262e">envGetHandle</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</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">/**</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * @brief Gets the environment-recommended app ID to use with APT.</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @return The APT app ID.</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="env_8h.html#a4d416f27dd79249cede1c7339fe08780"> 34</a></span> <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="env_8h.html#a4d416f27dd79249cede1c7339fe08780">envGetAptAppId</a>(<span class="keywordtype">void</span>) {</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">extern</span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> __apt_appid;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">return</span> __apt_appid;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> }</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @brief Gets the size of the application heap.</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @return The application heap size.</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="env_8h.html#aa3efa8e6fd2e8d84001d2ed335253be4"> 43</a></span> <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="env_8h.html#aa3efa8e6fd2e8d84001d2ed335253be4">envGetHeapSize</a>(<span class="keywordtype">void</span>) {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">extern</span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> __ctru_heap_size;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> __ctru_heap_size;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> }</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @brief Gets the size of the linear heap.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @return The linear heap size.</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="env_8h.html#ae6dc788bb31f582a9695659dde4373ac"> 52</a></span> <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="env_8h.html#ae6dc788bb31f582a9695659dde4373ac">envGetLinearHeapSize</a>(<span class="keywordtype">void</span>) {</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">extern</span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> __ctru_linear_heap_size;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> __ctru_linear_heap_size;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @brief Gets the environment argument list.</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * @return The argument list.</span></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"><a class="line" href="env_8h.html#a47b91cce1bdd6c5667f674d5db3357dd"> 61</a></span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="env_8h.html#a47b91cce1bdd6c5667f674d5db3357dd">envGetSystemArgList</a>(<span class="keywordtype">void</span>) {</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* __system_arglist;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">return</span> __system_arglist;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> }</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> </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"> * @brief Gets the environment run flags.</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @return The run flags.</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="env_8h.html#aae27f53918b47d82bb59cc814a25fc15"> 70</a></span> <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="env_8h.html#aae27f53918b47d82bb59cc814a25fc15">envGetSystemRunFlags</a>(<span class="keywordtype">void</span>) {</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">extern</span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> __system_runflags;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> __system_runflags;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div>
|
|
<div class="ttc" id="aenv_8h_html_a47b91cce1bdd6c5667f674d5db3357dd"><div class="ttname"><a href="env_8h.html#a47b91cce1bdd6c5667f674d5db3357dd">envGetSystemArgList</a></div><div class="ttdeci">static const char * envGetSystemArgList(void)</div><div class="ttdoc">Gets the environment argument list.</div><div class="ttdef"><b>Definition:</b> env.h:61</div></div>
|
|
<div class="ttc" id="aenv_8h_html_a4d416f27dd79249cede1c7339fe08780"><div class="ttname"><a href="env_8h.html#a4d416f27dd79249cede1c7339fe08780">envGetAptAppId</a></div><div class="ttdeci">static u32 envGetAptAppId(void)</div><div class="ttdoc">Gets the environment-recommended app ID to use with APT.</div><div class="ttdef"><b>Definition:</b> env.h:34</div></div>
|
|
<div class="ttc" id="aenv_8h_html_a50c57dd1aacb61a98605a295d3789f11"><div class="ttname"><a href="env_8h.html#a50c57dd1aacb61a98605a295d3789f11">envIsHomebrew</a></div><div class="ttdeci">static bool envIsHomebrew(void)</div><div class="ttdoc">Gets whether the application was launched from a homebrew environment.</div><div class="ttdef"><b>Definition:</b> env.h:18</div></div>
|
|
<div class="ttc" id="aenv_8h_html_a726ca809ffd3d67ab4b8476646f26635a426e94cb64bcd44449b1a13d3a977df8"><div class="ttname"><a href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635a426e94cb64bcd44449b1a13d3a977df8">RUNFLAG_APTREINIT</a></div><div class="ttdeci">@ RUNFLAG_APTREINIT</div><div class="ttdoc">Reinitialize APT.</div><div class="ttdef"><b>Definition:</b> env.h:10</div></div>
|
|
<div class="ttc" id="aenv_8h_html_a726ca809ffd3d67ab4b8476646f26635a5eedd97be189872a5f91a561fbe33c88"><div class="ttname"><a href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635a5eedd97be189872a5f91a561fbe33c88">RUNFLAG_APTCHAINLOAD</a></div><div class="ttdeci">@ RUNFLAG_APTCHAINLOAD</div><div class="ttdoc">Chainload APT on return.</div><div class="ttdef"><b>Definition:</b> env.h:11</div></div>
|
|
<div class="ttc" id="aenv_8h_html_a726ca809ffd3d67ab4b8476646f26635ad5366df45cecac4dad1f375eaa0555ab"><div class="ttname"><a href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635ad5366df45cecac4dad1f375eaa0555ab">RUNFLAG_APTWORKAROUND</a></div><div class="ttdeci">@ RUNFLAG_APTWORKAROUND</div><div class="ttdoc">Use APT workaround.</div><div class="ttdef"><b>Definition:</b> env.h:9</div></div>
|
|
<div class="ttc" id="aenv_8h_html_aa3efa8e6fd2e8d84001d2ed335253be4"><div class="ttname"><a href="env_8h.html#aa3efa8e6fd2e8d84001d2ed335253be4">envGetHeapSize</a></div><div class="ttdeci">static u32 envGetHeapSize(void)</div><div class="ttdoc">Gets the size of the application heap.</div><div class="ttdef"><b>Definition:</b> env.h:43</div></div>
|
|
<div class="ttc" id="aenv_8h_html_aae27f53918b47d82bb59cc814a25fc15"><div class="ttname"><a href="env_8h.html#aae27f53918b47d82bb59cc814a25fc15">envGetSystemRunFlags</a></div><div class="ttdeci">static u32 envGetSystemRunFlags(void)</div><div class="ttdoc">Gets the environment run flags.</div><div class="ttdef"><b>Definition:</b> env.h:70</div></div>
|
|
<div class="ttc" id="aenv_8h_html_ae1721df1d000407fa538b00259de262e"><div class="ttname"><a href="env_8h.html#ae1721df1d000407fa538b00259de262e">envGetHandle</a></div><div class="ttdeci">Handle envGetHandle(const char *name)</div><div class="ttdoc">Retrieves a handle from the environment handle list.</div></div>
|
|
<div class="ttc" id="aenv_8h_html_ae6dc788bb31f582a9695659dde4373ac"><div class="ttname"><a href="env_8h.html#ae6dc788bb31f582a9695659dde4373ac">envGetLinearHeapSize</a></div><div class="ttdeci">static u32 envGetLinearHeapSize(void)</div><div class="ttdoc">Gets the size of the linear heap.</div><div class="ttdef"><b>Definition:</b> env.h:52</div></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_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Resource handle.</div><div class="ttdef"><b>Definition:</b> types.h:41</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><!-- 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>
|