---
name: "al_set_system_mouse_cursor"
section: "3alleg5"
platform: "linux"
package: "allegro5-doc"
version: "2:5.2.10.1+dfsg-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/al_set_system_mouse_cursor/3alleg5"
---

# al\_set\_system\_mouse\_cursor(3alleg5)

Allegro 5 API

## NAME

al\_set\_system\_mouse\_cursor - Allegro 5 API

## SYNOPSIS

-

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

## DESCRIPTION

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.

## SEE ALSO

al\_set\_mouse\_cursor(3alleg5), al\_show\_mouse\_cursor(3alleg5), al\_hide\_mouse\_cursor(3alleg5)