SDL_SetWindowMouseGrab(3)

SDL_SetWindowMouseGrab3

Set a window's mouse grab mode.

Usage

#include "SDL3/SDL.h"

bool SDL_SetWindowMouseGrab(SDL_Window *window, bool grabbed);

Header file

Defined in SDL3/SDL_video.h

Overview

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.

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.