SDL_GetWindowRelativeMouseMode(3)

SDL_GetWindowRelativeMouseMode3

Query whether relative mouse mode is enabled for a window.

Usage

#include "SDL3/SDL.h"

bool SDL_GetWindowRelativeMouseMode(SDL_Window *window);

Header file

Defined in SDL3/SDL_mouse.h

Function parameters

window

the window to query.

Return value

Returns true if relative mode is enabled for a window or false otherwise.

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.