---
name: "SDL_StartTextInput"
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_StartTextInput"
---

# SDL\_StartTextInput(3)

Start accepting Unicode text input events in a window.

## NAME

SDL\_StartTextInput - Start accepting Unicode text input events in a window.

## HEADER FILE

Defined in SDL3/SDL\_keyboard.h

## SYNOPSIS

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

**bool SDL\_StartTextInput(SDL\_Window \*window);**

## DESCRIPTION

This function will enable text input ( **SDL\_EVENT\_TEXT\_INPUT**\
  and

**SDL\_EVENT\_TEXT\_EDITING**\
  events) in the specified window. Please use this function paired with

**SDL\_StopTextInput** ().

Text input events are not received by default.

On some platforms using this function shows the screen keyboard and/or activates an IME, which can prevent some key press events from being passed through.

## FUNCTION PARAMETERS

- *window*

  the window to enable text input.

## RETURN VALUE

Returns true on success or false on failure; call

**SDL\_GetError** () for more information.

## THREAD SAFETY

This function should only be called on the main thread.

## AVAILABILITY

This function is available since SDL 3.2.0.

## SEE ALSO

**•**(3), [**SDL\_SetTextInputArea**(3)](/SDL_SetTextInputArea/3.md), **•**(3), [**SDL\_StartTextInputWithProperties**(3)](/SDL_StartTextInputWithProperties/3.md), **•**(3), [**SDL\_StopTextInput**(3)](/SDL_StopTextInput/3.md), **•**(3), [**SDL\_TextInputActive**(3)](/SDL_TextInputActive/3.md)