---
name: "SDL_GetScancodeFromKey"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_GetScancodeFromKey"
---

# SDL\_GetScancodeFromKey(3)

Get the scancode corresponding to the given key code according to the current keyboard layout.

## NAME

SDL\_GetScancodeFromKey - Get the scancode corresponding to the given key code according to the current keyboard layout.

## HEADER FILE

Defined in SDL3/SDL\_keyboard.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**SDL\_Scancode SDL\_GetScancodeFromKey(SDL\_Keycode key, SDL\_Keymod \*modstate);**

## DESCRIPTION

Note that there may be multiple scancode+modifier states that can generate this keycode, this will just return the first one found.

## FUNCTION PARAMETERS

- *key*

  the desired  **SDL\_Keycode**\
    to query.

- *modstate*

  a pointer to the modifier state that would be used when the scancode generates this key, may be NULL.

## RETURN VALUE

( **SDL\_Scancode** ) Returns the  **SDL\_Scancode**

that corresponds to the given  **SDL\_Keycode** .

## THREAD SAFETY

This function is not thread safe.

## AVAILABILITY

This function is available since SDL 3.2.0.

## SEE ALSO

**•**(3), [**SDL\_GetKeyFromScancode**(3)](/SDL_GetKeyFromScancode/3.md), **•**(3), [**SDL\_GetScancodeName**(3)](/SDL_GetScancodeName/3.md)