(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetRelativeMouseState

Retrieve the relative state of the mouse.

Header File

Syntax

SDL_MouseButtonFlags SDL_GetRelativeMouseState(float *x, float *y);

Function Parameters

float *	x	a pointer filled with the last recorded x coordinate of the mouse.
float *	y	a pointer filled with the last recorded y coordinate of the mouse.

Return Value

(SDL_MouseButtonFlags) Returns a 32-bit button bitmask of the relative button state.

Remarks

The current button state is returned as a button bitmask, which can be tested using the SDL_BUTTON_MASK(X) macros (where X is generally 1 for the left, 2 for middle, 3 for the right button), and x and y are set to the mouse deltas since the last call to SDL_GetRelativeMouseState() or since event initialization. You can pass NULL for either x or y.

Version

This function is available since SDL 3.1.3.