IMG_isBMP(3)

okay so bestie, welcome to IMG_isBMP(3) from the SDL_image3 FUNCTIONS crew — it's the tiny vibe check that tells you if some data is giving BMP energy. 🦋

💅 NAME 💅

IMG_isBMP — detect BMP image data on a readable/seekable SDL_IOStream. periodt. ✨

✨ SYNOPSIS ✨

#include <SDL3_image/SDL_image.h>

bool IMG_isBMP(SDL_IOStream *src);

🌸 DESCRIPTION 🌸

okay so this function literally attempts to determine if a file is a given filetype, and it reads the least amount possible from the SDL_IOStream (usually just a few bytes). lowkey efficient, highkey iconic. 💅

bestie, there is no distinction made between "not the filetype in question" and basic i/o errors — it's giving mystery, and not in a fun way. 😭

this function will always attempt to seek src back to where it started when this function was called, but it will not report any errors in doing so. but assuming seeking works, this means you can immediately use this with a different IMG_isTYPE function, or load the image without further seeking. no extra seek drama, we love to see it. 🫶

you do not need to call this function to load data; SDL_image can work to determine file type in many cases in its standard load functions. so this is more like a lil pre-game vibe check, not a mandatory step. 🎀

🫶 FUNCTION PARAMETERS 🫶

• src — a seekable/readable SDL_IOStream to provide image data. 🫶

💖 RETURN VALUE 💖

Returns true if this is BMP data, false otherwise. that's it, that's the tea. 🍓

👑 AVAILABILITY 👑

This function is available since SDL_image 3.0.0. slay. ✨

🌈 SEE ALSO 🌈

• IMG_isANI(3)
• IMG_isAVIF(3)
• IMG_isCUR(3)
• IMG_isGIF(3)
• IMG_isICO(3)
• IMG_isJPG(3)
• IMG_isJXL(3)
• IMG_isLBM(3)
• IMG_isPCX(3)
• IMG_isPNG(3)
• IMG_isPNM(3)
• IMG_isQOI(3)
• IMG_isSVG(3)
• IMG_isTIF(3)
• IMG_isWEBP(3)
• IMG_isXCF(3)
• IMG_isXPM(3)
• IMG_isXV(3)

iykyk, go check the whole isTYPE family 👑

---

byeee bestie 💖 — footer check: SDL_image, version SDL_image 3.4.4, page tag IMG_isBMP(3) (no date listed on this one, so no invented date, periodt). 🎀