---
name: "SDL_GetTextInputArea"
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_GetTextInputArea"
---

# SDL\_GetTextInputArea(3)

Get the area used to type Unicode text input.

## NAME

SDL\_GetTextInputArea - Get the area used to type Unicode text input.

## HEADER FILE

Defined in SDL3/SDL\_keyboard.h

## SYNOPSIS

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

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

## DESCRIPTION

This returns the values previously set by

**SDL\_SetTextInputArea** ().

## FUNCTION PARAMETERS

- *window*

  the window for which to query the text input area.

- *rect*

  a pointer to an  **SDL\_Rect**\
    filled in with the text input area, may be NULL.

- *cursor*

  a pointer to the offset of the current cursor location relative to **rect-\>x** , may be NULL.

## 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)