]> Chaos Git - corbenik/ctrulib.git/commitdiff
Update hid.h comments
authorRyan Loebs <obsidianx@gmail.com>
Wed, 24 Feb 2016 12:32:57 +0000 (04:32 -0800)
committerRyan Loebs <obsidianx@gmail.com>
Wed, 24 Feb 2016 12:32:57 +0000 (04:32 -0800)
Nit-picky update to accurately describe the `hidKeys*()` functions, and how to extract individual bits from them.

libctru/include/3ds/services/hid.h

index f5a624474e84e06238bbeeada3502557e993c64c..f06da12bfa015341662fee9b8e53401800f5bf1b 100644 (file)
@@ -95,23 +95,23 @@ void hidExit(void);
 void hidScanInput(void);
 
 /**
- * @brief Gets the currently held keys.
- * Individual keys can be checked by ORing them with this value.
- * @return Keys held.
+ * @brief Returns a bitmask of held buttons.
+ * Individual buttons can be extracted using binary AND.
+ * @return 32-bit bitmask of held buttons (1+ frames).
  */
 u32 hidKeysHeld(void);
 
 /**
- * @brief Gets keys that were just pressed.
- * Individual keys can be checked by ORing them with this value.
- * @return Keys down.
+ * @brief Returns a bitmask of newly pressed buttons, this frame.
+ * Individual buttons can be extracted using binary AND.
+ * @return 32-bit bitmask of newly pressed buttons.
  */
 u32 hidKeysDown(void);
 
 /**
- * @brief Gets keys that were just released.
- * Individual keys can be checked by ORing them with this value.
- * @return Keys up.
+* @brief Returns a bitmask of newly released buttons, this frame.
+ * Individual buttons can be extracted using binary AND.
+ * @return 32-bit bitmask of newly released buttons.
  */
 u32 hidKeysUp(void);