(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_GetRelativeMouseMode

Query whether relative mouse mode is enabled.

Header File

Defined in SDL_mouse.h

Syntax

SDL_bool SDL_GetRelativeMouseMode(void);

Return Value

Returns SDL_TRUE if relative mode is enabled or SDL_FALSE otherwise.

Version

This function is available since SDL 2.0.0.

See Also

• SDL_SetRelativeMouseMode

CategoryAPI, CategoryAPIFunction, CategoryMouse