Function SDL_GetMouseState

pub unsafe extern "C" fn SDL_GetMouseState(
    x: *mut f32,
    y: *mut f32,
) -> u32 

Available on crate feature dep_sdl3 only.

Query SDL’s cache for the synchronous mouse button state and the window-relative SDL-cursor position.

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.

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

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.

Availability

This function is available since SDL 3.2.0.

See also

• SDL_GetGlobalMouseState
• SDL_GetRelativeMouseState