al_get_mouse_cursor_position(3alleg5)

✨ al_get_mouse_cursor_position ✨

ok so bestie, this one lives in the Allegro reference manual, section 3alleg5 — yeah that's the whole vibe, Allegro 5 API, let's go 💅

---

🦋 NAME 🦋

al_get_mouse_cursor_position — Allegro 5 API, and it's giving "where is that cursor rn" 👀

---

🌸 SYNOPSIS 🌸

#include <allegro5/allegro.h>

bool al_get_mouse_cursor_position(int *ret_x, int *ret_y)

---

💖 DESCRIPTION 💖

okay so on platforms where this information is available, this function returns the global location of the mouse cursor, relative to the desktop ✨ like not relative to your window, not relative to some little widget — global, desktop-level, the whole screen, periodt.

but here's the tea 🫖 — you should not normally use this function. it's lowkey not useful except for special scenarios, like moving a window. that's the niche, that's the moment, that's literally it 😭

so like… it exists, it works, but it's the "only if you know why you need it" girlie. don't just reach for it because it's there 💀

it returns true on success, and false on failure. no cap, that's the whole contract 🎀

---

👑 SEE ALSO 👑

• al_can_get_mouse_cursor_position(3alleg5) — the bestie that tells you whether this whole thing is even available on your platform 🫶

---

🌈 sign-off 🌈

and that's the page!! this came straight from the Allegro reference manual, filed under al_get_mouse_cursor_position(3alleg5) 💜 go check al_can_get_mouse_cursor_position before you assume anything, mwah, bye bestie 🧚✨🎀