====== (This is the documentation for SDL3, which is under heavy development and the API is changing! [https://wiki.libsdl.org/SDL2/ SDL2] is the current stable version!) ======
= SDL_GetMouseState =

Retrieve the current state of the mouse.

== Syntax ==

<syntaxhighlight lang='c'>
Uint32 SDL_GetMouseState(float *x, float *y);
</syntaxhighlight>

== Function Parameters ==

{|
|'''x'''
|the x coordinate of the mouse cursor position relative to the focus window
|-
|'''y'''
|the y coordinate of the mouse cursor position relative to the focus window
|}

== Return Value ==

Returns a 32-bit button bitmask of the current button state.

== Remarks ==

The current button state is returned as a button bitmask, which can be
tested using the <code>[[SDL_BUTTON]](X)</code> macros (where
<code>X</code> is generally 1 for the left, 2 for middle, 3 for the right
button), and <code>x</code> and <code>y</code> are set to the mouse cursor
position relative to the focus window. You can pass NULL for either
<code>x</code> or <code>y</code>.

== Version ==

This function is available since SDL 3.0.0.

== Code Examples ==

<syntaxhighlight lang='c++'>
int x, y;
Uint32 buttons;

SDL_PumpEvents();  // make sure we have the latest mouse state.

buttons = SDL_GetMouseState(&x, &y);

SDL_Log("Mouse cursor is at %d, %d", x, y);
if ((buttons & SDL_BUTTON_LMASK) != 0) {
    SDL_Log("Mouse Button 1 (left) is pressed.");
}
</syntaxhighlight>

== Related Functions ==

:[[SDL_GetGlobalMouseState]]
:[[SDL_GetRelativeMouseState]]
:[[SDL_PumpEvents]]

----
[[CategoryAPI]], [[CategoryMouse]]