IMG_isQOI(3)

📦
version 3.4.4 · 8 versions
, in ubuntu stonking

okay so bestie, you're looking at IMG_isQOI(3) from the SDL_image3 FUNCTIONS universe — manual name folded in right here, cute and accounted for. 💖

✨ NAME ✨

IMG_isQOI — detect QOI image data on a readable/seekable SDL_IOStream. That's the whole assignment. 🎀

🌸 SYNOPSIS 🌸

#include <SDL3_image/SDL_image.h>

bool IMG_isQOI(SDL_IOStream *src);

🦋 DESCRIPTION 🦋

So IMG_isQOI literally attempts to determine if a file is a given filetype, and it does that by reading the least amount possible from the SDL_IOStream — usually just a few bytes. lowkey polite of it. ✨

There is no distinction made between "not the filetype in question" and basic i/o errors. Same false vibe, no extra explanation. 😭

This function will always attempt to seek src back to where it started when this function was called. 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 era needed, periodt. 💅

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 required step. 🫶

🎀 FUNCTION PARAMETERS 🎀

  • src — a seekable/readable SDL_IOStream to provide image data. That's the whole parameter, bestie. 👑

💅 RETURN VALUE 💅

Returns true if this is QOI data, false otherwise. That's it — iconic binary clarity. ⭐

🌈 AVAILABILITY 🌈

This function is available since SDL_image 3.0.0. So if you're on that version or later, slay. 💜

👑 SEE ALSO 👑

go check out these other IMG_isTYPE besties:

okay bye bestie, this page is stamped from SDL_image 3.4.4 — that's the source/version footer situation, and there's no date line printed on this one, so no invented date, periodt. mwah 💖✨💅

📦 where this page comes from