mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-12-07 23:22:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

include: A ton of little documentation tweaks, fixes, and improvements.

Browse Source 
This is just stuff I noticed while working on the wikiheaders updates. A
thorough pass over all the docs would not be terrible, and maybe a simple
script to check for consistency (does everything have a `\since` on it? etc)
might be nice, too.
This commit is contained in:
Ryan C. Gordon
2024-04-08 22:36:57 -04:00
parent 645073961d
commit ad090d2444
45 changed files with 1565 additions and 833 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
include/SDL3/SDL_scancode.h
View File

@@ -31,19 +31,20 @@
#include <SDL3/SDL_stdinc.h>
/**
* The SDL keyboard scancode representation.
* The SDL keyboard scancode representation.
*
* An SDL scancode is the physical representation of a key on the keyboard,
* independent of language and keyboard mapping.
* An SDL scancode is the physical representation of a key on the keyboard,
* independent of language and keyboard mapping.
*
* Values of this type are used to represent keyboard keys, among other places
* in the \link SDL_Keysym::scancode key.keysym.scancode \endlink field of the
* SDL_Event structure.
* Values of this type are used to represent keyboard keys, among other places
* in the `keysym.scancode` field of the SDL_KeyboardEvent structure.
*
* The values in this enumeration are based on the USB usage page standard:
* https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf
* The values in this enumeration are based on the USB usage page standard:
* https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf
*
* \since This enum is available since SDL 3.0.0.
*/
typedef enum
typedef enum SDL_Scancode
{
SDL_SCANCODE_UNKNOWN = 0,