mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

include: Clean up SDL_GetKeyName documentation.

This commit is contained in:
Ryan C. Gordon 2024-07-02 12:29:33 -04:00
parent f787790243
commit e290d16c47
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/SDL3/SDL_keyboard.h
View File

@ -324,13 +324,12 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromName(const char *nam
* Both lowercase and uppercase alphabetic keycodes have uppercase names, e.g.
* SDL_Keycode 'a' and 'A' both have the name "A".
*
* If the key doesn't have a name, this function returns an empty string ("").
*
* The returned string follows the SDL_GetStringRule.
*
* \param key the desired SDL_Keycode to query.
* \returns a pointer to a UTF-8 string that stays valid at least until the
* next call to this function. If you need it around any longer, you
* must copy it. If the key doesn't have a name, this function
* returns an empty string ("").
* \returns a UTF-8 encoded string of the key name.
*
* \since This function is available since SDL 3.0.0.
*