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

bool al_mouse_button_down(const ALLEGRO_MOUSE_STATE *state, int button)
.EE
.SH DESCRIPTION
Return true if the mouse button specified was held down in the state
specified.
.PP
Unlike most things, the first mouse button is numbered 1.
As a convenience, the constants ALLEGRO_MOUSE_BUTTON_LEFT,
ALLEGRO_MOUSE_BUTTON_RIGHT, ALLEGRO_MOUSE_BUTTON_MIDDLE are provided.
However, depending on the hardware there may be more or fewer mouse
buttons.
You can check al_get_mouse_num_buttons(3) if you want to be sure.
.SH SEE ALSO
ALLEGRO_MOUSE_STATE(3), al_get_mouse_state(3),
al_get_mouse_state_axis(3)