---
name: "SDL_SetTextInputArea"
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_SetTextInputArea"
---

# SDL\_SetTextInputArea(3)

Set the area used to type Unicode text input.

## NAME

SDL\_SetTextInputArea - Set the area used to type Unicode text input.

## HEADER FILE

Defined in SDL3/SDL\_keyboard.h

## SYNOPSIS

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

**bool SDL\_SetTextInputArea(SDL\_Window \*window, const SDL\_Rect \*rect, int cursor);**

## DESCRIPTION

Native input methods may place a window with word suggestions near the cursor, without covering the text being entered.

## FUNCTION PARAMETERS

- *window*

  the window for which to set the text input area.

- *rect*

  the  **SDL\_Rect**\
    representing the text input area, in window coordinates, or NULL to clear it.

- *cursor*

  the offset of the current cursor location relative to **rect-\>x** , in window coordinates.

## 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\_GetTextInputArea**(3)](/SDL_GetTextInputArea/3.md), **•**(3), [**SDL\_StartTextInput**(3)](/SDL_StartTextInput/3.md)