specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fixed typo in XBOXUSB library

Browse source
This commit is contained in:
Kristian Sloth Lauszus 2013-02-17 02:40:24 +01:00
parent cf98f0c6fa
commit d33cf25bbf
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
class_x_b_o_x_u_s_b.html
View file

@ -374,16 +374,16 @@ Protected Attributes</h2></td></tr>
</tr> </tr>
</table> </table>
</div><div class="memdoc"> </div><div class="memdoc">
<p>getButtonPress(uint8_t controller, Button b) will return true as long as the button is held down.</p> <p><a class="el" href="class_x_b_o_x_u_s_b.html#ae18ff481e9dd91658e5e45e7958e7775">getButtonPress(Button b)</a> will return true as long as the button is held down.</p>
<p>While getButtonClick(uint8_t controller, Button b) will only return it once.</p> <p>While <a class="el" href="class_x_b_o_x_u_s_b.html#ab85b8ce772b122f1b9df489c7e045635">getButtonClick(Button b)</a> will only return it once.</p>
<p>So you instance if you need to increase a variable once you would use getButtonClick(uint8_t controller, Button b), but if you need to drive a robot forward you would use getButtonPress(uint8_t controller, Button b). </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_u_s_b.html#ab85b8ce772b122f1b9df489c7e045635">getButtonClick(Button b)</a>, but if you need to drive a robot forward you would use <a class="el" href="class_x_b_o_x_u_s_b.html#ae18ff481e9dd91658e5e45e7958e7775">getButtonPress(Button b)</a>. </p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">b</td><td><a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0">Button</a> to read. </td></tr> <tr><td class="paramname">b</td><td><a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0">Button</a> to read. </td></tr>
</table> </table>
</dd> </dd>
</dl> </dl>
<dl class="section return"><dt>Returns</dt><dd>getButtonClick(uint8_t controller, Button b) will return a bool, but getButtonPress(uint8_t controller, Button b) will return a byte if reading <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_x_b_o_x_u_s_b.html#ab85b8ce772b122f1b9df489c7e045635">getButtonClick(Button b)</a> will return a bool, but <a class="el" href="class_x_b_o_x_u_s_b.html#ae18ff481e9dd91658e5e45e7958e7775">getButtonPress(Button b)</a> will return a byte if reading <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl>
<p>Definition at line <a class="el" href="_x_b_o_x_u_s_b_8cpp_source.html#l00278">278</a> of file <a class="el" href="_x_b_o_x_u_s_b_8cpp_source.html">XBOXUSB.cpp</a>.</p> <p>Definition at line <a class="el" href="_x_b_o_x_u_s_b_8cpp_source.html#l00278">278</a> of file <a class="el" href="_x_b_o_x_u_s_b_8cpp_source.html">XBOXUSB.cpp</a>.</p>
@ -402,16 +402,16 @@ Protected Attributes</h2></td></tr>
</tr> </tr>
</table> </table>
</div><div class="memdoc"> </div><div class="memdoc">
<p>getButtonPress(uint8_t controller, Button b) will return true as long as the button is held down.</p> <p><a class="el" href="class_x_b_o_x_u_s_b.html#ae18ff481e9dd91658e5e45e7958e7775">getButtonPress(Button b)</a> will return true as long as the button is held down.</p>
<p>While getButtonClick(uint8_t controller, Button b) will only return it once.</p> <p>While <a class="el" href="class_x_b_o_x_u_s_b.html#ab85b8ce772b122f1b9df489c7e045635">getButtonClick(Button b)</a> will only return it once.</p>
<p>So you instance if you need to increase a variable once you would use getButtonClick(uint8_t controller, Button b), but if you need to drive a robot forward you would use getButtonPress(uint8_t controller, Button b). </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_u_s_b.html#ab85b8ce772b122f1b9df489c7e045635">getButtonClick(Button b)</a>, but if you need to drive a robot forward you would use <a class="el" href="class_x_b_o_x_u_s_b.html#ae18ff481e9dd91658e5e45e7958e7775">getButtonPress(Button b)</a>. </p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">b</td><td><a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0">Button</a> to read. </td></tr> <tr><td class="paramname">b</td><td><a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0">Button</a> to read. </td></tr>
</table> </table>
</dd> </dd>
</dl> </dl>
<dl class="section return"><dt>Returns</dt><dd>getButtonClick(uint8_t controller, Button b) will return a bool, but getButtonPress(uint8_t controller, Button b) will return a byte if reading <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_x_b_o_x_u_s_b.html#ab85b8ce772b122f1b9df489c7e045635">getButtonClick(Button b)</a> will return a bool, but <a class="el" href="class_x_b_o_x_u_s_b.html#ae18ff481e9dd91658e5e45e7958e7775">getButtonPress(Button b)</a> will return a byte if reading <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a0adffb24dae0c41be5b803f4d444f066">L2</a> or <a class="el" href="controller_enums_8h.html#a03bfec859eac87be20f8952c1eb89de0a629d7b403cea5f826352f3aefb9a6d6a">R2</a>. </dd></dl>
<p>Definition at line <a class="el" href="_x_b_o_x_u_s_b_8cpp_source.html#l00285">285</a> of file <a class="el" href="_x_b_o_x_u_s_b_8cpp_source.html">XBOXUSB.cpp</a>.</p> <p>Definition at line <a class="el" href="_x_b_o_x_u_s_b_8cpp_source.html#l00285">285</a> of file <a class="el" href="_x_b_o_x_u_s_b_8cpp_source.html">XBOXUSB.cpp</a>.</p>
@ -547,7 +547,7 @@ Protected Attributes</h2></td></tr>
<p>Set LED value. Without using the <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6">LED</a> or <a class="el" href="xbox_enums_8h.html#a57effb96f46e458675a2653d4c543ca2">LEDMode</a> enum. </p> <p>Set LED value. Without using the <a class="el" href="controller_enums_8h.html#aadcb6002d2b42fdfe01490f730ab00a6">LED</a> or <a class="el" href="xbox_enums_8h.html#a57effb96f46e458675a2653d4c543ca2">LEDMode</a> enum. </p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">value</td><td>See: setLedOff(uint8_t controller), setLedOn(uint8_t controller, LED l), setLedBlink(uint8_t controller, LED l), and setLedMode(uint8_t controller, LEDMode lm). </td></tr> <tr><td class="paramname">value</td><td>See: <a class="el" href="class_x_b_o_x_u_s_b.html#a155637a4ef946f19c7ee40c0fc1c6b98">setLedOff()</a>, <a class="el" href="class_x_b_o_x_u_s_b.html#a2348a35d4302f0a76bbeb319e84349a1">setLedOn(LED l)</a>, <a class="el" href="class_x_b_o_x_u_s_b.html#acc52982e6105d029d1e0980367dc10f6">setLedBlink(LED l)</a>, and <a class="el" href="class_x_b_o_x_u_s_b.html#a7426adef803da704df7593858389926e">setLedMode(LEDMode lm)</a>. </td></tr>
</table> </table>
</dd> </dd>
</dl> </dl>