(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_WindowsMessageHook

A callback to be used with SDL_SetWindowsMessageHook.

Header File

Defined in <SDL3/SDL_system.h>

Syntax

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

Function Parameters

userdata	the app-defined pointer provided to SDL_SetWindowsMessageHook.
msg	a pointer to a Win32 event structure to process.

Return Value

Returns true to let event continue on, false to drop it.

Remarks

This callback may modify the message, and should return true if the message should continue to be processed, or false to prevent further processing.

As this is processing a message directly from the Windows event loop, this callback should do the minimum required work and return quickly.

Thread Safety

This may only be called (by SDL) from the thread handling the Windows event loop.

Version

This datatype is available since SDL 3.1.3.

See Also

• SDL_SetWindowsMessageHook
• SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP

---

CategoryAPI, CategoryAPIDatatype, CategorySystem

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.