SDL_GetMouseState3
Query sdl's cache for the synchronous mouse button state and the window-relative sdl-cursor position.
Usage
#include "SDL3/SDL.h"
SDL_MouseButtonFlags SDL_GetMouseState(float *x, float *y);
Header file
Defined in SDL3/SDL_mouse.h
Overview
This function returns the cached synchronous state as SDL understands it from the last pump of the event queue.
To query the platform for immediate asynchronous state, use
SDL_GetGlobalMouseState .
Passing non-NULL pointers to x or y will write the destination with respective x or y coordinates relative to the focused window.
In Relative Mode, the SDL-cursor's position usually contradicts the platform-cursor's position as manually calculated from
SDL_GetGlobalMouseState () and
SDL_GetWindowPosition .
Function parameters
- x
-
a pointer to receive the SDL-cursor's x-position from the focused window's top left corner, can be NULL if unused.
- y
-
a pointer to receive the SDL-cursor's y-position from the focused window's top left corner, can be NULL if unused.
Return value
( SDL_MouseButtonFlags ) Returns a 32-bit bitmask of the button state that can be bitwise-compared against the
SDL_BUTTON_MASK (X) macro.
Thread safety
This function should only be called on the main thread.
Releases
12 releases since Debian 3.0 (Woody); the text changed 2 times.