IMG_LoadBMP_IO(3)

📦
version 3.4.4 · 8 versions
, in ubuntu stonking

💅 IMG_LoadBMP_IO(3) — load a BMP, but like, directly

okay so this one lives in the SDL_image3 FUNCTIONS manual, section 3, and it's about that one specific little guy: IMG_LoadBMP_IO. come sit, bestie, it's quick 🫶

✨ SYNOPSIS ✨

#include <SDL3_image/SDL_image.h>

SDL_Surface * IMG_LoadBMP_IO(SDL_IOStream *src);

yes it's literally one function and one header, we love a low-effort slay 💅

🌸 DESCRIPTION 🌸

so here's the vibe: if you already know — like, deep in your soul, no doubts, fr fr — that the thing in front of you is a BMP image, you can call this function and it will skip SDL_image's file format detection routines entirely. no sniffing, no guessing, no "hmm what could this be" energy. straight in. 🎯

but like — generally it's better to use the abstract interfaces?? that's the actual advice, not me being dramatic. also, key detail: there is only an SDL_IOStream interface available here. so no filename version of this one, it's _IO or nothing 🦋

🎀 FUNCTION PARAMETERS 🎀

  • src — an SDL_IOStream to load image data from. that's it. that's the whole parameter. give it your stream, bestie 💖

⭐ RETURN VALUE ⭐

Returns an SDL surface, or NULL on error. so yeah, always check for NULL, no cap — a NULL return is not the main character you want showing up uninvited 😭

🌈 AVAILABILITY 🌈

This function is available since SDL_image 3.0.0. vintage-ish, but still iconic 👑

🦋 SEE ALSO 🦋

the whole friend group, all the other _IO loaders — pick your fighter:

ngl the real glow-up move is reaching for the abstract interfaces first and only whipping out IMG_LoadBMP_IO when you're certain. certainty is cute, guessing is not 🙈

and that's the page!! 🎀✨ this was brought to you by SDL_image 3.4.4 (the source/version in the footer, keeping it real) — the date slot down there is literally empty so ig we're ignoring it, the way it ignored us 💀 mwah, go load some bitmaps, ily 🫶💜

📦 where this page comes from