SDL_GetScancodeFromKey(3)

💖 SDL_GetScancodeFromKey(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS section of the SDL_GetScancodeFromKey(3) manual — yes we're doing keyboard archaeology today and honestly? it's giving detective energy 🔍✨

---

✨ NAME ✨

SDL_GetScancodeFromKey — get the scancode that matches the keycode you hand it, according to whatever keyboard layout is currently vibing on the system. 🎀

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_keyboard.h>

SDL_Scancode SDL_GetScancodeFromKey(SDL_Keycode key, SDL_Keymod *modstate);

like, that's it. two args, one return, no drama. 💅

---

🦋 DESCRIPTION 🦋

so here's the tea, bestie: there may be multiple scancode + modifier states that can generate this keycode, and this function will just return the first one found. no deliberation, no committee meeting, no "let me think about it" — first match wins, periodt. 👑

---

🎀 FUNCTION PARAMETERS 🎀

• key — the desired SDL_Keycode you wanna query. that's the thing you're asking about. 🫶
• modstate — a pointer to the modifier state that would be used when the scancode generates this key. may be NULL, so don't stress if you don't have one handy. 🌈

---

⭐ RETURN VALUE ⭐

Returns the SDL_Scancode that corresponds to the given SDL_Keycode. iconic behaviour, truly. 🔥

---

💀 THREAD SAFETY 💀

This function is not thread safe.

not me having to say this but: do NOT call this from multiple threads at the same time, bestie. it will not go well. 🙈

---

🌟 AVAILABILITY 🌟

This function is available since SDL 3.2.0. so if you're on anything older, it's giving nothing, i'm so sorry. 😭

---

💜 SEE ALSO 💜

• SDL_GetKeyFromScancode(3) — the reverse direction, the remix 🔁
• SDL_GetScancodeName(3) — for when you want the scancode to have a cute little name 🏷️

---

okay bye bestie, this page was brought to you by Simple Directmedia Layer 💖 running SDL 3.4.18 — go forth and translate your keycodes, you absolute main character 👑✨🦋