DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update hid.h comments

Browse Source 
Nit-picky update to accurately describe the `hidKeys*()` functions, and how to extract individual bits from them.
This commit is contained in:
Ryan Loebs 2016-02-24 04:32:57 -08:00
parent bb9853798b
commit 1c55370cee
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
libctru/include/3ds/services/hid.h
View File

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