al_get_mouse_state(3alleg5)

al_get_mouse_state3alleg5

Allegro 5 api

Usage

#include <allegro5/allegro.h>
void al_get_mouse_state(ALLEGRO_MOUSE_STATE *ret_state)

Overview

Save the state of the mouse specified at the time the function is called into the given structure.

Example:

ALLEGRO_MOUSE_STATE state;
al_get_mouse_state(&state);
if (state.buttons & 1) {
    /* Primary (e.g. left) mouse button is held. */
    printf("Mouse position: (%d, %d)\n", state.x, state.y);
}
if (state.buttons & 2) {
    /* Secondary (e.g. right) mouse button is held. */
}
if (state.buttons & 4) {
    /* Tertiary (e.g. middle) mouse button is held. */
}

Releases

6 releases since Debian 8 (Jessie); the text changed 5 times.

  1. 8
  2. 9
  3. 10
  4. 11
  5. 12
  6. 13

From allegro5-doc 2:5.2.10.1+dfsg-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.