SDL_StopTextInput(3)

SDL_StopTextInput3

Stop receiving any text input events in a window.

Usage

#include "SDL3/SDL.h"

bool SDL_StopTextInput(SDL_Window *window);

Header file

Defined in SDL3/SDL_keyboard.h

Overview

If SDL_StartTextInput () showed the screen keyboard, this function will hide it.

Function parameters

window

the window to disable 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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.