DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
gh-pages
libctru/ptmu_8h.html
WinterMute e52f3175e1 Deploying to gh-pages from @ 8cbcce773b 🚀
2024-11-03 20:36:34 +00:00

300 lines
16 KiB
HTML
Raw Permalink Blame History

<!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 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
&#160;<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&amp;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&amp;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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ptmu.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>PTMU service.
<a href="#details">More...</a></p>
<p><a href="ptmu_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:a69ffa79272f25de2c6050a480036f043"><td class="memItemLeft" align="right" valign="top"><a id="a69ffa79272f25de2c6050a480036f043"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ptmu_8h.html#a69ffa79272f25de2c6050a480036f043">ptmuInit</a> (void)</td></tr>
<tr class="memdesc:a69ffa79272f25de2c6050a480036f043"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes PTMU. <br /></td></tr>
<tr class="separator:a69ffa79272f25de2c6050a480036f043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56ac60c3ef9564926ceee79ecb6d3c85"><td class="memItemLeft" align="right" valign="top"><a id="a56ac60c3ef9564926ceee79ecb6d3c85"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ptmu_8h.html#a56ac60c3ef9564926ceee79ecb6d3c85">ptmuExit</a> (void)</td></tr>
<tr class="memdesc:a56ac60c3ef9564926ceee79ecb6d3c85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits PTMU. <br /></td></tr>
<tr class="separator:a56ac60c3ef9564926ceee79ecb6d3c85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d76adceb26c4b1c785af3a78756ec6c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ptmu_8h.html#a8d76adceb26c4b1c785af3a78756ec6c">ptmuGetSessionHandle</a> (void)</td></tr>
<tr class="memdesc:a8d76adceb26c4b1c785af3a78756ec6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a pointer to the current ptm:u session handle. <a href="ptmu_8h.html#a8d76adceb26c4b1c785af3a78756ec6c">More...</a><br /></td></tr>
<tr class="separator:a8d76adceb26c4b1c785af3a78756ec6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf953372cfbda67c967427f31dc8e68f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ptmu_8h.html#adf953372cfbda67c967427f31dc8e68f">PTMU_GetShellState</a> (<a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out)</td></tr>
<tr class="memdesc:adf953372cfbda67c967427f31dc8e68f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the system's current shell state. <a href="ptmu_8h.html#adf953372cfbda67c967427f31dc8e68f">More...</a><br /></td></tr>
<tr class="separator:adf953372cfbda67c967427f31dc8e68f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82373d4c238c33f3a20586b468233688"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ptmu_8h.html#a82373d4c238c33f3a20586b468233688">PTMU_GetBatteryLevel</a> (<a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out)</td></tr>
<tr class="memdesc:a82373d4c238c33f3a20586b468233688"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the system's current battery level. <a href="ptmu_8h.html#a82373d4c238c33f3a20586b468233688">More...</a><br /></td></tr>
<tr class="separator:a82373d4c238c33f3a20586b468233688"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a24c72010f8979755de58e19d6b4574"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ptmu_8h.html#a3a24c72010f8979755de58e19d6b4574">PTMU_GetBatteryChargeState</a> (<a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out)</td></tr>
<tr class="memdesc:a3a24c72010f8979755de58e19d6b4574"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the system's current battery charge state. <a href="ptmu_8h.html#a3a24c72010f8979755de58e19d6b4574">More...</a><br /></td></tr>
<tr class="separator:a3a24c72010f8979755de58e19d6b4574"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3c3b5cb00e263bdc27cbf8545dd9b0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ptmu_8h.html#ad3c3b5cb00e263bdc27cbf8545dd9b0b">PTMU_GetPedometerState</a> (<a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out)</td></tr>
<tr class="memdesc:ad3c3b5cb00e263bdc27cbf8545dd9b0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the system's current pedometer state. <a href="ptmu_8h.html#ad3c3b5cb00e263bdc27cbf8545dd9b0b">More...</a><br /></td></tr>
<tr class="separator:ad3c3b5cb00e263bdc27cbf8545dd9b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d6ea0afcf123c0345af5e7e160d230f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ptmu_8h.html#a7d6ea0afcf123c0345af5e7e160d230f">PTMU_GetTotalStepCount</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *steps)</td></tr>
<tr class="memdesc:a7d6ea0afcf123c0345af5e7e160d230f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the pedometer's total step count. <a href="ptmu_8h.html#a7d6ea0afcf123c0345af5e7e160d230f">More...</a><br /></td></tr>
<tr class="separator:a7d6ea0afcf123c0345af5e7e160d230f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a245750ffc15a78dd6937567cdbd4effe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ptmu_8h.html#a245750ffc15a78dd6937567cdbd4effe">PTMU_GetAdapterState</a> (bool *out)</td></tr>
<tr class="memdesc:a245750ffc15a78dd6937567cdbd4effe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets whether the adapter is plugged in or not. <a href="ptmu_8h.html#a245750ffc15a78dd6937567cdbd4effe">More...</a><br /></td></tr>
<tr class="separator:a245750ffc15a78dd6937567cdbd4effe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>PTMU service. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a245750ffc15a78dd6937567cdbd4effe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a245750ffc15a78dd6937567cdbd4effe">&#9670;&nbsp;</a></span>PTMU_GetAdapterState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> PTMU_GetAdapterState </td>
<td>(</td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>out</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets whether the adapter is plugged in or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>Pointer to write the adapter state to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3a24c72010f8979755de58e19d6b4574"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a24c72010f8979755de58e19d6b4574">&#9670;&nbsp;</a></span>PTMU_GetBatteryChargeState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> PTMU_GetBatteryChargeState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *&#160;</td>
<td class="paramname"><em>out</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the system's current battery charge state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>Pointer to write the current battery charge state to. (0 = not charging, 1 = charging) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a82373d4c238c33f3a20586b468233688"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82373d4c238c33f3a20586b468233688">&#9670;&nbsp;</a></span>PTMU_GetBatteryLevel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> PTMU_GetBatteryLevel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *&#160;</td>
<td class="paramname"><em>out</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the system's current battery level. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>Pointer to write the current battery level to. (0-5) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad3c3b5cb00e263bdc27cbf8545dd9b0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3c3b5cb00e263bdc27cbf8545dd9b0b">&#9670;&nbsp;</a></span>PTMU_GetPedometerState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> PTMU_GetPedometerState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *&#160;</td>
<td class="paramname"><em>out</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the system's current pedometer state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>Pointer to write the current pedometer state to. (0 = not counting, 1 = counting) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adf953372cfbda67c967427f31dc8e68f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf953372cfbda67c967427f31dc8e68f">&#9670;&nbsp;</a></span>PTMU_GetShellState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> PTMU_GetShellState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *&#160;</td>
<td class="paramname"><em>out</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the system's current shell state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>Pointer to write the current shell state to. (0 = closed, 1 = open) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7d6ea0afcf123c0345af5e7e160d230f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d6ea0afcf123c0345af5e7e160d230f">&#9670;&nbsp;</a></span>PTMU_GetTotalStepCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> PTMU_GetTotalStepCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>steps</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the pedometer's total step count. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">steps</td><td>Pointer to write the total step count to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8d76adceb26c4b1c785af3a78756ec6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d76adceb26c4b1c785af3a78756ec6c">&#9670;&nbsp;</a></span>ptmuGetSessionHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* ptmuGetSessionHandle </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a pointer to the current ptm:u session handle. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the current ptm:u session handle. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
Reference in New Issue View Git Blame Copy Permalink