al_fixatan2(3alleg5)

✨ NAME ✨

al_fixatan2 — literally the Allegro 5 API bestie, coming through 💖

---

🌸 SYNOPSIS 🌸

#include <allegro5/allegro.h>

al_fixed al_fixatan2(al_fixed y, al_fixed x)

---

🦋 DESCRIPTION 🦋

okay so picture this: it's the fixed point version of libc's atan2() routine. iconic behavior fr fr. 🎀

What it does is compute the arc tangent of y / x, but — and this is the part that's giving main character energy — the signs of both arguments get used to figure out which quadrant the result lands in. and yes, x is allowed to be zero, she's flexible like that 💅

This one is super useful when you wanna convert Cartesian coordinates to polar coordinates. no cap, that's the whole vibe. 🌈

Example time, bestie:

al_fixed result;

/* Sets `result' to binary angle 64. */
result = al_fixatan2(al_itofix(1), 0);

/* Sets `result' to binary angle -109. */
result = al_fixatan2(al_itofix(-1), al_itofix(-2));

/* Fails the assert. */
result = al_fixatan2(0, 0);
assert(!al_get_errno());

---

👑 RETURN VALUE 👑

So it hands you back the arc tangent of y / x in fixed point binary format angle, ranging from -128 to 128. periodt. ✨

but listen — if both x and y are zero, she returns zero and sets Allegro's errno to EDOM. so like, don't be shocked when that happens 🙈

---

that's the whole page, bestie! this little gem lives in the Allegro reference manual, filed under al_fixatan2(3alleg5) — go forth and slay those polar coordinates 🫶💜⭐