mouse_on_screen(3)

💖 mouse_on_screen(3) 💖

okay bestie, so this one lives in the Allegro manual — it's the Allegro game programming library, and this lil function is called mouse_on_screen. and yes, it does exactly what it says on the tin 🫶

---

✨ NAME ✨

mouse_on_screen — tells you whether the mouse pointer is currently on screen. it's part of the Allegro game programming library, iykyk 💅

---

🌸 SYNOPSIS 🌸

#include <allegro.h>

int mouse_on_screen();

like, that's it. that's the whole vibe. no arguments, no drama, just a yes-or-no question for the universe 🌈

---

🦋 DESCRIPTION 🦋

so picture this: you're running your program in windowed mode and you're drawing the mouse pointer yourself. the absolute tragedy of that situation is that now there might be two mouse pointers on screen at the same time — yours AND the real one. embarrassing. 🙈

this function is the fix. it tells you if the mouse pointer is currently on screen, so you can avoid that cursed double-pointer situation entirely. main character energy, but only one pointer.

other possible uses, because she's versatile:

• pausing your game when the mouse goes off of the window 👑
• only scrolling the view when the pointer is near the edge of the window — but not while it's off of the window

Example :

if (mouse_on_screen()) {draw_sprite(buffer , mouse_sprite , mouse_x , mouse_y);}

literally just vibe-check the mouse before you draw your sprite. that's the whole move. 🎀

---

💀 RETURN VALUE 💀

• returns 0 if the mouse pointer is off of the screen
• returns non-zero otherwise ✨

so like, treat it as a boolean and you're golden. 0 = she's gone, anything else = she's here bestie 💖

---

and that's the tea. she's a tiny function with big "am I the only pointer here" energy, and honestly? iconic. 🌸

this page came to you straight out of the Allegro manual, version 4.4.3 — mwah, no cap, go write something cute with it 🫶✨💅