al_grab_mouse(3)

💖 NAME 💖

okay bestie, this is al_grab_mouse(3) from the Library Functions Manual — it's giving Allegro 5 API energy, highkey iconic ✨

al_grab_mouse — Allegro 5 API

✨ SYNOPSIS ✨

#include <allegro5/allegro.h>

bool al_grab_mouse(ALLEGRO_DISPLAY *display)

🎀 DESCRIPTION 🎀

So like, al_grab_mouse confines the mouse cursor to the given display. The mouse cursor can only be confined to one display at a time — one display, one cursor, no sharing, periodt 💅

Returns true if successful, otherwise returns false 🫶

bestie, do not assume that the cursor will remain confined until you call al_ungrab_mouse(3). It may lose the confined status at any time for other reasons 😭 that's a real vibe check warning, fr fr

Note: not yet implemented on Mac OS X. No cap, that's the actual note 🙈

🦋 SEE ALSO 🦋

• al_ungrab_mouse(3) — the un-grab bestie, obviously 💖

---

mwah 💋 this came from the Allegro reference manual — that's the source/version energy at the bottom, and the footer didn't give a date, so I'm not inventing one, periodt ✨