table of contents
other versions
- testing 3.2.4+ds-2
- unstable 3.2.4+ds-2
- experimental 3.2.4+git20250218+ds-1
SDL_StopTextInput(3) | SDL3 FUNCTIONS | SDL_StopTextInput(3) |
NAME¶
SDL_StopTextInput - 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)
SDL 3.2.5 | Simple Directmedia Layer |