SDL_SetWindowMouseRect - Man Page
Confines the cursor to the specified area of a window.
Header File
Defined in SDL3/SDL_video.h
Synopsis
#include "SDL3/SDL.h" bool SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect);
Description
Note that this does NOT grab the cursor, it only defines the area a cursor is restricted to when the window has mouse focus.
Function Parameters
- window
the window that will be associated with the barrier.
- rect
a rectangle area in window-relative coordinates. If NULL the barrier for the specified window will be destroyed.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Thread Safety
This function should only be called on the main thread.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_GetWindowMouseRect(3), ·(3), SDL_GetWindowMouseGrab(3), ·(3), SDL_SetWindowMouseGrab(3)
Referenced By
SDL_GetWindowMouseGrab(3), SDL_GetWindowMouseRect(3), SDL_SetWindowMouseGrab(3).
SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS