destroy_bitmap(3)

💖 destroy_bitmap(3) 💖

okay bestie, we're in the Allegro manual and today's main character is destroy_bitmap(3) — the Allegro game programming library's official "we're done here, clean up your mess" function. ✨

🌸 NAME 🌸

destroy_bitmap — destroys literally any type of created bitmap. That's it, that's the job. Allegro game programming library energy through and through. 🎀

✨ SYNOPSIS ✨

#include <allegro.h>

void destroy_bitmap(BITMAP *bitmap);

look at her. one line. no return value. she simply does. 💅

🦋 DESCRIPTION 🦋

So here's the tea, bestie: when you're finished with a bitmap, you call this. It destroys a memory bitmap, a sub-bitmap, a video memory bitmap, or a system bitmap — all of them, no discrimination, every type gets the same loving farewell. 💖

If you pass a NULL pointer, this function won't do anything. Like, at all. It just vibes. No crash, no drama, nothing. 🫶

Now — the important part, and I need you to actually listen — see above for the restrictions as to when you are allowed to destroy the various types of bitmaps. Different bitmap types have different rules about when it's legal to send them off, and this function is not the one making those rules. So check before you yeet. 😭

🚨 also: the bitmap must not have a mouse cursor shown on it at the time it is destroyed. Like, at all. If there's a cursor on it, that's a problem. Handle that first, bestie, I'm begging. 💀

🌈 SEE ALSO 🌈

• create_bitmap(3) — the one that made it 🍼
• load_bitmap(3) — the one that brought it in from a file 📂
• show_mouse(3) — the one that put a cursor on it, which you need to deal with before you destroy it, per the vibe check above 🙈

and that's the whole page, periodt. 🌟

Allegro, version 4.4.3 — yeah she's a classic, iconic, no notes. And the page footer says destroy_bitmap(3) on the right, so like, it's the manual page for destroy_bitmap(3), obviously, iykyk. 🧚💜 Mwah, go free your memory, bestie. 🔥👑