USB_Host_Shield_2.0/xbox_enums_8h.html
2022-12-15 10:52:18 +00:00

247 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: xboxEnums.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" />
<link href="imageStyle.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">USB Host Shield 2.0
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">xboxEnums.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="controller_enums_8h_source.html">controllerEnums.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for xboxEnums.h:</div>
<div class="dyncontent">
<div class="center"><img src="xbox_enums_8h__incl.png" border="0" usemap="#axbox_enums_8h" alt=""/></div>
<map name="axbox_enums_8h" id="axbox_enums_8h">
<area shape="rect" title=" " alt="" coords="20,5,131,32"/>
<area shape="rect" href="controller_enums_8h.html" title=" " alt="" coords="5,80,145,107"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="xbox_enums_8h__dep__incl.png" border="0" usemap="#axbox_enums_8hdep" alt=""/></div>
<map name="axbox_enums_8hdep" id="axbox_enums_8hdep">
<area shape="rect" title=" " alt="" coords="147,5,257,32"/>
<area shape="rect" href="_x_b_o_x_o_n_e_8h.html" title=" " alt="" coords="19,80,118,107"/>
<area shape="rect" href="_x_b_o_x_r_e_c_v_8h.html" title=" " alt="" coords="150,80,254,107"/>
<area shape="rect" href="_x_b_o_x_u_s_b_8h.html" title=" " alt="" coords="285,80,383,107"/>
<area shape="rect" href="_x_b_o_x_o_n_e_8cpp.html" title=" " alt="" coords="5,155,119,181"/>
<area shape="rect" href="_x_b_o_x_r_e_c_v_8cpp.html" title=" " alt="" coords="143,155,261,181"/>
<area shape="rect" href="_x_b_o_x_u_s_b_8cpp.html" title=" " alt="" coords="285,155,399,181"/>
</map>
</div>
</div>
<p><a href="xbox_enums_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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:abb8a1831f62ea139a2255c67bb24330f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330f">LEDModeEnum</a> { <a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fab341b3ec217357462f12510d0435c25b">ROTATING</a> = 0x0A
, <a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fae88cfa0f6acd518889cef621446d9d2a">FASTBLINK</a> = 0x0B
, <a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330facfcb52b0be6da777e98f28261a9d2454">SLOWBLINK</a> = 0x0C
, <a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330fa699ca8594a49a8c786c6881a14caeb37">ALTERNATING</a> = 0x0D
}</td></tr>
<tr class="separator:abb8a1831f62ea139a2255c67bb24330f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5061e79d5902f70fba9807427c870e93"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xbox_enums_8h.html#a5061e79d5902f70fba9807427c870e93">getButtonIndexXbox</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b)</td></tr>
<tr class="separator:a5061e79d5902f70fba9807427c870e93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a0aa7965573ba74b8eecaa43f0543026e"><td class="memItemLeft" align="right" valign="top">const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xbox_enums_8h.html#a0aa7965573ba74b8eecaa43f0543026e">XBOX_LEDS</a> []</td></tr>
<tr class="separator:a0aa7965573ba74b8eecaa43f0543026e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35901eab017bd1df5d2361634309adbd"><td class="memItemLeft" align="right" valign="top">const uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xbox_enums_8h.html#a35901eab017bd1df5d2361634309adbd">XBOX_BUTTONS</a> []</td></tr>
<tr class="separator:a35901eab017bd1df5d2361634309adbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="abb8a1831f62ea139a2255c67bb24330f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb8a1831f62ea139a2255c67bb24330f">&#9670;&nbsp;</a></span>LEDModeEnum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="xbox_enums_8h.html#abb8a1831f62ea139a2255c67bb24330f">LEDModeEnum</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum used to set special LED modes supported by the Xbox controller. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abb8a1831f62ea139a2255c67bb24330fab341b3ec217357462f12510d0435c25b"></a>ROTATING&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="abb8a1831f62ea139a2255c67bb24330fae88cfa0f6acd518889cef621446d9d2a"></a>FASTBLINK&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="abb8a1831f62ea139a2255c67bb24330facfcb52b0be6da777e98f28261a9d2454"></a>SLOWBLINK&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="abb8a1831f62ea139a2255c67bb24330fa699ca8594a49a8c786c6881a14caeb37"></a>ALTERNATING&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="xbox_enums_8h_source.html#l00024">24</a> of file <a class="el" href="xbox_enums_8h_source.html">xboxEnums.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a5061e79d5902f70fba9807427c870e93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5061e79d5902f70fba9807427c870e93">&#9670;&nbsp;</a></span>getButtonIndexXbox()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int8_t getButtonIndexXbox </td>
<td>(</td>
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a>&#160;</td>
<td class="paramname"><em>b</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="xbox_enums_8h_source.html#l00065">65</a> of file <a class="el" href="xbox_enums_8h_source.html">xboxEnums.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a0aa7965573ba74b8eecaa43f0543026e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0aa7965573ba74b8eecaa43f0543026e">&#9670;&nbsp;</a></span>XBOX_LEDS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t XBOX_LEDS[]</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
<div class="line"> 0x00, </div>
<div class="line"> 0x02, </div>
<div class="line"> 0x03, </div>
<div class="line"> 0x04, </div>
<div class="line"> 0x05, </div>
<div class="line"> 0x01, </div>
<div class="line">}</div>
</div><!-- fragment --><p>Used to set the LEDs on the controllers </p>
<p class="definition">Definition at line <a class="el" href="xbox_enums_8h_source.html#l00032">32</a> of file <a class="el" href="xbox_enums_8h_source.html">xboxEnums.h</a>.</p>
</div>
</div>
<a id="a35901eab017bd1df5d2361634309adbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35901eab017bd1df5d2361634309adbd">&#9670;&nbsp;</a></span>XBOX_BUTTONS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint16_t XBOX_BUTTONS[]</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
<div class="line"> 0x0100, </div>
<div class="line"> 0x0800, </div>
<div class="line"> 0x0200, </div>
<div class="line"> 0x0400, </div>
<div class="line"> </div>
<div class="line"> 0x2000, </div>
<div class="line"> 0x1000, </div>
<div class="line"> 0x4000, </div>
<div class="line"> 0x8000, </div>
<div class="line"> </div>
<div class="line"> 0, 0, </div>
<div class="line"> 0x0001, </div>
<div class="line"> 0x0002, </div>
<div class="line"> </div>
<div class="line"> 0x0020, </div>
<div class="line"> 0x0010, </div>
<div class="line"> 0x0040, </div>
<div class="line"> 0x0080, </div>
<div class="line"> </div>
<div class="line"> 0x0004, </div>
<div class="line"> 0x0008, </div>
<div class="line">}</div>
</div><!-- fragment --><p>Buttons on the controllers </p>
<p class="definition">Definition at line <a class="el" href="xbox_enums_8h_source.html#l00041">41</a> of file <a class="el" href="xbox_enums_8h_source.html">xboxEnums.h</a>.</p>
</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>