summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorSam Lantinga <slouken@libsdl.org>2011-10-24 21:34:54 -0400
committerSam Lantinga <slouken@libsdl.org>2011-10-24 21:34:54 -0400
commit517d92d975d460f17590afdf4455d87fbf3c268e (patch)
treee3bd2f05ce47a6349d45cd309960bc1929f8ce00 /include
parentb2faaf2be49e00ef9750de52b453c2f9d562e4f1 (diff)
Added SDL_GetScancodeFromName() and SDL_GetKeyFromName()
Diffstat (limited to 'include')
-rw-r--r--include/SDL_keyboard.h26
1 files changed, 21 insertions, 5 deletions
diff --git a/include/SDL_keyboard.h b/include/SDL_keyboard.h
index c390cb69..1f9a66df 100644
--- a/include/SDL_keyboard.h
+++ b/include/SDL_keyboard.h
@@ -111,15 +111,22 @@ extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key);
/**
* \brief Get a human-readable name for a scancode.
*
- * \return 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 scancode doesn't have a name, this function returns
+ * \return A pointer to the name for the scancode.
+ * If the scancode doesn't have a name, this function returns
* an empty string ("").
*
* \sa SDL_Scancode
*/
-extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_Scancode
- scancode);
+extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_Scancode scancode);
+
+/**
+ * \brief Get a scancode from a human-readable name
+ *
+ * \return scancode, or SDL_SCANCODE_UNKNOWN if the name wasn't recognized
+ *
+ * \sa SDL_Scancode
+ */
+extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromName(const char *name);
/**
* \brief Get a human-readable name for a key.
@@ -134,6 +141,15 @@ extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_Scancode
extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDL_Keycode key);
/**
+ * \brief Get a key code from a human-readable name
+ *
+ * \return key code, or SDLK_UNKNOWN if the name wasn't recognized
+ *
+ * \sa SDL_Keycode
+ */
+extern DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromName(const char *name);
+
+/**
* \brief Start accepting Unicode text input events.
*
* \sa SDL_StopTextInput()