SDL_WindowsMessageHook(3type)

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

💅 SDL_WindowsMessageHook — the SDL3 DATATYPES tea 🎀

okay bestie, gather round, because we're talking about SDL_WindowsMessageHook(3type) — a whole datatype from the SDL3 era and honestly? it's giving "Windows insider access". ✨

🌸 NAME 🌸

SDL_WindowsMessageHook — it's a callback, babes. Specifically the callback you'd hand over to SDL_SetWindowsMessageHook. that's the whole job. iconic behavior.

✨ SYNOPSIS ✨

#include <SDL3/SDL_system.h>

typedef bool (SDLCALL *SDL_WindowsMessageHook)(void *userdata, MSG *msg);

look at her. a function pointer. a typedef. she's literally a bool-returning, SDLCALL-convention, two-argument queen. 👑

🦋 DESCRIPTION 🦋

so here's the vibe: this callback gets to modify the message, okay? it's not just a spectator, it's a main character.

  • return true → the message should keep on being processed, let it cook 🔥
  • return false → prevent any further processing, message is DROPPED, cancelled, we're done here 💀
⚠️ but listen. because this is processing a message directly from the Windows event loop, this callback should do the minimum required work and return quickly. like, in-and-out. no side quests. no long tasks. the event loop is waiting on you and she is NOT patient. 😭

💖 FUNCTION PARAMETERS 💖

  • userdata — the app-defined pointer that you provided to SDL_SetWindowsMessageHook. it's your little luggage tag, your personal pointer, your ~you~ data. 🎀
  • msg — a pointer to a Win32 event structure to process. yes bestie, the actual MSG. handle with care. 🫶

⭐ RETURN VALUE ⭐

returns true to let the event continue on, and false to drop it. that's it. that's the whole decision. binary. slay or slay-not. 🌈

🧚 THREAD SAFETY 🧚

no cap, this may only be called (by SDL) from the thread handling the Windows event loop. one thread. that thread. don't try to be cute about it. 🚫🧵

👑 AVAILABILITY 👑

this datatype has been available since SDL 3.2.0. so if you're on something older... girl. upgrade. ✨

🌸 SEE ALSO 🌸

and that's the whole page, bestie!! written by Simple Directmedia Layer, for SDL 3.4.18, dated with all the love of SDL_WindowsMessageHook(3type) 💜🦋✨ mwah, go hook some messages, and remember: return quickly or the event loop will come for you. 💅

📦 where this page comes from