gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

document that text input is on by default

Browse Source 
See:
https://discourse.libsdl.org/t/text-input-is-active-by-default-hampering-frame-rate/24396
https://discourse.libsdl.org/t/restoring-text-input-to-the-default-state/42690
This commit is contained in:
Charlie Volow
2024-01-24 23:14:30 -05:00
committed by Sam Lantinga
parent 5e96e410d6
commit 5ae2ffc127
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/SDL3/SDL_keyboard.h
View File

@@ -251,6 +251,8 @@ extern DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromName(const char *name);
* and SDL_TextEditingEvent (SDL_EVENT_TEXT_EDITING) events. Please use this * and SDL_TextEditingEvent (SDL_EVENT_TEXT_EDITING) events. Please use this
* function in pair with SDL_StopTextInput(). * function in pair with SDL_StopTextInput().
* *
* Text input events are received by default.
*
* On some platforms using this function activates the screen keyboard. * On some platforms using this function activates the screen keyboard.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
@@ -274,6 +276,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_TextInputActive(void);
/** /**
* Stop receiving any text input events. * Stop receiving any text input events.
* *
* Text input events are received by default.
*
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *
* \sa SDL_StartTextInput * \sa SDL_StartTextInput