SDL_StopTextInput - Man Page

Stop receiving any text input events in a window.

Header File

Defined in SDL3/SDL_keyboard.h

Synopsis

#include "SDL3/SDL.h"

bool SDL_StopTextInput(SDL_Window *window);

Description

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.

See Also

·(3), SDL_StartTextInput(3)

Referenced By

SDL_ClearComposition(3), SDL_StartTextInput(3), SDL_StartTextInputWithProperties(3), SDL_TextInputEvent.3type(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS