al_get_parent_bitmap(3)

💖 al_get_parent_bitmap(3) — Library Functions Manual 💖

Okay bestie, this page is al_get_parent_bitmap(3) from the Library Functions Manual, and it’s giving “find the real parent bitmap” energy. Let’s go 💅✨

---

🌸 NAME 🌸

al_get_parent_bitmap — Allegro 5 API

---

🎀 SYNOPSIS 🎀

#include <allegro5/allegro.h>

ALLEGRO_BITMAP *al_get_parent_bitmap(ALLEGRO_BITMAP *bitmap)

---

🦋 DESCRIPTION 🦋

This function returns the bitmap that this bitmap is a sub-bitmap of. If this bitmap is not a sub-bitmap, it returns NULL.

It always returns the real bitmap, and never a sub-bitmap. And yes, this might NOT match what was passed to al_create_sub_bitmap(3). Consider this code, for instance:

ALLEGRO_BITMAP* a = al_create_bitmap(512, 512);
ALLEGRO_BITMAP* b = al_create_sub_bitmap(a, 128, 128, 256, 256);
ALLEGRO_BITMAP* c = al_create_sub_bitmap(b, 64, 64, 128, 128);
ASSERT(al_get_parent_bitmap(b) == a && al_get_parent_bitmap(c) == a);

The assertion will pass because only a is a real bitmap, and both b and c are its sub-bitmaps. Periodt 💀✨

Lowkey important: the returned parent might not be the direct thing you passed to al_create_sub_bitmap(3) — it’s the real bitmap at the root of the sub-bitmap situation 👑

---

⭐ SINCE ⭐

5.0.6, 5.1.2

---

🌈 SEE ALSO 🌈

• al_create_sub_bitmap(3)
• al_is_sub_bitmap(3)

---

Catch ya later, bestie — this was al_get_parent_bitmap(3) from the Allegro reference manual and the Allegro 5 API; the footer didn’t give me a date, so I’m not inventing one 🫶💅✨