USB_Host_Shield_2.0/class_x_b_o_x_o_n_e.html

925 lines
48 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2015-04-07 16:07:33 +02:00
<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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
2015-04-07 16:07:33 +02:00
<title>USB Host Shield 2.0: XBOXONE Class 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>
2015-04-07 16:07:33 +02:00
<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;">
2015-04-07 16:07:33 +02:00
<div id="projectname">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
2015-04-07 16:07:33 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2015-04-07 16:07:33 +02:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
2015-04-07 16:07:33 +02:00
</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>
2015-04-07 16:07:33 +02:00
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
2015-04-07 16:07:33 +02:00
<!-- 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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
2018-10-13 15:47:19 +02:00
<a href="#pro-methods">Protected Member Functions</a> &#124;
2015-04-07 16:07:33 +02:00
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_x_b_o_x_o_n_e-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XBOXONE Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for XBOXONE:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_b_o_x_o_n_e__inherit__graph.png" border="0" usemap="#_x_b_o_x_o_n_e_inherit__map" alt="Inheritance graph"/></div>
<map name="_x_b_o_x_o_n_e_inherit__map" id="_x_b_o_x_o_n_e_inherit__map">
<area shape="rect" title=" " alt="" coords="109,80,196,107"/>
<area shape="rect" href="class_u_s_b_device_config.html" title=" " alt="" coords="5,5,140,32"/>
<area shape="rect" href="class_usb_config_xtracter.html" title=" " alt="" coords="164,5,304,32"/>
</map>
2015-04-07 16:07:33 +02:00
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for XBOXONE:</div>
<div class="dyncontent">
<div class="center"><img src="class_x_b_o_x_o_n_e__coll__graph.png" border="0" usemap="#_x_b_o_x_o_n_e_coll__map" alt="Collaboration graph"/></div>
<map name="_x_b_o_x_o_n_e_coll__map" id="_x_b_o_x_o_n_e_coll__map">
<area shape="rect" title=" " alt="" coords="231,171,317,197"/>
<area shape="rect" href="class_u_s_b_device_config.html" title=" " alt="" coords="5,81,140,108"/>
<area shape="rect" href="class_usb_config_xtracter.html" title=" " alt="" coords="164,81,304,108"/>
<area shape="rect" href="class_u_s_b.html" title=" " alt="" coords="328,81,377,108"/>
<area shape="rect" href="class_m_a_x3421e.html" title=" " alt="" coords="307,5,399,32"/>
<area shape="rect" href="struct_ep_info.html" title=" " alt="" coords="401,81,464,108"/>
</map>
2015-04-07 16:07:33 +02:00
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3b9466f31de5c4f4e46a47440eea2bfc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a3b9466f31de5c4f4e46a47440eea2bfc">XBOXONE</a> (<a class="el" href="class_u_s_b.html">USB</a> *<a class="el" href="class_x_b_o_x_o_n_e.html#a5b4e45cdd8695439d9772f55bb8ece6f">pUsb</a>)</td></tr>
<tr class="separator:a3b9466f31de5c4f4e46a47440eea2bfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">USBDeviceConfig implementation</div></td></tr>
<tr class="memitem:aeb2d90a3d77fc252a12f5ed54c3f370e"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#aeb2d90a3d77fc252a12f5ed54c3f370e">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
<tr class="separator:aeb2d90a3d77fc252a12f5ed54c3f370e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab836f2e18a00ef89054d66fb2023ba64"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#ab836f2e18a00ef89054d66fb2023ba64">Release</a> ()</td></tr>
<tr class="separator:ab836f2e18a00ef89054d66fb2023ba64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac645e477bde4c2c2674ad8916f749651"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#ac645e477bde4c2c2674ad8916f749651">Poll</a> ()</td></tr>
<tr class="separator:ac645e477bde4c2c2674ad8916f749651"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05332491fe28b71c6d7c9a9827370bdf"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a05332491fe28b71c6d7c9a9827370bdf">GetAddress</a> ()</td></tr>
<tr class="separator:a05332491fe28b71c6d7c9a9827370bdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23112f12ed914d1b0128675b1f59aace"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a23112f12ed914d1b0128675b1f59aace">isReady</a> ()</td></tr>
<tr class="separator:a23112f12ed914d1b0128675b1f59aace"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-10-13 15:47:19 +02:00
<tr class="memitem:ae606811be2389140b19421aad2cb040f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#ae606811be2389140b19421aad2cb040f">readPollInterval</a> ()</td></tr>
<tr class="separator:ae606811be2389140b19421aad2cb040f"><td class="memSeparator" colspan="2">&#160;</td></tr>
2016-04-19 18:16:46 +02:00
<tr class="memitem:a53082e8413a3e7046b7e96fa3183b0eb"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a53082e8413a3e7046b7e96fa3183b0eb">VIDPIDOK</a> (uint16_t vid, uint16_t pid)</td></tr>
<tr class="separator:a53082e8413a3e7046b7e96fa3183b0eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
2015-04-07 16:07:33 +02:00
<tr><td colspan="2"><div class="groupHeader">Xbox Controller functions</div></td></tr>
<tr class="memitem:ae197d34a4c2138d1889afe2c2e3345c4"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b)</td></tr>
<tr class="separator:ae197d34a4c2138d1889afe2c2e3345c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bd03dd0f2abde83f34635ab72564811"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick</a> (<a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> b)</td></tr>
<tr class="separator:a9bd03dd0f2abde83f34635ab72564811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af49b526b57d3a3148537bdada9fb69bc"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#af49b526b57d3a3148537bdada9fb69bc">getAnalogHat</a> (<a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093">AnalogHatEnum</a> a)</td></tr>
<tr class="separator:af49b526b57d3a3148537bdada9fb69bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b2434ed7197361d229340773b0c3bda"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a0b2434ed7197361d229340773b0c3bda">attachOnInit</a> (void(*funcOnInit)(void))</td></tr>
<tr class="separator:a0b2434ed7197361d229340773b0c3bda"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-10-13 15:47:19 +02:00
<tr class="memitem:a506e8add57ffac652a28e8c5b7e72e85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a506e8add57ffac652a28e8c5b7e72e85">setRumbleOff</a> ()</td></tr>
<tr class="separator:a506e8add57ffac652a28e8c5b7e72e85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6586343cacf8705c7a3c2d4f479f2261"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a6586343cacf8705c7a3c2d4f479f2261">setRumbleOn</a> (uint8_t leftTrigger, uint8_t rightTrigger, uint8_t leftMotor, uint8_t rightMotor)</td></tr>
<tr class="separator:a6586343cacf8705c7a3c2d4f479f2261"><td class="memSeparator" colspan="2">&#160;</td></tr>
2015-04-07 16:07:33 +02:00
<tr class="inherit_header pub_methods_class_u_s_b_device_config"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_u_s_b_device_config')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_u_s_b_device_config.html">USBDeviceConfig</a></td></tr>
<tr class="memitem:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#aef77a1e62f78c04a1aad53e8795ec89e">ConfigureDevice</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
<tr class="separator:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a12bb63558ded5bb6661bb173b07ff391">ResetHubPort</a> (uint8_t port)</td></tr>
<tr class="separator:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a2bb3e09cf128c8ecd04ea0dfce2126e1">DEVCLASSOK</a> (uint8_t klass)</td></tr>
<tr class="separator:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#ad2d535af92d0b97e4445a6bd51d35c57">DEVSUBCLASSOK</a> (uint8_t subklass)</td></tr>
<tr class="separator:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac055f7c7156ef515fe362e751fe1bae3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#ac055f7c7156ef515fe362e751fe1bae3">XboxOneConnected</a></td></tr>
<tr class="separator:ac055f7c7156ef515fe362e751fe1bae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
2018-10-13 15:47:19 +02:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a2eea30f2ce47380fc414d4fc4231335b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a2eea30f2ce47380fc414d4fc4231335b">PrintEndpointDescriptor</a> (const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep_ptr)</td></tr>
<tr class="separator:a2eea30f2ce47380fc414d4fc4231335b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">UsbConfigXtracter implementation</div></td></tr>
<tr class="memitem:a499cc378b8ae7d8fd63baa1b4dab97b5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a499cc378b8ae7d8fd63baa1b4dab97b5">EndpointXtract</a> (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep)</td></tr>
<tr class="separator:a499cc378b8ae7d8fd63baa1b4dab97b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
2015-04-07 16:07:33 +02:00
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a5b4e45cdd8695439d9772f55bb8ece6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_s_b.html">USB</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a5b4e45cdd8695439d9772f55bb8ece6f">pUsb</a></td></tr>
<tr class="separator:a5b4e45cdd8695439d9772f55bb8ece6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a800dd3559813c0f1771e8fdd30c4105b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a800dd3559813c0f1771e8fdd30c4105b">bAddress</a></td></tr>
<tr class="separator:a800dd3559813c0f1771e8fdd30c4105b"><td class="memSeparator" colspan="2">&#160;</td></tr>
2018-10-13 15:47:19 +02:00
<tr class="memitem:a2915fc1f1f3a9c5333bfd643defa0621"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ep_info.html">EpInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a2915fc1f1f3a9c5333bfd643defa0621">epInfo</a> [<a class="el" href="_x_b_o_x_o_n_e_8h.html#a8e9bf59d8bc051ff3fa38e2b327ade6e">XBOX_ONE_MAX_ENDPOINTS</a>]</td></tr>
<tr class="separator:a2915fc1f1f3a9c5333bfd643defa0621"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6c75dcd5dfd5a9685a049f9bb8cb93f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#ac6c75dcd5dfd5a9685a049f9bb8cb93f">bConfNum</a></td></tr>
<tr class="separator:ac6c75dcd5dfd5a9685a049f9bb8cb93f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a958f262ed66dd5bf0ad7dfd54a369659"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a958f262ed66dd5bf0ad7dfd54a369659">bNumEP</a></td></tr>
<tr class="separator:a958f262ed66dd5bf0ad7dfd54a369659"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d0702c6fc0327535d909975670e9284"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_b_o_x_o_n_e.html#a4d0702c6fc0327535d909975670e9284">qNextPollTime</a></td></tr>
<tr class="separator:a4d0702c6fc0327535d909975670e9284"><td class="memSeparator" colspan="2">&#160;</td></tr>
2015-04-07 16:07:33 +02:00
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class implements support for a Xbox ONE controller connected via <a class="el" href="class_u_s_b.html">USB</a>. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00067">67</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2015-04-07 16:07:33 +02:00
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3b9466f31de5c4f4e46a47440eea2bfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b9466f31de5c4f4e46a47440eea2bfc">&#9670;&nbsp;</a></span>XBOXONE()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XBOXONE::XBOXONE </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> *&#160;</td>
<td class="paramname"><em>pUsb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="class_x_b_o_x_o_n_e.html">XBOXONE</a> class. </p><dl class="params"><dt>Parameters</dt><dd>
2015-04-07 16:07:33 +02:00
<table class="params">
<tr><td class="paramname">pUsb</td><td>Pointer to <a class="el" href="class_u_s_b.html">USB</a> class instance. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00027">27</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aeb2d90a3d77fc252a12f5ed54c3f370e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb2d90a3d77fc252a12f5ed54c3f370e">&#9670;&nbsp;</a></span>Init()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::Init </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>lowspeed</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the Xbox Controller. </p><dl class="params"><dt>Parameters</dt><dd>
2015-04-07 16:07:33 +02:00
<table class="params">
<tr><td class="paramname">parent</td><td>Hub number. </td></tr>
<tr><td class="paramname">port</td><td>Port number on the hub. </td></tr>
<tr><td class="paramname">lowspeed</td><td>Speed of the device. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a3706cf6b18785aff823171e280bab738">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00046">46</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="ab836f2e18a00ef89054d66fb2023ba64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab836f2e18a00ef89054d66fb2023ba64">&#9670;&nbsp;</a></span>Release()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::Release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Release the <a class="el" href="class_u_s_b.html">USB</a> device. </p><dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
2015-04-07 16:07:33 +02:00
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a61e301efedae55c6ac12c6cce154e432">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00286">286</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="ac645e477bde4c2c2674ad8916f749651"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac645e477bde4c2c2674ad8916f749651">&#9670;&nbsp;</a></span>Poll()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::Poll </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Poll the <a class="el" href="class_u_s_b.html">USB</a> Input endpoins and run the state machines. </p><dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
2015-04-07 16:07:33 +02:00
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a893ea73deab98be837c257201e7da25a">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00300">300</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="a05332491fe28b71c6d7c9a9827370bdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05332491fe28b71c6d7c9a9827370bdf">&#9670;&nbsp;</a></span>GetAddress()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t XBOXONE::GetAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the device address. </p><dl class="section return"><dt>Returns</dt><dd>The device address. </dd></dl>
2015-04-07 16:07:33 +02:00
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#a2bfde6c290d32888a6f4e97fa1e222f1">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00099">99</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="a23112f12ed914d1b0128675b1f59aace"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23112f12ed914d1b0128675b1f59aace">&#9670;&nbsp;</a></span>isReady()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool XBOXONE::isReady </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to check if the controller has been initialized. </p><dl class="section return"><dt>Returns</dt><dd>True if it's ready. </dd></dl>
2015-04-07 16:07:33 +02:00
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00107">107</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="ae606811be2389140b19421aad2cb040f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae606811be2389140b19421aad2cb040f">&#9670;&nbsp;</a></span>readPollInterval()</h2>
2018-10-13 15:47:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::readPollInterval </td>
<td>(</td>
<td class="paramname"></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>Read the poll interval taken from the endpoint descriptors. </p><dl class="section return"><dt>Returns</dt><dd>The poll interval in ms. </dd></dl>
2018-10-13 15:47:19 +02:00
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00115">115</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2018-10-13 15:47:19 +02:00
</div>
</div>
<a id="a53082e8413a3e7046b7e96fa3183b0eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53082e8413a3e7046b7e96fa3183b0eb">&#9670;&nbsp;</a></span>VIDPIDOK()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2016-04-19 18:16:46 +02:00
<td class="memname">virtual bool XBOXONE::VIDPIDOK </td>
2015-04-07 16:07:33 +02:00
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>vid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>pid</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used by the <a class="el" href="class_u_s_b.html">USB</a> core to check what this driver support. </p><dl class="params"><dt>Parameters</dt><dd>
2015-04-07 16:07:33 +02:00
<table class="params">
<tr><td class="paramname">vid</td><td>The device's VID. </td></tr>
<tr><td class="paramname">pid</td><td>The device's PID. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the device's VID and PID matches this driver. </dd></dl>
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#af920743379d8c133dda4335d11601141">USBDeviceConfig</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00125">125</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="ae197d34a4c2138d1889afe2c2e3345c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae197d34a4c2138d1889afe2c2e3345c4">&#9670;&nbsp;</a></span>getButtonPress()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t XBOXONE::getButtonPress </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>
</div><div class="memdoc">
<p><a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a> will return true as long as the button is held down.</p>
<p>While <a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a> will only return it once.</p>
<p>So you instance if you need to increase a variable once you would use <a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a>, but if you need to drive a robot forward you would use <a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a>. </p><dl class="params"><dt>Parameters</dt><dd>
2015-04-07 16:07:33 +02:00
<table class="params">
<tr><td class="paramname">b</td><td><a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> to read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a> will return a bool, while <a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a> will return a word if reading <a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fda0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fda629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00380">380</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="a9bd03dd0f2abde83f34635ab72564811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bd03dd0f2abde83f34635ab72564811">&#9670;&nbsp;</a></span>getButtonClick()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXONE::getButtonClick </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>
</div><div class="memdoc">
<p><a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a> will return true as long as the button is held down.</p>
<p>While <a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a> will only return it once.</p>
<p>So you instance if you need to increase a variable once you would use <a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a>, but if you need to drive a robot forward you would use <a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a>. </p><dl class="params"><dt>Parameters</dt><dd>
2015-04-07 16:07:33 +02:00
<table class="params">
<tr><td class="paramname">b</td><td><a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fd">ButtonEnum</a> to read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_x_b_o_x_o_n_e.html#a9bd03dd0f2abde83f34635ab72564811">getButtonClick(ButtonEnum b)</a> will return a bool, while <a class="el" href="class_x_b_o_x_o_n_e.html#ae197d34a4c2138d1889afe2c2e3345c4">getButtonPress(ButtonEnum b)</a> will return a word if reading <a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fda0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a94f7389d205c78830a5441370d7870fda629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00389">389</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="af49b526b57d3a3148537bdada9fb69bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af49b526b57d3a3148537bdada9fb69bc">&#9670;&nbsp;</a></span>getAnalogHat()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t XBOXONE::getAnalogHat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093">AnalogHatEnum</a>&#160;</td>
<td class="paramname"><em>a</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the analog value from the joysticks on the controller. </p><dl class="params"><dt>Parameters</dt><dd>
2015-04-07 16:07:33 +02:00
<table class="params">
<tr><td class="paramname">a</td><td>Either <a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093a383cb8895dd296b7f69ce845ed16b0ca">LeftHatX</a>, <a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093af3f3925efa9762c4e9e71ac7da7a94a3">LeftHatY</a>, <a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093aaeb027a0ae5bbc6ba25e1c78a6486c7b">RightHatX</a> or <a class="el" href="controller_enums_8h.html#a34dad8f0a0927471137c403216597093a7f1fb2db5381286691f4dec179ed5d5a">RightHatY</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a signed 16-bit integer. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00410">410</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="a0b2434ed7197361d229340773b0c3bda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b2434ed7197361d229340773b0c3bda">&#9670;&nbsp;</a></span>attachOnInit()</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXONE::attachOnInit </td>
<td>(</td>
<td class="paramtype">void(*)(void)&#160;</td>
<td class="paramname"><em>funcOnInit</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>Used to call your own function when the controller is successfully initialized. </p><dl class="params"><dt>Parameters</dt><dd>
2015-04-07 16:07:33 +02:00
<table class="params">
<tr><td class="paramname">funcOnInit</td><td>Function to call. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00159">159</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2018-10-13 15:47:19 +02:00
</div>
</div>
<a id="a506e8add57ffac652a28e8c5b7e72e85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a506e8add57ffac652a28e8c5b7e72e85">&#9670;&nbsp;</a></span>setRumbleOff()</h2>
2018-10-13 15:47:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXONE::setRumbleOff </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to set the rumble off. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00452">452</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2018-10-13 15:47:19 +02:00
</div>
</div>
<a id="a6586343cacf8705c7a3c2d4f479f2261"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6586343cacf8705c7a3c2d4f479f2261">&#9670;&nbsp;</a></span>setRumbleOn()</h2>
2018-10-13 15:47:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XBOXONE::setRumbleOn </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>leftTrigger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>rightTrigger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>leftMotor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>rightMotor</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to turn on rumble continuously. </p><dl class="params"><dt>Parameters</dt><dd>
2018-10-13 15:47:19 +02:00
<table class="params">
<tr><td class="paramname">leftTrigger</td><td>Left trigger force. </td></tr>
<tr><td class="paramname">rightTrigger</td><td>Right trigger force. </td></tr>
<tr><td class="paramname">leftMotor</td><td>Left motor force. </td></tr>
<tr><td class="paramname">rightMotor</td><td>Right motor force. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00474">474</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2018-10-13 15:47:19 +02:00
</div>
</div>
<a id="a499cc378b8ae7d8fd63baa1b4dab97b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a499cc378b8ae7d8fd63baa1b4dab97b5">&#9670;&nbsp;</a></span>EndpointXtract()</h2>
2018-10-13 15:47:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXONE::EndpointXtract </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>conf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>iface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>alt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>proto</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *&#160;</td>
<td class="paramname"><em>ep</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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_usb_config_xtracter.html">UsbConfigXtracter</a> implementation, used to extract endpoint information. </p><dl class="params"><dt>Parameters</dt><dd>
2018-10-13 15:47:19 +02:00
<table class="params">
<tr><td class="paramname">conf</td><td>Configuration value. </td></tr>
<tr><td class="paramname">iface</td><td>Interface number. </td></tr>
<tr><td class="paramname">alt</td><td>Alternate setting. </td></tr>
<tr><td class="paramname">proto</td><td>Interface Protocol. </td></tr>
<tr><td class="paramname">ep</td><td>Endpoint Descriptor. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="class_usb_config_xtracter.html#a7717ea27bb756568e0deb544d8331370">UsbConfigXtracter</a>.</p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00239">239</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2018-10-13 15:47:19 +02:00
</div>
</div>
<a id="a2eea30f2ce47380fc414d4fc4231335b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2eea30f2ce47380fc414d4fc4231335b">&#9670;&nbsp;</a></span>PrintEndpointDescriptor()</h2>
2018-10-13 15:47:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XBOXONE::PrintEndpointDescriptor </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *&#160;</td>
<td class="paramname"><em>ep_ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to print the <a class="el" href="class_u_s_b.html">USB</a> Endpoint Descriptor. </p><dl class="params"><dt>Parameters</dt><dd>
2018-10-13 15:47:19 +02:00
<table class="params">
<tr><td class="paramname">ep_ptr</td><td>Pointer to <a class="el" href="class_u_s_b.html">USB</a> Endpoint Descriptor. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html#l00265">265</a> of file <a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac055f7c7156ef515fe362e751fe1bae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac055f7c7156ef515fe362e751fe1bae3">&#9670;&nbsp;</a></span>XboxOneConnected</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XBOXONE::XboxOneConnected</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if a Xbox ONE controller is connected. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00177">177</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="a5b4e45cdd8695439d9772f55bb8ece6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b4e45cdd8695439d9772f55bb8ece6f">&#9670;&nbsp;</a></span>pUsb</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_u_s_b.html">USB</a>* XBOXONE::pUsb</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to <a class="el" href="class_u_s_b.html">USB</a> class instance. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00181">181</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="a800dd3559813c0f1771e8fdd30c4105b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a800dd3559813c0f1771e8fdd30c4105b">&#9670;&nbsp;</a></span>bAddress</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::bAddress</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Device address. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00183">183</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<a id="a2915fc1f1f3a9c5333bfd643defa0621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2915fc1f1f3a9c5333bfd643defa0621">&#9670;&nbsp;</a></span>epInfo</h2>
2015-04-07 16:07:33 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
2018-10-13 15:47:19 +02:00
<td class="memname"><a class="el" href="struct_ep_info.html">EpInfo</a> XBOXONE::epInfo[<a class="el" href="_x_b_o_x_o_n_e_8h.html#a8e9bf59d8bc051ff3fa38e2b327ade6e">XBOX_ONE_MAX_ENDPOINTS</a>]</td>
2015-04-07 16:07:33 +02:00
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Endpoint info structure. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00185">185</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2018-10-13 15:47:19 +02:00
</div>
</div>
<a id="ac6c75dcd5dfd5a9685a049f9bb8cb93f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6c75dcd5dfd5a9685a049f9bb8cb93f">&#9670;&nbsp;</a></span>bConfNum</h2>
2018-10-13 15:47:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::bConfNum</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Configuration number. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00188">188</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2018-10-13 15:47:19 +02:00
</div>
</div>
<a id="a958f262ed66dd5bf0ad7dfd54a369659"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a958f262ed66dd5bf0ad7dfd54a369659">&#9670;&nbsp;</a></span>bNumEP</h2>
2018-10-13 15:47:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t XBOXONE::bNumEP</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of endpoints in the configuration. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00190">190</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2018-10-13 15:47:19 +02:00
</div>
</div>
<a id="a4d0702c6fc0327535d909975670e9284"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d0702c6fc0327535d909975670e9284">&#9670;&nbsp;</a></span>qNextPollTime</h2>
2018-10-13 15:47:19 +02:00
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t XBOXONE::qNextPollTime</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Next poll time based on poll interval taken from the <a class="el" href="class_u_s_b.html">USB</a> descriptor. </p>
<p class="definition">Definition at line <a class="el" href="_x_b_o_x_o_n_e_8h_source.html#l00192">192</a> of file <a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a>.</p>
2015-04-07 16:07:33 +02:00
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_x_b_o_x_o_n_e_8h_source.html">XBOXONE.h</a></li>
<li><a class="el" href="_x_b_o_x_o_n_e_8cpp_source.html">XBOXONE.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
2015-04-07 16:07:33 +02:00
</small></address>
</body>
</html>