(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_StopTextInput

Stop receiving any text input events in a window.

Header File

Defined in <SDL3/SDL_keyboard.h>

Syntax

bool SDL_StopTextInput(SDL_Window *window);

Function Parameters

SDL_Window *

window

the window to disable text input.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_StartTextInput

---

CategoryAPI, CategoryAPIFunction, CategoryKeyboard

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.