Wiki Page Content

DRAFT

SDL_GetScancodeName

Use this function to get a human-readable name for a scancode.

Contents

  1. SDL_GetScancodeName
    1. Syntax
    2. Function Parameters
    3. Return Value
    4. Code Examples
    5. Remarks
    6. Version
    7. Related Functions

Syntax

const char* SDL_GetScancodeName(SDL_Scancode scancode)

Function Parameters

scancode

the desired SDL_Scancode to query

Return Value

Returns a pointer to the name for the scancode. If the scancode doesn't have a name this function returns an empty string ("").

Code Examples

You can add your code example here

Remarks

See SDL_Scancode for details.

/!\ Warning: The returned name is by design not stable across platforms, e.g. the name for SDL_SCANCODE_LGUI is "Left GUI" under Linux but "Left Windows" under Microsoft Windows, and some scancodes like SDL_SCANCODE_NONUSBACKSLASH don't have any name at all. There are even scancodes that share names, e.g. SDL_SCANCODE_RETURN and SDL_SCANCODE_RETURN2 (both called "Return"). This function is therefore unsuitable for creating a stable cross-platform two-way mapping between strings and scancodes.

Version

This function is available since SDL 2.0.0.

CategoryAPI, CategoryKeyboard

None: SDL_GetScancodeName (last edited 2016-10-21 22:04:39 by PhilippWiesemann)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit