SDL_SetModState(3)

💖 SDL_SetModState 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, we're talking about SDL_SetModState today and honestly? it's giving main character energy. sit down, hydrate, let's go 🫶

---

✨ NAME ✨

SDL_SetModState — set the current key modifier state for the keyboard. that's it, that's the job, no cap 🎀

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_keyboard.h>

void SDL_SetModState(SDL_Keymod modstate);

---

🦋 DESCRIPTION 🦋

okay so. SDL_SetModState() is literally the inverse of SDL_GetModState(), they're giving opposite sides of the same coin 💅

what it does is let you impose modifier key states on your application. like, you just pass whatever modifier states you want into modstate and SDL is like "say less, got it." and this value? it may be a bitwise, OR'd combination of SDL_Keymod values. so you can stack them up like accessories, periodt ✨

⚠️ but listen, important: this does not change the keyboard state. it only changes the key modifier flags that SDL reports. so don't come for me later being like "why is my actual keyboard not doing the thing" — that's not what this function is for, bestie 😭

---

🎀 FUNCTION PARAMETERS 🎀

• modstate — the desired SDL_Keymod for the keyboard. whatever you want it to be, you just hand it over, iconic 👑

---

🌈 THREAD SAFETY 🌈

it is safe to call this function from any thread. any. thread. go off, multithreaded queen 💜

---

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0 — so if you're on something older, sorry babe, upgrade time 🙈

---

👑 SEE ALSO 👑

• SDL_GetModState(3) — the other half of this duo, the reading to this writing, the yin to this yang, go check it out fr fr 🦋

---

and that's the whole page!! go forth and set those modifier states, you absolute legend 🍓

this has been your girl from Simple Directmedia Layer, bringing you SDL 3.4.18 — mwah, catch you in the next man page 💖✨