Files
wut/group__vpadbase__base.html
2026-02-21 12:43:12 +00:00

710 lines
38 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" 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>wut: VPAD Base</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">wut<span id="projectnumber">&#160;v1.9.1</span>
</div>
<div id="projectbrief">Wii U Toolchain</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">VPAD Base<div class="ingroups"><a class="el" href="group__vpadbase.html">vpadbase</a></div></div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for VPAD Base:</div>
<div class="dyncontent">
<div class="center"><img src="group__vpadbase__base.png" border="0" usemap="#agroup____vpadbase____base" alt=""/></div>
<map name="agroup____vpadbase____base" id="agroup____vpadbase____base">
<area shape="rect" href="group__vpadbase.html" title="Wii U Gamepad base library." alt="" coords="5,5,91,31"/>
<area shape="rect" title=" " alt="" coords="139,5,232,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gafcc433b08076f309ea6e4e4306c9e900" id="r_gafcc433b08076f309ea6e4e4306c9e900"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#gafcc433b08076f309ea6e4e4306c9e900">VPADChan</a></td></tr>
<tr class="memdesc:gafcc433b08076f309ea6e4e4306c9e900"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wii U GamePad channel. <br /></td></tr>
<tr class="separator:gafcc433b08076f309ea6e4e4306c9e900"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga05fe36fbe8e98bd6b1f69cccf7752e26" id="r_ga05fe36fbe8e98bd6b1f69cccf7752e26"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> { <br />
&#160;&#160;<a class="el" href="group__vpadbase__base.html#gga05fe36fbe8e98bd6b1f69cccf7752e26a1bc2a1657a55d9a426a131fc7287da9e">VPAD_CHAN_0</a> = 0
, <br />
&#160;&#160;<a class="el" href="group__vpadbase__base.html#gga05fe36fbe8e98bd6b1f69cccf7752e26a8e54151652f86d3fbace883a67b5800e">VPAD_CHAN_1</a> = 1
<br />
}</td></tr>
<tr class="memdesc:ga05fe36fbe8e98bd6b1f69cccf7752e26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wii U GamePad channel. <a href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">More...</a><br /></td></tr>
<tr class="separator:ga05fe36fbe8e98bd6b1f69cccf7752e26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4fd2f39aaf633d941c8c8ea20b7fa0fb" id="r_ga4fd2f39aaf633d941c8c8ea20b7fa0fb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga4fd2f39aaf633d941c8c8ea20b7fa0fb">VPADIRCStatusFlags</a> { <br />
&#160;&#160;<a class="el" href="group__vpadbase__base.html#gga4fd2f39aaf633d941c8c8ea20b7fa0fbae9b990f6755021a1be3dde5b5b9cc88a">VPAD_IRC_STATUS_FLAG_HAS_DATA</a> = 1
, <br />
&#160;&#160;<a class="el" href="group__vpadbase__base.html#gga4fd2f39aaf633d941c8c8ea20b7fa0fbaf52a391c619939ef7f82badec062a4b0">VPAD_IRC_STATUS_FLAG_CONNECTED</a> = 2
<br />
}</td></tr>
<tr class="separator:ga4fd2f39aaf633d941c8c8ea20b7fa0fb"><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:gac9447bbdaa91465a491f137c095a6ca5" id="r_gac9447bbdaa91465a491f137c095a6ca5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#gac9447bbdaa91465a491f137c095a6ca5">VPADBASEInit</a> ()</td></tr>
<tr class="memdesc:gac9447bbdaa91465a491f137c095a6ca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the VPADBASE library for use. <br /></td></tr>
<tr class="separator:gac9447bbdaa91465a491f137c095a6ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga348ea206d325312b9c8faa388d4942a6" id="r_ga348ea206d325312b9c8faa388d4942a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga348ea206d325312b9c8faa388d4942a6">VPADBASEShutdown</a> ()</td></tr>
<tr class="memdesc:ga348ea206d325312b9c8faa388d4942a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deinitializes the VPADBASE library. <br /></td></tr>
<tr class="separator:ga348ea206d325312b9c8faa388d4942a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga14e7b514f5c416934b8a7e9bdf883589" id="r_ga14e7b514f5c416934b8a7e9bdf883589"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga14e7b514f5c416934b8a7e9bdf883589">VPADBASEIsInit</a> ()</td></tr>
<tr class="memdesc:ga14e7b514f5c416934b8a7e9bdf883589"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if VPADBASE is initialized. <br /></td></tr>
<tr class="separator:ga14e7b514f5c416934b8a7e9bdf883589"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a3b93df8829c4943a8e82ae7c16a407" id="r_ga2a3b93df8829c4943a8e82ae7c16a407"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga2a3b93df8829c4943a8e82ae7c16a407">VPADBASEGetMotorOnRemainingCount</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan)</td></tr>
<tr class="memdesc:ga2a3b93df8829c4943a8e82ae7c16a407"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a count representing the amount of time left for the given Gamepad's rumble pattern. <br /></td></tr>
<tr class="separator:ga2a3b93df8829c4943a8e82ae7c16a407"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0173ad426ee8ed07017c31d164ec4a04" id="r_ga0173ad426ee8ed07017c31d164ec4a04"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga0173ad426ee8ed07017c31d164ec4a04">VPADBASESetMotorOnRemainingCount</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan, int32_t counter)</td></tr>
<tr class="memdesc:ga0173ad426ee8ed07017c31d164ec4a04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a count representing the amount of time left for the given Gamepad's rumble pattern. <br /></td></tr>
<tr class="separator:ga0173ad426ee8ed07017c31d164ec4a04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga91281d643c451e6e6734d05b5733cbad" id="r_ga91281d643c451e6e6734d05b5733cbad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga91281d643c451e6e6734d05b5733cbad">VPADBASESetSensorBarSetting</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan, int8_t setting)</td></tr>
<tr class="separator:ga91281d643c451e6e6734d05b5733cbad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea7520d49817c8222e6f16dc70a3e7b5" id="r_gaea7520d49817c8222e6f16dc70a3e7b5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#gaea7520d49817c8222e6f16dc70a3e7b5">VPADBASEGetSensorBarSetting</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan, int8_t *outSetting)</td></tr>
<tr class="separator:gaea7520d49817c8222e6f16dc70a3e7b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c7c54b0e53b49976b9fb3a3acac3f05" id="r_ga9c7c54b0e53b49976b9fb3a3acac3f05"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga9c7c54b0e53b49976b9fb3a3acac3f05">VPADBASEGetHeadphoneStatus</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan)</td></tr>
<tr class="memdesc:ga9c7c54b0e53b49976b9fb3a3acac3f05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the headphone status. <br /></td></tr>
<tr class="separator:ga9c7c54b0e53b49976b9fb3a3acac3f05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b8e3d8b3b9fee5b0c59b989beb458b2" id="r_ga1b8e3d8b3b9fee5b0c59b989beb458b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga1b8e3d8b3b9fee5b0c59b989beb458b2">VPADBASEGetGameControllerMode</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan, int32_t *mode)</td></tr>
<tr class="memdesc:ga1b8e3d8b3b9fee5b0c59b989beb458b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the controller mode. <br /></td></tr>
<tr class="separator:ga1b8e3d8b3b9fee5b0c59b989beb458b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga42ee15cc65462792ab71a153f2178ed2" id="r_ga42ee15cc65462792ab71a153f2178ed2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga42ee15cc65462792ab71a153f2178ed2">VPADBASESetGameControllerMode</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan, int32_t mode)</td></tr>
<tr class="memdesc:ga42ee15cc65462792ab71a153f2178ed2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the controller mode. <br /></td></tr>
<tr class="separator:ga42ee15cc65462792ab71a153f2178ed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga647aef524fae2e6f9565250e57f10f65" id="r_ga647aef524fae2e6f9565250e57f10f65"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga647aef524fae2e6f9565250e57f10f65">VPADBASEGetPowerButtonPressStatus</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan, uint32_t *tick, uint32_t *status)</td></tr>
<tr class="memdesc:ga647aef524fae2e6f9565250e57f10f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the POWER button press status. <br /></td></tr>
<tr class="separator:ga647aef524fae2e6f9565250e57f10f65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa72866738d4b0240b48cc4b5ded37fdb" id="r_gaa72866738d4b0240b48cc4b5ded37fdb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#gaa72866738d4b0240b48cc4b5ded37fdb">VPADBASESetPowerButtonPressStatus</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan, uint32_t tick, uint32_t status)</td></tr>
<tr class="memdesc:gaa72866738d4b0240b48cc4b5ded37fdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the POWER button press status. <br /></td></tr>
<tr class="separator:gaa72866738d4b0240b48cc4b5ded37fdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac50b8134527adfb01e362e5c0509d333" id="r_gac50b8134527adfb01e362e5c0509d333"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#gac50b8134527adfb01e362e5c0509d333">VPADBASESetPowerButtonDisableMode</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan, uint32_t mode)</td></tr>
<tr class="memdesc:gac50b8134527adfb01e362e5c0509d333"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the POWER button mode. <br /></td></tr>
<tr class="separator:gac50b8134527adfb01e362e5c0509d333"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9d94ddcfcd22d1b6df0ca18b4d506858" id="r_ga9d94ddcfcd22d1b6df0ca18b4d506858"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#ga9d94ddcfcd22d1b6df0ca18b4d506858">VPADBASEClearIRCEvent</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan)</td></tr>
<tr class="memdesc:ga9d94ddcfcd22d1b6df0ca18b4d506858"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear pending IRC events. <br /></td></tr>
<tr class="separator:ga9d94ddcfcd22d1b6df0ca18b4d506858"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb1541ce74fdf86f399e7ac028737da3" id="r_gaeb1541ce74fdf86f399e7ac028737da3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vpadbase__base.html#ga4fd2f39aaf633d941c8c8ea20b7fa0fb">VPADIRCStatusFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__vpadbase__base.html#gaeb1541ce74fdf86f399e7ac028737da3">VPADBASEGetIRCStatus</a> (<a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> chan)</td></tr>
<tr class="memdesc:gaeb1541ce74fdf86f399e7ac028737da3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current IRC status. <br /></td></tr>
<tr class="separator:gaeb1541ce74fdf86f399e7ac028737da3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gafcc433b08076f309ea6e4e4306c9e900" name="gafcc433b08076f309ea6e4e4306c9e900"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafcc433b08076f309ea6e4e4306c9e900">&#9670;&#160;</a></span>VPADChan</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a> <a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wii U GamePad channel. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga05fe36fbe8e98bd6b1f69cccf7752e26" name="ga05fe36fbe8e98bd6b1f69cccf7752e26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga05fe36fbe8e98bd6b1f69cccf7752e26">&#9670;&#160;</a></span>VPADChan</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wii U GamePad channel. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga05fe36fbe8e98bd6b1f69cccf7752e26a1bc2a1657a55d9a426a131fc7287da9e" name="gga05fe36fbe8e98bd6b1f69cccf7752e26a1bc2a1657a55d9a426a131fc7287da9e"></a>VPAD_CHAN_0&#160;</td><td class="fielddoc"><p>Channel 0. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga05fe36fbe8e98bd6b1f69cccf7752e26a8e54151652f86d3fbace883a67b5800e" name="gga05fe36fbe8e98bd6b1f69cccf7752e26a8e54151652f86d3fbace883a67b5800e"></a>VPAD_CHAN_1&#160;</td><td class="fielddoc"><p>Channel 1. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="base_8h_source.html#l00015">15</a> of file <a class="el" href="base_8h_source.html">base.h</a>.</p>
</div>
</div>
<a id="ga4fd2f39aaf633d941c8c8ea20b7fa0fb" name="ga4fd2f39aaf633d941c8c8ea20b7fa0fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4fd2f39aaf633d941c8c8ea20b7fa0fb">&#9670;&#160;</a></span>VPADIRCStatusFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__vpadbase__base.html#ga4fd2f39aaf633d941c8c8ea20b7fa0fb">VPADIRCStatusFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga4fd2f39aaf633d941c8c8ea20b7fa0fbae9b990f6755021a1be3dde5b5b9cc88a" name="gga4fd2f39aaf633d941c8c8ea20b7fa0fbae9b990f6755021a1be3dde5b5b9cc88a"></a>VPAD_IRC_STATUS_FLAG_HAS_DATA&#160;</td><td class="fielddoc"><p>Indicates that there is pending data which can be received. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga4fd2f39aaf633d941c8c8ea20b7fa0fbaf52a391c619939ef7f82badec062a4b0" name="gga4fd2f39aaf633d941c8c8ea20b7fa0fbaf52a391c619939ef7f82badec062a4b0"></a>VPAD_IRC_STATUS_FLAG_CONNECTED&#160;</td><td class="fielddoc"><p>Indicates that another device is connected. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="base_8h_source.html#l00023">23</a> of file <a class="el" href="base_8h_source.html">base.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac9447bbdaa91465a491f137c095a6ca5" name="gac9447bbdaa91465a491f137c095a6ca5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac9447bbdaa91465a491f137c095a6ca5">&#9670;&#160;</a></span>VPADBASEInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASEInit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the VPADBASE library for use. </p>
<dl class="section note"><dt>Note</dt><dd>This is internally called by vpad and does not need to be called manually.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><ul>
<li><a class="el" href="group__vpadbase__base.html#ga348ea206d325312b9c8faa388d4942a6">VPADBASEShutdown</a> </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga348ea206d325312b9c8faa388d4942a6" name="ga348ea206d325312b9c8faa388d4942a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga348ea206d325312b9c8faa388d4942a6">&#9670;&#160;</a></span>VPADBASEShutdown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASEShutdown </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deinitializes the VPADBASE library. </p>
<dl class="section note"><dt>Note</dt><dd>This is internally called by vpad and does not need to be called manually.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><ul>
<li><a class="el" href="group__vpadbase__base.html#gac9447bbdaa91465a491f137c095a6ca5">VPADBASEInit</a> </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga14e7b514f5c416934b8a7e9bdf883589" name="ga14e7b514f5c416934b8a7e9bdf883589"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga14e7b514f5c416934b8a7e9bdf883589">&#9670;&#160;</a></span>VPADBASEIsInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> VPADBASEIsInit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if VPADBASE is initialized. </p>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if initialized. </dd></dl>
</div>
</div>
<a id="ga2a3b93df8829c4943a8e82ae7c16a407" name="ga2a3b93df8829c4943a8e82ae7c16a407"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2a3b93df8829c4943a8e82ae7c16a407">&#9670;&#160;</a></span>VPADBASEGetMotorOnRemainingCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t VPADBASEGetMotorOnRemainingCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a count representing the amount of time left for the given Gamepad's rumble pattern. </p>
<dl class="section note"><dt>Note</dt><dd>Retail Wii U systems have a single Gamepad on <a class="el" href="">VPAD_CHAN_0. </a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>Denotes which channel to get the rumble time from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga0173ad426ee8ed07017c31d164ec4a04" name="ga0173ad426ee8ed07017c31d164ec4a04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0173ad426ee8ed07017c31d164ec4a04">&#9670;&#160;</a></span>VPADBASESetMotorOnRemainingCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t VPADBASESetMotorOnRemainingCount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>counter</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a count representing the amount of time left for the given Gamepad's rumble pattern. </p>
<dl class="section note"><dt>Note</dt><dd>Retail Wii U systems have a single Gamepad on <a class="el" href="">VPAD_CHAN_0. </a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>Denotes which channel to set the rumble count for.</td></tr>
<tr><td class="paramname">counter</td><td>The value of the new rumble count. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga91281d643c451e6e6734d05b5733cbad" name="ga91281d643c451e6e6734d05b5733cbad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga91281d643c451e6e6734d05b5733cbad">&#9670;&#160;</a></span>VPADBASESetSensorBarSetting()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASESetSensorBarSetting </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t&#160;</td>
<td class="paramname"><em>setting</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaea7520d49817c8222e6f16dc70a3e7b5" name="gaea7520d49817c8222e6f16dc70a3e7b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaea7520d49817c8222e6f16dc70a3e7b5">&#9670;&#160;</a></span>VPADBASEGetSensorBarSetting()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASEGetSensorBarSetting </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int8_t *&#160;</td>
<td class="paramname"><em>outSetting</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga9c7c54b0e53b49976b9fb3a3acac3f05" name="ga9c7c54b0e53b49976b9fb3a3acac3f05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c7c54b0e53b49976b9fb3a3acac3f05">&#9670;&#160;</a></span>VPADBASEGetHeadphoneStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t VPADBASEGetHeadphoneStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the headphone status. </p>
<dl class="section note"><dt>Note</dt><dd>Retail Wii U systems have a single Gamepad on <a class="el" href="">VPAD_CHAN_0. </a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>The channel of the Gamepad to get the headphone status from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 if headphones are connected, 0 otherwise. </dd></dl>
</div>
</div>
<a id="ga1b8e3d8b3b9fee5b0c59b989beb458b2" name="ga1b8e3d8b3b9fee5b0c59b989beb458b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b8e3d8b3b9fee5b0c59b989beb458b2">&#9670;&#160;</a></span>VPADBASEGetGameControllerMode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASEGetGameControllerMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t *&#160;</td>
<td class="paramname"><em>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the controller mode. </p>
<dl class="section note"><dt>Note</dt><dd>Retail Wii U systems have a single Gamepad on <a class="el" href="">VPAD_CHAN_0. </a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>The channel of the Gamepad to get the controller mode from.</td></tr>
<tr><td class="paramname">mode</td><td>Pointer to write a value of the controller mode into. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga42ee15cc65462792ab71a153f2178ed2" name="ga42ee15cc65462792ab71a153f2178ed2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga42ee15cc65462792ab71a153f2178ed2">&#9670;&#160;</a></span>VPADBASESetGameControllerMode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASESetGameControllerMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the controller mode. </p>
<dl class="section note"><dt>Note</dt><dd>Retail Wii U systems have a single Gamepad on <a class="el" href="">VPAD_CHAN_0. </a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>The channel of the Gamepad to set the controller mode to.</td></tr>
<tr><td class="paramname">mode</td><td>Any non-zero mode will turn off the display, like the "Display Off" button under Controller Settings. Inputs are not disabled. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga647aef524fae2e6f9565250e57f10f65" name="ga647aef524fae2e6f9565250e57f10f65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga647aef524fae2e6f9565250e57f10f65">&#9670;&#160;</a></span>VPADBASEGetPowerButtonPressStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASEGetPowerButtonPressStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>tick</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>status</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the POWER button press status. </p>
<dl class="section note"><dt>Note</dt><dd>Retail Wii U systems have a single Gamepad on <a class="el" href="">VPAD_CHAN_0. </a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>The channel of the Gamepad to get the POWER button press status from.</td></tr>
<tr><td class="paramname">tick</td><td>The value given by <a class="el" href="group__coreinit__time.html#gae87316411264b3c9236913dabb9a6fa2">OSGetTick</a> when the button was pressed.</td></tr>
<tr><td class="paramname">status</td><td>The status is set to 0 if the POWER button is not pressed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa72866738d4b0240b48cc4b5ded37fdb" name="gaa72866738d4b0240b48cc4b5ded37fdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa72866738d4b0240b48cc4b5ded37fdb">&#9670;&#160;</a></span>VPADBASESetPowerButtonPressStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASESetPowerButtonPressStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>tick</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>status</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the POWER button press status. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>The channel of the Gamepad to set the POWER button press status to.</td></tr>
<tr><td class="paramname">tick</td><td>The tick value to set.</td></tr>
<tr><td class="paramname">status</td><td>The status to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gac50b8134527adfb01e362e5c0509d333" name="gac50b8134527adfb01e362e5c0509d333"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac50b8134527adfb01e362e5c0509d333">&#9670;&#160;</a></span>VPADBASESetPowerButtonDisableMode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASESetPowerButtonDisableMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the POWER button mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>The channel of the Gamepad to set the POWER button disable mode to.</td></tr>
<tr><td class="paramname">mode</td><td>Set to 0 to enable and set to 1 to disable.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><ul>
<li><a class="el" href="group__vpad__input.html#ga20d7b4146c236681981fa60437e05d18">VPADDisablePowerButton</a></li>
<li><a class="el" href="group__vpad__input.html#gab62f9dcf20acc3ef1029a66ac4288e28">VPADEnablePowerButton</a> </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga9d94ddcfcd22d1b6df0ca18b4d506858" name="ga9d94ddcfcd22d1b6df0ca18b4d506858"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d94ddcfcd22d1b6df0ca18b4d506858">&#9670;&#160;</a></span>VPADBASEClearIRCEvent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void VPADBASEClearIRCEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear pending IRC events. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>The channel of the Gamepad. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaeb1541ce74fdf86f399e7ac028737da3" name="gaeb1541ce74fdf86f399e7ac028737da3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb1541ce74fdf86f399e7ac028737da3">&#9670;&#160;</a></span>VPADBASEGetIRCStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__vpadbase__base.html#ga4fd2f39aaf633d941c8c8ea20b7fa0fb">VPADIRCStatusFlags</a> VPADBASEGetIRCStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__vpadbase__base.html#ga05fe36fbe8e98bd6b1f69cccf7752e26">VPADChan</a>&#160;</td>
<td class="paramname"><em>chan</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current IRC status. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chan</td><td>The channel of the Gamepad.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current status flags (see <a class="el" href="group__vpadbase__base.html#ga4fd2f39aaf633d941c8c8ea20b7fa0fb">VPADIRCStatusFlags</a>). </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>