From ef9fdd0fa5dcfbf4c3c538b56d285230e8d6af1e Mon Sep 17 00:00:00 2001 From: Ryan Roden-Corrent Date: Tue, 10 Aug 2021 12:38:32 -0400 Subject: [PATCH] Document Get{Key,Char}Pressed return value. (#1909) I think it is useful to know what the empty behavior is in cases where you are enumerating key presses (e.g. implementing "press any key to continue"). --- src/raylib.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/raylib.h b/src/raylib.h index 92e592e9..f02f46f6 100644 --- a/src/raylib.h +++ b/src/raylib.h @@ -1077,8 +1077,8 @@ RLAPI bool IsKeyDown(int key); // Check if a key RLAPI bool IsKeyReleased(int key); // Check if a key has been released once RLAPI bool IsKeyUp(int key); // Check if a key is NOT being pressed RLAPI void SetExitKey(int key); // Set a custom key to exit program (default is ESC) -RLAPI int GetKeyPressed(void); // Get key pressed (keycode), call it multiple times for keys queued -RLAPI int GetCharPressed(void); // Get char pressed (unicode), call it multiple times for chars queued +RLAPI int GetKeyPressed(void); // Get key pressed (keycode), call it multiple times for keys queued. Returns 0 when the queue is empty. +RLAPI int GetCharPressed(void); // Get char pressed (unicode), call it multiple times for chars queued. Returns 0 when the queue is empty. // Input-related functions: gamepads RLAPI bool IsGamepadAvailable(int gamepad); // Check if a gamepad is available