SDL_GetModState(3)

💅 SDL_GetModState 💅

okay bestie, listen up — this is a page from the SDL3 FUNCTIONS collection, and today's main character is SDL_GetModState. she's small, she's simple, and she's about to tell you exactly which modifier keys your keyboard is holding down right now. shift? ctrl? alt? gui? she knows. she always knows. 👑

---

🌸 NAME 🌸

SDL_GetModState — get the current key modifier state for the keyboard. no cap, that's literally the whole job description. 💖

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_keyboard.h>

SDL_Keymod SDL_GetModState(void);

okay so you include the header, you call her with no arguments at all — she takes void, she needs nothing from you — and she hands you back an SDL_Keymod. she's low maintenance like that. 🎀

---

🦋 RETURN VALUE 🦋

She returns an OR'd combination of the modifier keys for the keyboard. 🫶

that's it. that's the tea. it's giving bitmask, it's giving "every modifier currently held gets its own bit OR'd together." you want to check for one specific one? you AND it, bestie. iykyk. 💅

---

🔥 THREAD SAFETY 🔥

It is safe to call this function from any thread. 🌈

so go off, spawn all the threads you want, she does not care. main character energy means being available to everyone. 💜

---

⭐ AVAILABILITY ⭐

This function has been available since SDL 3.2.0. she's not new new, but she's not ancient either — she's in her prime. 👑

---

💖 SEE ALSO 💖

• SDL_GetKeyboardState(3) — the girlies who want the whole keyboard, not just the modifiers
• SDL_SetModState(3) — if you're feeling chaotic and want to set the mod state yourself 🙈

---

fr fr though — remember she only reports the modifier keys. for the full keys-down situation you're gonna want her friend in SEE ALSO. don't get it twisted. 😭

---

and that's a wrap, bestie! 🎀 this page came to you from Simple Directmedia Layer, documenting SDL 3.4.18 — mwah, slay, go write some keyboard code, you absolute icon. 💅✨🦋