.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetMouseState:
.\"   https://wiki.libsdl.org/SDL_GetMouseState
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetMouseState
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetMouseState 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetMouseState \- Retrieve the current state of the mouse\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "Uint32 SDL_GetMouseState(float *x, float *y);
.fi
.SH DESCRIPTION
The current button state is returned as a button bitmask, which can be
tested using the
.BR SDL_BUTTON(X)
macros (where
.BR X
is generally 1 for the
left, 2 for middle, 3 for the right button), and
.BR x
and
.BR y
are set to the
mouse cursor position relative to the focus window\[char46] You can pass NULL for
either
.BR x
or
.BR y
\[char46]

.SH FUNCTION PARAMETERS
.TP
.I x
the x coordinate of the mouse cursor position relative to the focus window
.TP
.I y
the y coordinate of the mouse cursor position relative to the focus window
.SH RETURN VALUE
Returns a 32-bit button bitmask of the current button state\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_GetGlobalMouseState (3),
.BR SDL_GetRelativeMouseState (3)