From d33cf25bbf921df9c8762f9db91c520d0cb69863 Mon Sep 17 00:00:00 2001 From: Kristian Sloth Lauszus Date: Sun, 17 Feb 2013 02:40:24 +0100 Subject: [PATCH] Fixed typo in XBOXUSB library --- class_x_b_o_x_u_s_b.html | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/class_x_b_o_x_u_s_b.html b/class_x_b_o_x_u_s_b.html index 8e594931..6567ec25 100644 --- a/class_x_b_o_x_u_s_b.html +++ b/class_x_b_o_x_u_s_b.html @@ -374,16 +374,16 @@ Protected Attributes
-

getButtonPress(uint8_t controller, Button b) will return true as long as the button is held down.

-

While getButtonClick(uint8_t controller, Button b) will only return it once.

-

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).

+

getButtonPress(Button b) will return true as long as the button is held down.

+

While getButtonClick(Button b) will only return it once.

+

So you instance if you need to increase a variable once you would use getButtonClick(Button b), but if you need to drive a robot forward you would use getButtonPress(Button b).

Parameters
bButton to read.
-
Returns
getButtonClick(uint8_t controller, Button b) will return a bool, but getButtonPress(uint8_t controller, Button b) will return a byte if reading L2 or R2.
+
Returns
getButtonClick(Button b) will return a bool, but getButtonPress(Button b) will return a byte if reading L2 or R2.

Definition at line 278 of file XBOXUSB.cpp.

@@ -402,16 +402,16 @@ Protected Attributes
-

getButtonPress(uint8_t controller, Button b) will return true as long as the button is held down.

-

While getButtonClick(uint8_t controller, Button b) will only return it once.

-

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).

+

getButtonPress(Button b) will return true as long as the button is held down.

+

While getButtonClick(Button b) will only return it once.

+

So you instance if you need to increase a variable once you would use getButtonClick(Button b), but if you need to drive a robot forward you would use getButtonPress(Button b).

Parameters
bButton to read.
-
Returns
getButtonClick(uint8_t controller, Button b) will return a bool, but getButtonPress(uint8_t controller, Button b) will return a byte if reading L2 or R2.
+
Returns
getButtonClick(Button b) will return a bool, but getButtonPress(Button b) will return a byte if reading L2 or R2.

Definition at line 285 of file XBOXUSB.cpp.

@@ -547,7 +547,7 @@ Protected Attributes

Set LED value. Without using the LED or LEDMode enum.

Parameters
- +
valueSee: setLedOff(uint8_t controller), setLedOn(uint8_t controller, LED l), setLedBlink(uint8_t controller, LED l), and setLedMode(uint8_t controller, LEDMode lm).
valueSee: setLedOff(), setLedOn(LED l), setLedBlink(LED l), and setLedMode(LEDMode lm).