IMG_isPNG(3)

📦
version 3.4.4 · 8 versions
, in ubuntu stonking

💅 NAME 💅

hey bestie 💖 welcome to IMG_isPNG(3), a page from the SDL_image3 FUNCTIONS manual ✨

IMG_isPNG — detect PNG image data on a readable/seekable SDL_IOStream. no cap, that’s the whole assignment 🎀

✨ SYNOPSIS ✨

#include <SDL3_image/SDL_image.h>

bool IMG_isPNG(SDL_IOStream *src);

🦋 DESCRIPTION 🦋

okay so this function attempts to determine if a file is a given filetype, reading the least amount possible from the SDL_IOStream — usually just a few bytes 🫶. it’s giving “quick peek, not a whole read-through” and honestly? iconic.

important bestie: there is no distinction made between “not the filetype in question” and basic i/o errors 😭. so if it comes back false, it’s not telling you whether it’s “nope, not PNG” or “oops, i/o said no.” it simply said false and moved on 💀.

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 🫶✨. very polite of it, fr fr.

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 a 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 PNG data, false otherwise. periodt 💖

⭐ AVAILABILITY ⭐

This function is available since SDL_image 3.0.0. yes bestie, she’s been around 👑.

🔥 SEE ALSO 🔥

go give these other cuties a read too:

mwah 💋 cute sign-off time: source SDL_image, version SDL_image 3.4.4, dated IMG_isPNG(3) — love her, no notes 🌈🦋

📦 where this page comes from