al_set_system_mouse_cursor(3)

al_set_system_mouse_cursor3

Allegro 5 api

Usage

#include <allegro5/allegro.h>
bool al_set_system_mouse_cursor(ALLEGRO_DISPLAY *display,
   ALLEGRO_SYSTEM_MOUSE_CURSOR cursor_id)

Overview

Set the given system mouse cursor to be the current mouse cursor for the given display. If the cursor is currently `shown' (as opposed to `hidden') the change is immediately visible.

If the cursor doesn’t exist on the current platform another cursor will be silently be substituted.

The cursors are:

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_DEFAULT

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_ARROW

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_BUSY

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_QUESTION

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_EDIT

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_MOVE

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_N

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_W

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_S

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_E

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NW

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_SW

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_SE

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NE

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_PROGRESS

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_PRECISION

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_LINK

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_ALT_SELECT

•

ALLEGRO_SYSTEM_MOUSE_CURSOR_UNAVAILABLE

Returns true on success, false on failure.

From allegro 5.2.11.3-2 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.