mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 04:22:50 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/pad_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

916 lines
53 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/runtime/pad.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_afd0453aeaaca58db0f3a26ffe540381.html">runtime</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">pad.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Simple wrapper for the HID Npad API.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="hid_8h_source.html">../services/hid.h</a>&quot;</code><br />
</div>
<p><a href="pad_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 id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPadState.html">PadState</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pad state object. <a href="structPadState.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPadRepeater.html">PadRepeater</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pad button repeater state object. <a href="structPadRepeater.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a3d40cfb1b98eef9fcfdd33fd80b8b20d" id="r_a3d40cfb1b98eef9fcfdd33fd80b8b20d"><td class="memItemLeft" align="right" valign="top"><a id="a3d40cfb1b98eef9fcfdd33fd80b8b20d" name="a3d40cfb1b98eef9fcfdd33fd80b8b20d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>PAD_ANY_ID_MASK</b>&#160;&#160;&#160;0x1000100FFUL</td></tr>
<tr class="memdesc:a3d40cfb1b98eef9fcfdd33fd80b8b20d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask including all existing controller IDs. <br /></td></tr>
<tr class="separator:a3d40cfb1b98eef9fcfdd33fd80b8b20d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac31491cccd97b98fdd06815651f3efa6" id="r_ac31491cccd97b98fdd06815651f3efa6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#ac31491cccd97b98fdd06815651f3efa6">padInitialize</a>(_pad, ...)</td></tr>
<tr class="memdesc:ac31491cccd97b98fdd06815651f3efa6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a <a class="el" href="structPadState.html">PadState</a> object to read input from one or more controller input sources. <br /></td></tr>
<tr class="separator:ac31491cccd97b98fdd06815651f3efa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a20154d9a7a8652d8f2e9266977a350e6" id="r_a20154d9a7a8652d8f2e9266977a350e6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a20154d9a7a8652d8f2e9266977a350e6">padConfigureInput</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> max_players, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> style_set)</td></tr>
<tr class="memdesc:a20154d9a7a8652d8f2e9266977a350e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the input layout supported by the application. <br /></td></tr>
<tr class="separator:a20154d9a7a8652d8f2e9266977a350e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a2770e242acf603bf5809fc5e59be2b" id="r_a0a2770e242acf603bf5809fc5e59be2b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a0a2770e242acf603bf5809fc5e59be2b">padInitializeWithMask</a> (<a class="el" href="structPadState.html">PadState</a> *pad, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> mask)</td></tr>
<tr class="memdesc:a0a2770e242acf603bf5809fc5e59be2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="pad_8h.html#ac31491cccd97b98fdd06815651f3efa6">padInitialize</a>, but taking a bitfield of controller IDs directly. <br /></td></tr>
<tr class="separator:a0a2770e242acf603bf5809fc5e59be2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe4c7bae3751cfbc8d9d9df17f553f26" id="r_abe4c7bae3751cfbc8d9d9df17f553f26"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#abe4c7bae3751cfbc8d9d9df17f553f26">padInitializeAny</a> (<a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:abe4c7bae3751cfbc8d9d9df17f553f26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="pad_8h.html#ac31491cccd97b98fdd06815651f3efa6">padInitialize</a>, but including every single controller input source. <br /></td></tr>
<tr class="separator:abe4c7bae3751cfbc8d9d9df17f553f26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeab499a427353c607ddb16591ff044d6" id="r_aeab499a427353c607ddb16591ff044d6"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#aeab499a427353c607ddb16591ff044d6">padInitializeDefault</a> (<a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:aeab499a427353c607ddb16591ff044d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="pad_8h.html#ac31491cccd97b98fdd06815651f3efa6">padInitialize</a>, but including <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2a98a502c5c7eeafb8817db689464528f4">HidNpadIdType_No1</a> and <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2a04adda44446eb19fa49fae5f8d4dd5b9">HidNpadIdType_Handheld</a>. <br /></td></tr>
<tr class="separator:aeab499a427353c607ddb16591ff044d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a6935137ba9e553897206beb8ce237e" id="r_a2a6935137ba9e553897206beb8ce237e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> (<a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:a2a6935137ba9e553897206beb8ce237e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates pad state by reading from the controller input sources specified during initialization. <br /></td></tr>
<tr class="separator:a2a6935137ba9e553897206beb8ce237e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd1dee9496944462f5ce2af362751f05" id="r_acd1dee9496944462f5ce2af362751f05"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#acd1dee9496944462f5ce2af362751f05">padIsHandheld</a> (const <a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:acd1dee9496944462f5ce2af362751f05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves whether <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2a04adda44446eb19fa49fae5f8d4dd5b9">HidNpadIdType_Handheld</a> is an active input source (i.e. <br /></td></tr>
<tr class="separator:acd1dee9496944462f5ce2af362751f05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e8f060486149a40acf93c3285363684" id="r_a0e8f060486149a40acf93c3285363684"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a0e8f060486149a40acf93c3285363684">padIsNpadActive</a> (const <a class="el" href="structPadState.html">PadState</a> *pad, <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2">HidNpadIdType</a> id)</td></tr>
<tr class="memdesc:a0e8f060486149a40acf93c3285363684"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves whether the specified controller is an active input source (i.e. <br /></td></tr>
<tr class="separator:a0e8f060486149a40acf93c3285363684"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae68838284933de6ce0e25e0bf1b5d41d" id="r_ae68838284933de6ce0e25e0bf1b5d41d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#ae68838284933de6ce0e25e0bf1b5d41d">padGetStyleSet</a> (const <a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:ae68838284933de6ce0e25e0bf1b5d41d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the set of input styles supported by the selected controller input sources. <br /></td></tr>
<tr class="separator:ae68838284933de6ce0e25e0bf1b5d41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83164e7e462fdb612f654c80a50c2ae3" id="r_a83164e7e462fdb612f654c80a50c2ae3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a83164e7e462fdb612f654c80a50c2ae3">padGetAttributes</a> (const <a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:a83164e7e462fdb612f654c80a50c2ae3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the set of attributes reported by the system for the selected controller input sources. <br /></td></tr>
<tr class="separator:a83164e7e462fdb612f654c80a50c2ae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a45d679f41ce7314bc66e21759b8b6c" id="r_a7a45d679f41ce7314bc66e21759b8b6c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a7a45d679f41ce7314bc66e21759b8b6c">padIsConnected</a> (const <a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:a7a45d679f41ce7314bc66e21759b8b6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves whether any of the selected controller input sources is connected. <br /></td></tr>
<tr class="separator:a7a45d679f41ce7314bc66e21759b8b6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f04663e86f9d908a15fcddcda748820" id="r_a3f04663e86f9d908a15fcddcda748820"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a3f04663e86f9d908a15fcddcda748820">padGetButtons</a> (const <a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:a3f04663e86f9d908a15fcddcda748820"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the current set of pressed buttons across all selected controller input sources. <br /></td></tr>
<tr class="separator:a3f04663e86f9d908a15fcddcda748820"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae05dcdb99e94339d334eb1b52bf9fae5" id="r_ae05dcdb99e94339d334eb1b52bf9fae5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#ae05dcdb99e94339d334eb1b52bf9fae5">padGetButtonsDown</a> (const <a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:ae05dcdb99e94339d334eb1b52bf9fae5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the set of buttons that are newly pressed. <br /></td></tr>
<tr class="separator:ae05dcdb99e94339d334eb1b52bf9fae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0380a78c24ed3e0e1f7a4e6028a0c41f" id="r_a0380a78c24ed3e0e1f7a4e6028a0c41f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a0380a78c24ed3e0e1f7a4e6028a0c41f">padGetButtonsUp</a> (const <a class="el" href="structPadState.html">PadState</a> *pad)</td></tr>
<tr class="memdesc:a0380a78c24ed3e0e1f7a4e6028a0c41f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the set of buttons that are newly released. <br /></td></tr>
<tr class="separator:a0380a78c24ed3e0e1f7a4e6028a0c41f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5707823ee8afa57b90d32c4ab34d2a6f" id="r_a5707823ee8afa57b90d32c4ab34d2a6f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structHidAnalogStickState.html">HidAnalogStickState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a5707823ee8afa57b90d32c4ab34d2a6f">padGetStickPos</a> (const <a class="el" href="structPadState.html">PadState</a> *pad, unsigned i)</td></tr>
<tr class="memdesc:a5707823ee8afa57b90d32c4ab34d2a6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the position of an analog stick in a controller. <br /></td></tr>
<tr class="separator:a5707823ee8afa57b90d32c4ab34d2a6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5418afda859d1e70b9ffb52110d1eafe" id="r_a5418afda859d1e70b9ffb52110d1eafe"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a5418afda859d1e70b9ffb52110d1eafe">padGetGcTriggerPos</a> (const <a class="el" href="structPadState.html">PadState</a> *pad, unsigned i)</td></tr>
<tr class="memdesc:a5418afda859d1e70b9ffb52110d1eafe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the position of an analog trigger in a GameCube controller. <br /></td></tr>
<tr class="separator:a5418afda859d1e70b9ffb52110d1eafe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7c0914f615d345a74f61d1875094229" id="r_aa7c0914f615d345a74f61d1875094229"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#aa7c0914f615d345a74f61d1875094229">padRepeaterInitialize</a> (<a class="el" href="structPadRepeater.html">PadRepeater</a> *r, <a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> delay, <a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> repeat)</td></tr>
<tr class="memdesc:aa7c0914f615d345a74f61d1875094229"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a <a class="el" href="structPadRepeater.html">PadRepeater</a> object with the specified settings. <br /></td></tr>
<tr class="separator:aa7c0914f615d345a74f61d1875094229"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a821532563639d1d4552ce948b758f4c0" id="r_a821532563639d1d4552ce948b758f4c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a821532563639d1d4552ce948b758f4c0">padRepeaterUpdate</a> (<a class="el" href="structPadRepeater.html">PadRepeater</a> *r, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> button_mask)</td></tr>
<tr class="memdesc:a821532563639d1d4552ce948b758f4c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates pad repeat state. <br /></td></tr>
<tr class="separator:a821532563639d1d4552ce948b758f4c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b525bcbfa7c193d5d65023323e3959d" id="r_a7b525bcbfa7c193d5d65023323e3959d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pad_8h.html#a7b525bcbfa7c193d5d65023323e3959d">padRepeaterGetButtons</a> (const <a class="el" href="structPadRepeater.html">PadRepeater</a> *r)</td></tr>
<tr class="memdesc:a7b525bcbfa7c193d5d65023323e3959d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the set of buttons that are being repeated according to the parameters specified in <a class="el" href="pad_8h.html#aa7c0914f615d345a74f61d1875094229">padRepeaterInitialize</a>. <br /></td></tr>
<tr class="separator:a7b525bcbfa7c193d5d65023323e3959d"><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>Simple wrapper for the HID Npad API. </p>
<dl class="section author"><dt>Author</dt><dd>fincs </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ac31491cccd97b98fdd06815651f3efa6" name="ac31491cccd97b98fdd06815651f3efa6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac31491cccd97b98fdd06815651f3efa6">&#9670;&#160;</a></span>padInitialize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define padInitialize</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">_pad, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> ({ \</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_enumeration" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2">HidNpadIdType</a> _pad_ids[] = { __VA_ARGS__ }; \</div>
<div class="line"> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> _pad_mask = 0; \</div>
<div class="line"> for (<span class="keywordtype">unsigned</span> _pad_i = 0; _pad_i &lt; (<span class="keyword">sizeof</span>(_pad_ids)/<span class="keyword">sizeof</span>(_pad_ids[0])); ++_pad_i) \</div>
<div class="line"> _pad_mask |= 1UL &lt;&lt; (_pad_ids[_pad_i]); \</div>
<div class="line"> padInitializeWithMask((_pad), _pad_mask); \</div>
<div class="line">})</div>
<div class="ttc" id="ahid_8h_html_ab67795ab278597e5863540a88fe6a3a2"><div class="ttname"><a href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2">HidNpadIdType</a></div><div class="ttdeci">HidNpadIdType</div><div class="ttdoc">HID controller IDs.</div><div class="ttdef"><b>Definition</b> hid.h:214</div></div>
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:22</div></div>
</div><!-- fragment -->
<p>Initializes a <a class="el" href="structPadState.html">PadState</a> object to read input from one or more controller input sources. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>This is a variadic macro, pass the <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2">HidNpadIdType</a> value of each controller to add to the set. </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a20154d9a7a8652d8f2e9266977a350e6" name="a20154d9a7a8652d8f2e9266977a350e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20154d9a7a8652d8f2e9266977a350e6">&#9670;&#160;</a></span>padConfigureInput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void padConfigureInput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>max_players</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>style_set</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures the input layout supported by the application. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">max_players</td><td>The maximum supported number of players (1 to 8). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">style_set</td><td>Bitfield of supported controller styles (see <a class="el" href="hid_8h.html#ac7f6fa6f6a0c61d2aa539e73877f9f41">HidNpadStyleTag</a>). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a83164e7e462fdb612f654c80a50c2ae3" name="a83164e7e462fdb612f654c80a50c2ae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83164e7e462fdb612f654c80a50c2ae3">&#9670;&#160;</a></span>padGetAttributes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> padGetAttributes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the set of attributes reported by the system for the selected controller input sources. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Bitfield of <a class="el" href="hid_8h.html#a99ff9db1de12adf2537f08e2e47be1ca">HidNpadAttribute</a>. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd></dl>
</div>
</div>
<a id="a3f04663e86f9d908a15fcddcda748820" name="a3f04663e86f9d908a15fcddcda748820"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f04663e86f9d908a15fcddcda748820">&#9670;&#160;</a></span>padGetButtons()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> padGetButtons </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the current set of pressed buttons across all selected controller input sources. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Bitfield of <a class="el" href="hid_8h.html#aa163470a1a7b811662e5c38905cc86fb">HidNpadButton</a>. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd></dl>
</div>
</div>
<a id="ae05dcdb99e94339d334eb1b52bf9fae5" name="ae05dcdb99e94339d334eb1b52bf9fae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae05dcdb99e94339d334eb1b52bf9fae5">&#9670;&#160;</a></span>padGetButtonsDown()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> padGetButtonsDown </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the set of buttons that are newly pressed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Bitfield of <a class="el" href="hid_8h.html#aa163470a1a7b811662e5c38905cc86fb">HidNpadButton</a>. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd></dl>
</div>
</div>
<a id="a0380a78c24ed3e0e1f7a4e6028a0c41f" name="a0380a78c24ed3e0e1f7a4e6028a0c41f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0380a78c24ed3e0e1f7a4e6028a0c41f">&#9670;&#160;</a></span>padGetButtonsUp()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> padGetButtonsUp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the set of buttons that are newly released. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Bitfield of <a class="el" href="hid_8h.html#aa163470a1a7b811662e5c38905cc86fb">HidNpadButton</a>. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd></dl>
</div>
</div>
<a id="a5418afda859d1e70b9ffb52110d1eafe" name="a5418afda859d1e70b9ffb52110d1eafe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5418afda859d1e70b9ffb52110d1eafe">&#9670;&#160;</a></span>padGetGcTriggerPos()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> padGetGcTriggerPos </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&#160;</td>
<td class="paramname"><em>i</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the position of an analog trigger in a GameCube controller. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>ID of the analog trigger to read (0=left, 1=right). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Analog trigger position (range is 0 to 0x7fff). </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd>
<dd>
<a class="el" href="hid_8h.html#ac7f6fa6f6a0c61d2aa539e73877f9f41a1f08bbffbfa59eea99aa188209ceb330">HidNpadStyleTag_NpadGc</a> must have been previously configured as a supported style in <a class="el" href="pad_8h.html#a20154d9a7a8652d8f2e9266977a350e6">padConfigureInput</a> for GC trigger data to be readable. </dd></dl>
</div>
</div>
<a id="a5707823ee8afa57b90d32c4ab34d2a6f" name="a5707823ee8afa57b90d32c4ab34d2a6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5707823ee8afa57b90d32c4ab34d2a6f">&#9670;&#160;</a></span>padGetStickPos()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structHidAnalogStickState.html">HidAnalogStickState</a> padGetStickPos </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&#160;</td>
<td class="paramname"><em>i</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the position of an analog stick in a controller. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>ID of the analog stick to read (0=left, 1=right). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structHidAnalogStickState.html">HidAnalogStickState</a>. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd></dl>
</div>
</div>
<a id="ae68838284933de6ce0e25e0bf1b5d41d" name="ae68838284933de6ce0e25e0bf1b5d41d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae68838284933de6ce0e25e0bf1b5d41d">&#9670;&#160;</a></span>padGetStyleSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> padGetStyleSet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the set of input styles supported by the selected controller input sources. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Bitfield of <a class="el" href="hid_8h.html#ac7f6fa6f6a0c61d2aa539e73877f9f41">HidNpadStyleTag</a>. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd></dl>
</div>
</div>
<a id="abe4c7bae3751cfbc8d9d9df17f553f26" name="abe4c7bae3751cfbc8d9d9df17f553f26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe4c7bae3751cfbc8d9d9df17f553f26">&#9670;&#160;</a></span>padInitializeAny()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void padInitializeAny </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Same as <a class="el" href="pad_8h.html#ac31491cccd97b98fdd06815651f3efa6">padInitialize</a>, but including every single controller input source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Use this function if you want to accept input from any controller. </dd></dl>
</div>
</div>
<a id="aeab499a427353c607ddb16591ff044d6" name="aeab499a427353c607ddb16591ff044d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeab499a427353c607ddb16591ff044d6">&#9670;&#160;</a></span>padInitializeDefault()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void padInitializeDefault </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Same as <a class="el" href="pad_8h.html#ac31491cccd97b98fdd06815651f3efa6">padInitialize</a>, but including <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2a98a502c5c7eeafb8817db689464528f4">HidNpadIdType_No1</a> and <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2a04adda44446eb19fa49fae5f8d4dd5b9">HidNpadIdType_Handheld</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Use this function if you just want to accept input for a single-player application. </dd></dl>
</div>
</div>
<a id="a0a2770e242acf603bf5809fc5e59be2b" name="a0a2770e242acf603bf5809fc5e59be2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a2770e242acf603bf5809fc5e59be2b">&#9670;&#160;</a></span>padInitializeWithMask()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void padInitializeWithMask </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>mask</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Same as <a class="el" href="pad_8h.html#ac31491cccd97b98fdd06815651f3efa6">padInitialize</a>, but taking a bitfield of controller IDs directly. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>Bitfield of controller IDs (each bit's position indicates a different <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2">HidNpadIdType</a> value). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7a45d679f41ce7314bc66e21759b8b6c" name="a7a45d679f41ce7314bc66e21759b8b6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a45d679f41ce7314bc66e21759b8b6c">&#9670;&#160;</a></span>padIsConnected()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool padIsConnected </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves whether any of the selected controller input sources is connected. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Boolean value. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd></dl>
</div>
</div>
<a id="acd1dee9496944462f5ce2af362751f05" name="acd1dee9496944462f5ce2af362751f05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd1dee9496944462f5ce2af362751f05">&#9670;&#160;</a></span>padIsHandheld()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool padIsHandheld </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves whether <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2a04adda44446eb19fa49fae5f8d4dd5b9">HidNpadIdType_Handheld</a> is an active input source (i.e. </p>
<p>it was possible to read from it). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Boolean value. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd></dl>
</div>
</div>
<a id="a0e8f060486149a40acf93c3285363684" name="a0e8f060486149a40acf93c3285363684"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e8f060486149a40acf93c3285363684">&#9670;&#160;</a></span>padIsNpadActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool padIsNpadActive </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2">HidNpadIdType</a>&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves whether the specified controller is an active input source (i.e. </p>
<p>it was possible to read from it). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>ID of the controller input source (see <a class="el" href="hid_8h.html#ab67795ab278597e5863540a88fe6a3a2">HidNpadIdType</a>) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Boolean value. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="pad_8h.html#a2a6935137ba9e553897206beb8ce237e">padUpdate</a> must have been previously called. </dd></dl>
</div>
</div>
<a id="a7b525bcbfa7c193d5d65023323e3959d" name="a7b525bcbfa7c193d5d65023323e3959d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b525bcbfa7c193d5d65023323e3959d">&#9670;&#160;</a></span>padRepeaterGetButtons()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> padRepeaterGetButtons </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPadRepeater.html">PadRepeater</a> *&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the set of buttons that are being repeated according to the parameters specified in <a class="el" href="pad_8h.html#aa7c0914f615d345a74f61d1875094229">padRepeaterInitialize</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>Pointer to <a class="el" href="structPadRepeater.html">PadRepeater</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Bitfield of <a class="el" href="hid_8h.html#aa163470a1a7b811662e5c38905cc86fb">HidNpadButton</a>. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>It is suggested to bitwise-OR the return value of this function with that of <a class="el" href="pad_8h.html#ae05dcdb99e94339d334eb1b52bf9fae5">padGetButtonsDown</a>. </dd></dl>
</div>
</div>
<a id="aa7c0914f615d345a74f61d1875094229" name="aa7c0914f615d345a74f61d1875094229"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7c0914f615d345a74f61d1875094229">&#9670;&#160;</a></span>padRepeaterInitialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void padRepeaterInitialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPadRepeater.html">PadRepeater</a> *&#160;</td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a>&#160;</td>
<td class="paramname"><em>delay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a>&#160;</td>
<td class="paramname"><em>repeat</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes a <a class="el" href="structPadRepeater.html">PadRepeater</a> object with the specified settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>Pointer to <a class="el" href="structPadRepeater.html">PadRepeater</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">delay</td><td>Number of input updates between button presses being first detected and them being considered for repeat. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">repeat</td><td>Number of input updates between autogenerated repeat button presses. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a821532563639d1d4552ce948b758f4c0" name="a821532563639d1d4552ce948b758f4c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a821532563639d1d4552ce948b758f4c0">&#9670;&#160;</a></span>padRepeaterUpdate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void padRepeaterUpdate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPadRepeater.html">PadRepeater</a> *&#160;</td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>button_mask</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates pad repeat state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>Pointer to <a class="el" href="structPadRepeater.html">PadRepeater</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">button_mask</td><td>Bitfield of currently pressed <a class="el" href="hid_8h.html#aa163470a1a7b811662e5c38905cc86fb">HidNpadButton</a> that will be considered for repeat. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2a6935137ba9e553897206beb8ce237e" name="a2a6935137ba9e553897206beb8ce237e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a6935137ba9e553897206beb8ce237e">&#9670;&#160;</a></span>padUpdate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void padUpdate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPadState.html">PadState</a> *&#160;</td>
<td class="paramname"><em>pad</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates pad state by reading from the controller input sources specified during initialization. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pad</td><td>Pointer to <a class="el" href="structPadState.html">PadState</a>. </td></tr>
</table>
</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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink