From 2a6baf50e92c00aa53fafec246f8d459d862bf1a Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Mon, 14 Jul 2025 00:32:46 -0400
Subject: [PATCH] include: Added some basic documentation so SDL_KeyCode shows
up on the wiki.
Fixes #11525.
---
include/SDL_keycode.h | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/include/SDL_keycode.h b/include/SDL_keycode.h
index eb1678e3861c4..3be801c3970fa 100644
--- a/include/SDL_keycode.h
+++ b/include/SDL_keycode.h
@@ -41,12 +41,18 @@
*
* A special exception is the number keys at the top of the keyboard which map
* to SDLK_0...SDLK_9 on AZERTY layouts.
+ *
+ * The actual values that might be set for this type are listed in the
+ * SDL_KeyCode (capital C) enumeration.
*/
typedef Sint32 SDL_Keycode;
#define SDLK_SCANCODE_MASK (1<<30)
#define SDL_SCANCODE_TO_KEYCODE(X) (X | SDLK_SCANCODE_MASK)
+/**
+ * The possible values for keycodes.
+ */
typedef enum SDL_KeyCode
{
SDLK_UNKNOWN = 0,