logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_SetWindowMouseRect - Confines the cursor to the specified area of a window.

Availability

       This function is available since SDL 3.2.0.

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.

Header File

       Defined in SDL3/SDL_video.h

Name

       SDL_SetWindowMouseRect - Confines the cursor to the specified area of a window.

Return Value

       Returns true on success or false on failure; call

       SDL_GetError () for more information.

See Also

(3), SDL_GetWindowMouseRect(3), (3), SDL_GetWindowMouseGrab(3), (3), SDL_SetWindowMouseGrab(3)

Simple Directmedia Layer                           SDL 3.2.10                          SDL_SetWindowMouseRect(3)

Synopsis

#include"SDL3/SDL.h"boolSDL_SetWindowMouseRect(SDL_Window*window,constSDL_Rect*rect);

Thread Safety

       This function should only be called on the main thread.

See Also