---
name: "SDL_GetKeyState"
section: "3"
platform: "linux"
package: "libsdl1.2-dev"
version: "1.2.15+dfsg2-8"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_GetKeyState"
---

# SDL\_GetKeyState(3)

Get a snapshot of the current keyboard state

## NAME

SDL\_GetKeyState - Get a snapshot of the current keyboard state

## SYNOPSIS

**#include "SDL.h"**

**Uint8 \*SDL\_GetKeyState**(**int \*numkeys**);

## DESCRIPTION

Gets a snapshot of the current keyboard state. The current state is return as a pointer to an array, the size of this array is stored in **numkeys**. The array is indexed by the **SDLK\_\*** symbols. A value of 1 means the key is pressed and a value of 0 means its not. The pointer returned is a pointer to an internal SDL array and should not be freed by the caller.

**Note:**

**Use SDL\_PumpEvents** to update the state array.

## EXAMPLE

```
Uint8 *keystate = SDL_GetKeyState(NULL);
if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed.
");
```

## SEE ALSO

**SDL Key Symbols**, **SDL\_PumpEvents**