From 5ae2ffc1277c923593960e515e5c70ead7245304 Mon Sep 17 00:00:00 2001
From: Charlie Volow <69220471+chvolow24@users.noreply.github.com>
Date: Wed, 24 Jan 2024 23:14:30 -0500
Subject: [PATCH] document that text input is on by default

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
---
 include/SDL3/SDL_keyboard.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/SDL3/SDL_keyboard.h b/include/SDL3/SDL_keyboard.h
index 042ae43d0..08ca35c30 100644
--- a/include/SDL3/SDL_keyboard.h
+++ b/include/SDL3/SDL_keyboard.h
@@ -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
  * function in pair with SDL_StopTextInput().
  *
+ * Text input events are received by default.
+ *
  * On some platforms using this function activates the screen keyboard.
  *
  * \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.
  *
+ * Text input events are received by default.
+ *
  * \since This function is available since SDL 3.0.0.
  *
  * \sa SDL_StartTextInput