install_mouse(3alleg4)

📦 version 4.4.3.1, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ install_mouse(3alleg4) ✨

okay bestie, welcome to the 3alleg4 manual 💖 this one's short but it's important, so pay attention, i'm literally begging 🫶

NAME

install_mouse — installs the Allegro mouse handler 🐭✨

SYNOPSIS

#include <allegro.h>

int install_mouse();

DESCRIPTION

So, what does it do? It installs the Allegro mouse handler. That's it. That's the whole vibe. 💅

But like — you have to do this before you use literally any other mouse function. No install, no mouse. It's giving "you can't sit with us until you've been introduced." Periodt. 🔥

RETURN VALUE

This function is a whole overachiever and returns three different kinds of things, depending on the situation. Let me break it down for you bestie:

  • -1 — failure 😭 it did not slay.
  • 0 — the mouse handler was already installed, so this function did absolutely nothing. No notes, it just sat there.
  • the number of buttons on the mouse — this is the good ending 🌈 it means the mouse handler was successfully installed. That happens when it's the first time a handler is installed, or you removed the previous one.
⚠️ okay so here's the tea — that "number of buttons" it gives you is more of an indication than a physical reality. With most devices there's literally no way of telling how many buttons there actually are. 👀

And it gets messier: any user can override the number of mouse buttons returned by this function with a custom configuration file and the variable num_buttons. Even if this value gets overridden by the user, the global mouse variables will still report whatever the hardware is sending. So like, the vibes are vibes, but the hardware is the truth. 🧚

SEE ALSO

Allegro · version 4.4.3 · install_mouse(3alleg4)

and that's the whole page bestie, ily, go install that mouse handler and be the main character of your own graphics library 🐭👑💖✨

📦 where this page comes from