From 1c55370ceefb79e5881af900fc5d71eca8cfdc9c Mon Sep 17 00:00:00 2001 From: Ryan Loebs Date: Wed, 24 Feb 2016 04:32:57 -0800 Subject: [PATCH] Update hid.h comments Nit-picky update to accurately describe the `hidKeys*()` functions, and how to extract individual bits from them. --- libctru/include/3ds/services/hid.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/libctru/include/3ds/services/hid.h b/libctru/include/3ds/services/hid.h index f5a6244..f06da12 100644 --- a/libctru/include/3ds/services/hid.h +++ b/libctru/include/3ds/services/hid.h @@ -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); -- 2.39.5