Skip to content

Commit 718ddb4

Browse files
committed
Added documentation comment for SDL_SetWindowMousePassthrough
1 parent 7a0b8c1 commit 718ddb4

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

include/SDL3/SDL_video.h

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2703,7 +2703,16 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowOpacity(SDL_Window *window, float
27032703
*/
27042704
extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window);
27052705

2706-
2706+
/**
2707+
* Enable or disable mouse passthrough for a window.
2708+
*
2709+
* \param window the window to set mouse passthrough for.
2710+
* \param passthrough true to make the window transparent to mouse input, false to capture mouse input.
2711+
*
2712+
* \threadsafety This function should only be called on the main thread.
2713+
*
2714+
* \since This function is available since SDL 3.4.0.
2715+
*/
27072716
extern SDL_DECLSPEC void SDLCALL SDL_SetWindowMousePassthrough(SDL_Window *window, bool passthrough);
27082717

27092718
/**

src/video/windows/SDL_windowswindow.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ extern void WIN_SetWindowSize(SDL_VideoDevice *_this, SDL_Window *window);
115115
extern bool WIN_GetWindowBordersSize(SDL_VideoDevice *_this, SDL_Window *window, int *top, int *left, int *bottom, int *right);
116116
extern void WIN_GetWindowSizeInPixels(SDL_VideoDevice *_this, SDL_Window *window, int *width, int *height);
117117
extern bool WIN_SetWindowOpacity(SDL_VideoDevice *_this, SDL_Window *window, float opacity);
118-
extern void WIN_SetWindowMousePassthrough(SDL_VideoDevice *_this, SDL_Window *window, bool passthrough)
118+
extern void WIN_SetWindowMousePassthrough(SDL_VideoDevice *_this, SDL_Window *window, bool passthrough);
119119
extern void WIN_ShowWindow(SDL_VideoDevice *_this, SDL_Window *window);
120120
extern void WIN_HideWindow(SDL_VideoDevice *_this, SDL_Window *window);
121121
extern void WIN_RaiseWindow(SDL_VideoDevice *_this, SDL_Window *window);

0 commit comments

Comments
 (0)