IMG_LoadAnimationTyped_IO(3)

📦
version 3.4.4 · 8 versions
, in ubuntu stonking

🌸 NAME 🌸

okay bestie, welcome to IMG_LoadAnimationTyped_IO(3) from the SDL_image3 FUNCTIONS crew ✨ This page is literally about how to Load an animation from an SDL_IOStream — that's the whole NAME vibe 💅

🎀 SYNOPSIS 🎀

#include <SDL3_image/SDL_image.h>

IMG_Animation * IMG_LoadAnimationTyped_IO(SDL_IOStream *src, bool closeio, const char *type);

🦋 DESCRIPTION 🦋

So here's the tea, bestie: even though this function accepts a file type, SDL_image may still try other decoders that are capable of detecting file type from the contents of the image data. But for formats it cannot autodetect, it may rely on the caller-provided type string. If type is NULL, SDL_image will rely solely on its ability to guess the format. No cap, that's the format-detection situation 🙈

If closeio is true, src will be closed before returning, whether this function succeeds or not. Important caveat, bestie: SDL_image reads everything it needs from src during this call in any case. So it's done with the stream by the time it returns 👑

When done with the returned animation, the app should dispose of it with a call to IMG_FreeAnimation(). Do not ghost that cleanup, fr fr 🫶

💖 FUNCTION PARAMETERS 💖

  • src — an SDL_IOStream that data will be read from.
  • closeio — true to close/free the SDL_IOStream before returning, false to leave it open.
  • type — a filename extension that represent this data ("GIF", etc).

🌈 RETURN VALUE 🌈

Returns a new IMG_Animation, or NULL on error. So if you get NULL, that's a no-animation moment, not a slay 😭

⭐ AVAILABILITY ⭐

This function is available since SDL_image 3.0.0. Periodt 💜

👑 SEE ALSO 👑

Final footer vibe check, bestie: source/version is SDL_image 3.4.4, the page is IMG_LoadAnimationTyped_IO(3), and there's no date line listed, so we're not inventing one 💀✨

📦 where this page comes from