SDL_SetTextInputArea(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

✨ SDL_SetTextInputArea ✨

okay bestie, welcome to the SDL_SetTextInputArea(3) page — it's a real one from the SDL3 FUNCTIONS crew, and it's literally all about telling SDL where your text input vibes live 💅

🌸 NAME 🌸

SDL_SetTextInputArea — set the area used to type Unicode text input.

yes queen, we're setting the text input area, that's the whole job 🎀

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_keyboard.h>

bool SDL_SetTextInputArea(SDL_Window *window, const SDL_Rect *rect, int cursor);

look at that signature, she's giving function, she's giving bool, she's giving three parameters and not one more ✨

💖 DESCRIPTION 💖

So here's the tea: native input methods may place a window with word suggestions near the cursor — and you want that little suggestion popup to not cover the text being entered. Rude of it, honestly. So this function is how you handle that. 🙈

🎀 FUNCTION PARAMETERS 🎀

  • window — the window for which to set the text input area. your main character window, fr fr
  • rect — the SDL_Rect representing the text input area, in window coordinates, or NULL to clear it. pass NULL and it's gone, periodt
  • cursor — the offset of the current cursor location relative to rect->x, in window coordinates. it's an offset, bestie, not a coordinate, do not come for me

⭐ RETURN VALUE ⭐

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

so if it's false, go ask SDL_GetError() what happened, she'll tell you everything 😭

🧚 THREAD SAFETY 🧚

This function should only be called on the main thread.

main thread ONLY, bestie. do not be cute with the other threads. i'm serious. 💀

🌈 AVAILABILITY 🌈

This function is available since SDL 3.2.0.

3.2.0 girlies rise up, you have been blessed 👑

🔥 SEE ALSO 🔥

go read those too, iykyk 🫶

and that's the whole page, no cap — this was the Simple Directmedia Layer manual, SDL 3.4.18 edition, dated 2024, and honestly? iconic. slay. bye bestie 💜

📦 where this page comes from