eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-01 17:37:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

SDL_system.h: Improve window message hook documentation.

Browse source
This commit is contained in:
Ryan C. Gordon 2024-05-03 15:37:11 -04:00
parent a04abd78d3
commit cf0b5db9e1
No known key found for this signature in database
GPG key ID: FA148B892AB48044
1 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
include/SDL3/SDL_system.h
View file

@ -47,6 +47,28 @@ extern "C" {
#if defined(SDL_PLATFORM_WIN32) || defined(SDL_PLATFORM_GDK)
typedef struct tagMSG MSG;
/**
* A callback to be used with SDL_SetWindowsMessageHook.
*
* This callback may modify the message, and should return SDL_TRUE
* if the message should continue to be processed, or SDL_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.
*
* \param userdata the app-defined pointer provided to SDL_SetWindowsMessageHook.
* \param msg a pointer to a Win32 event structure to process.
* \returns SDL_TRUE to let event continue on, SDL_FALSE to drop it.
*
* \threadsafety This may only be called (by SDL) from the thread handling the Windows event loop.
*
* \since This datatype is available since SDL 3.0.0.
*
* \sa SDL_SetWindowsMessageHook
* \sa SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP
*/
typedef SDL_bool (SDLCALL *SDL_WindowsMessageHook)(void *userdata, MSG *msg);
/**
@ -60,6 +82,9 @@ typedef SDL_bool (SDLCALL *SDL_WindowsMessageHook)(void *userdata, MSG *msg);
* \param userdata a pointer to pass to every iteration of `callback`
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_WindowsMessageHook
* \sa SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP
*/
extern DECLSPEC void SDLCALL SDL_SetWindowsMessageHook(SDL_WindowsMessageHook callback, void *userdata);