.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetScancodeName:
.\"   https://wiki.libsdl.org/SDL_GetScancodeName
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetScancodeName
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetScancodeName 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetScancodeName \- Get a human-readable name for a scancode\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "const char* SDL_GetScancodeName(SDL_Scancode scancode);
.fi
.SH DESCRIPTION
See 
.BR SDL_Scancode
 for details\[char46]
.B Warning
: The returned name is by design not stable across platforms,
e\[char46]g\[char46] the name for 
.BR
.BR SDL_SCANCODE_LGUI
is "Left GUI"
under Linux but "Left Windows" under Microsoft Windows, and some scancodes
like 
.BR
.BR SDL_SCANCODE_NONUSBACKSLASH
don't
have any name at all\[char46] There are even scancodes that share names, e\[char46]g\[char46]

.BR
.BR SDL_SCANCODE_RETURN
and

.BR
.BR SDL_SCANCODE_RETURN2
(both called "Return")\[char46] This
function is therefore unsuitable for creating a stable cross-platform
two-way mapping between strings and scancodes\[char46]

.SH FUNCTION PARAMETERS
.TP
.I scancode
the desired 
.BR SDL_Scancode
 to query
.SH RETURN VALUE
Returns a pointer to the name for the scancode\[char46] If the scancode doesn't
have a name this function returns an empty string ("")\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_GetScancodeFromKey (3),
.BR SDL_GetScancodeFromName (3)