146 lines
17 KiB
HTML
146 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/services/ptmu.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_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">ptmu.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="ptmu_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 ptmu.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief PTMU service.</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">/// Initializes PTMU.</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="ptmu_8h.html#a69ffa79272f25de2c6050a480036f043"> 8</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ptmu_8h.html#a69ffa79272f25de2c6050a480036f043">ptmuInit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/// Exits PTMU.</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="ptmu_8h.html#a56ac60c3ef9564926ceee79ecb6d3c85"> 11</a></span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="ptmu_8h.html#a56ac60c3ef9564926ceee79ecb6d3c85">ptmuExit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></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"> * @brief Gets a pointer to the current ptm:u session handle.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * @return A pointer to the current ptm:u session handle.</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="ptmu_8h.html#a8d76adceb26c4b1c785af3a78756ec6c"> 17</a></span> <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *<a class="code" href="ptmu_8h.html#a8d76adceb26c4b1c785af3a78756ec6c">ptmuGetSessionHandle</a>(<span class="keywordtype">void</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"> 19</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * @brief Gets the system's current shell state.</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @param out Pointer to write the current shell state to. (0 = closed, 1 = open)</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"><a class="line" href="ptmu_8h.html#adf953372cfbda67c967427f31dc8e68f"> 23</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ptmu_8h.html#adf953372cfbda67c967427f31dc8e68f">PTMU_GetShellState</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out);</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @brief Gets the system's current battery level.</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * @param out Pointer to write the current battery level to. (0-5)</span></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"><a class="line" href="ptmu_8h.html#a82373d4c238c33f3a20586b468233688"> 29</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ptmu_8h.html#a82373d4c238c33f3a20586b468233688">PTMU_GetBatteryLevel</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out);</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">/**</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * @brief Gets the system's current battery charge state.</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @param out Pointer to write the current battery charge state to. (0 = not charging, 1 = charging)</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="ptmu_8h.html#a3a24c72010f8979755de58e19d6b4574"> 35</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ptmu_8h.html#a3a24c72010f8979755de58e19d6b4574">PTMU_GetBatteryChargeState</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out);</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 Gets the system's current pedometer state.</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @param out Pointer to write the current pedometer state to. (0 = not counting, 1 = counting)</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="ptmu_8h.html#ad3c3b5cb00e263bdc27cbf8545dd9b0b"> 41</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ptmu_8h.html#ad3c3b5cb00e263bdc27cbf8545dd9b0b">PTMU_GetPedometerState</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out);</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"> 43</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @brief Gets the pedometer's total step count.</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @param steps Pointer to write the total step count to.</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"><a class="line" href="ptmu_8h.html#a7d6ea0afcf123c0345af5e7e160d230f"> 47</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ptmu_8h.html#a7d6ea0afcf123c0345af5e7e160d230f">PTMU_GetTotalStepCount</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *steps);</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">/**</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @brief Gets whether the adapter is plugged in or not</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @param out Pointer to write the adapter state to.</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="ptmu_8h.html#a245750ffc15a78dd6937567cdbd4effe"> 53</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="ptmu_8h.html#a245750ffc15a78dd6937567cdbd4effe">PTMU_GetAdapterState</a>(<span class="keywordtype">bool</span> *out);</div>
|
|
<div class="ttc" id="aptmu_8h_html_a245750ffc15a78dd6937567cdbd4effe"><div class="ttname"><a href="ptmu_8h.html#a245750ffc15a78dd6937567cdbd4effe">PTMU_GetAdapterState</a></div><div class="ttdeci">Result PTMU_GetAdapterState(bool *out)</div><div class="ttdoc">Gets whether the adapter is plugged in or not.</div></div>
|
|
<div class="ttc" id="aptmu_8h_html_a3a24c72010f8979755de58e19d6b4574"><div class="ttname"><a href="ptmu_8h.html#a3a24c72010f8979755de58e19d6b4574">PTMU_GetBatteryChargeState</a></div><div class="ttdeci">Result PTMU_GetBatteryChargeState(u8 *out)</div><div class="ttdoc">Gets the system's current battery charge state.</div></div>
|
|
<div class="ttc" id="aptmu_8h_html_a56ac60c3ef9564926ceee79ecb6d3c85"><div class="ttname"><a href="ptmu_8h.html#a56ac60c3ef9564926ceee79ecb6d3c85">ptmuExit</a></div><div class="ttdeci">void ptmuExit(void)</div><div class="ttdoc">Exits PTMU.</div></div>
|
|
<div class="ttc" id="aptmu_8h_html_a69ffa79272f25de2c6050a480036f043"><div class="ttname"><a href="ptmu_8h.html#a69ffa79272f25de2c6050a480036f043">ptmuInit</a></div><div class="ttdeci">Result ptmuInit(void)</div><div class="ttdoc">Initializes PTMU.</div></div>
|
|
<div class="ttc" id="aptmu_8h_html_a7d6ea0afcf123c0345af5e7e160d230f"><div class="ttname"><a href="ptmu_8h.html#a7d6ea0afcf123c0345af5e7e160d230f">PTMU_GetTotalStepCount</a></div><div class="ttdeci">Result PTMU_GetTotalStepCount(u32 *steps)</div><div class="ttdoc">Gets the pedometer's total step count.</div></div>
|
|
<div class="ttc" id="aptmu_8h_html_a82373d4c238c33f3a20586b468233688"><div class="ttname"><a href="ptmu_8h.html#a82373d4c238c33f3a20586b468233688">PTMU_GetBatteryLevel</a></div><div class="ttdeci">Result PTMU_GetBatteryLevel(u8 *out)</div><div class="ttdoc">Gets the system's current battery level.</div></div>
|
|
<div class="ttc" id="aptmu_8h_html_a8d76adceb26c4b1c785af3a78756ec6c"><div class="ttname"><a href="ptmu_8h.html#a8d76adceb26c4b1c785af3a78756ec6c">ptmuGetSessionHandle</a></div><div class="ttdeci">Handle * ptmuGetSessionHandle(void)</div><div class="ttdoc">Gets a pointer to the current ptm:u session handle.</div></div>
|
|
<div class="ttc" id="aptmu_8h_html_ad3c3b5cb00e263bdc27cbf8545dd9b0b"><div class="ttname"><a href="ptmu_8h.html#ad3c3b5cb00e263bdc27cbf8545dd9b0b">PTMU_GetPedometerState</a></div><div class="ttdeci">Result PTMU_GetPedometerState(u8 *out)</div><div class="ttdoc">Gets the system's current pedometer state.</div></div>
|
|
<div class="ttc" id="aptmu_8h_html_adf953372cfbda67c967427f31dc8e68f"><div class="ttname"><a href="ptmu_8h.html#adf953372cfbda67c967427f31dc8e68f">PTMU_GetShellState</a></div><div class="ttdeci">Result PTMU_GetShellState(u8 *out)</div><div class="ttdoc">Gets the system's current shell state.</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">would be nice if newlib had this already</div><div class="ttdef"><b>Definition:</b> types.h:21</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_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</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>
|