table of contents
other versions
- testing 3.2.10+ds-1
- unstable 3.2.10+ds-1
- experimental 3.3~git20250806+ds-1
SDL_SetWindowMouseRect(3) | SDL3 FUNCTIONS | SDL_SetWindowMouseRect(3) |
NAME¶
SDL_SetWindowMouseRect - Confines the cursor to the specified area of a window.
SYNOPSIS¶
#include <SDL3/SDL_video.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¶
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¶
SDL_GetWindowMouseRect(3), SDL_GetWindowMouseGrab(3), SDL_SetWindowMouseGrab(3)
SDL 3.3.0 | Simple Directmedia Layer |