ALLEGRO_GET_EVENT_TYPE(3)

💖 NAME 💖

okay so bestie, welcome to ALLEGRO_GET_EVENT_TYPE(3) — yes, that’s the page title, and it’s from the Library Functions Manual. The whole vibe? Allegro 5 API. That’s the name section, she’s concise, we respect it. 🎀

✨ SYNOPSIS ✨

Here’s the literal setup, no cap:

              #include <allegro5/allegro.h>

              #define ALLEGRO_GET_EVENT_TYPE(a, b, c, d)   AL_ID(a, b, c, d)

🦋 DESCRIPTION 🦋

So this macro makes an event type identifier, which is a 32-bit integer. Usually — but not necessarily, she’s flexible — it’s made from four 8-bit character codes, like this:

              #define MY_EVENT_TYPE   ALLEGRO_GET_EVENT_TYPE('M','I','N','E')

🚨 reserved-zone alert: IDs less than 1024 are reserved for Allegro or its addons. Do not use anything lower than ALLEGRO_GET_EVENT_TYPE(0, 0, 4, 0).

You should try to make your IDs unique so they don’t clash with any 3rd party code you may be using. Be creative. Numbering from 1024 is not creative — literally the opposite of a main-character move. 💅

If you need multiple identifiers, you could define them like this:

              #define BASE_EVENT   ALLEGRO_GET_EVENT_TYPE('M','I','N','E')
              #define BARK_EVENT   (BASE_EVENT + 0)
              #define MEOW_EVENT   (BASE_EVENT + 1)
              #define SQUAWK_EVENT (BASE_EVENT + 2)

              /* Alternatively */
              enum {
                 BARK_EVENT = ALLEGRO_GET_EVENT_TYPE('M','I','N','E'),
                 MEOW_EVENT,
                 SQUAWK_EVENT
              };

🌈 SEE ALSO 🌈

Go touch these pages too, iykyk:

• ALLEGRO_EVENT(3) — event lore, go read it bestie.
• ALLEGRO_USER_EVENT(3) — user events, very demure.
• ALLEGRO_EVENT_TYPE_IS_USER(3) — the check, iconic.

---

Source/version: Allegro reference manual. Date: not listed on this page — mysterious queen behavior, honestly. Stay slay, bestie. 💜