.\" Automatically generated by Pandoc 3.1.12.1
.\"
.TH "al_get_mouse_state" "3" "" "Allegro reference manual" ""
.SH NAME
al_get_mouse_state \- Allegro 5 API
.SH SYNOPSIS
.IP
.EX
#include \f[B]<allegro5/allegro.h>\f[R]

void al_get_mouse_state(ALLEGRO_MOUSE_STATE *ret_state)
.EE
.SH DESCRIPTION
Save the state of the mouse specified at the time the function is called
into the given structure.
.PP
Example:
.IP
.EX
ALLEGRO_MOUSE_STATE state;

al_get_mouse_state(&state);
\f[B]if\f[R] (state.buttons & 1) {
    \f[I]/* Primary (e.g. left) mouse button is held. */\f[R]
    printf(\[dq]Mouse position: (%d, %d)\[rs]n\[dq], state.x, state.y);
}
\f[B]if\f[R] (state.buttons & 2) {
    \f[I]/* Secondary (e.g. right) mouse button is held. */\f[R]
}
\f[B]if\f[R] (state.buttons & 4) {
    \f[I]/* Tertiary (e.g. middle) mouse button is held. */\f[R]
}
.EE
.SH SEE ALSO
ALLEGRO_MOUSE_STATE(3), al_get_mouse_state_axis(3),
al_mouse_button_down(3)