Blast-Radius Aware AI Code Review for Business-Critical Systems
LiveReview LiveReview Explore LiveReview

SDL_SetWindowMouseGrab - Set a window's mouse grab mode.

Availability

       This function is available since SDL 3.2.0.

Description

       Mouse grab confines the mouse cursor to the window.

Function Parameters

window the window for which the mouse grab mode should be set.

       grabbed
              this is true to grab mouse, and false to release.

Header File

       Defined in SDL3/SDL_video.h

Name

       SDL_SetWindowMouseGrab - Set a window's mouse grab mode.

Return Value

       Returns true on success or false on failure; call

       SDL_GetError () for more information.

See Also

(3),  SDL_GetWindowMouseRect(3), (3), SDL_SetWindowMouseRect(3), (3), SDL_SetWindowMouseGrab(3), (3),
       SDL_SetWindowKeyboardGrab(3)

Simple Directmedia Layer                           SDL 3.2.10                          SDL_SetWindowMouseGrab(3)

Synopsis

#include"SDL3/SDL.h"boolSDL_SetWindowMouseGrab(SDL_Window*window,boolgrabbed);

Thread Safety

       This function should only be called on the main thread.

See Also