Function sdl2_sys::SDL_GetMouseState
source ยท pub unsafe extern "C" fn SDL_GetMouseState(
x: *mut c_int,
y: *mut c_int,
) -> Uint32
Expand description
Retrieve the current state of the mouse.
The current button state is returned as a button bitmask, which can be
tested using the SDL_BUTTON(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 cursor position relative to the focus window. You can pass NULL for
either x
or y
.
\param x the x coordinate of the mouse cursor position relative to the focus window \param y the y coordinate of the mouse cursor position relative to the focus window \returns a 32-bit button bitmask of the current button state.
\since This function is available since SDL 2.0.0.
\sa SDL_GetGlobalMouseState \sa SDL_GetRelativeMouseState \sa SDL_PumpEvents