IMG_LoadAnimation_IO(3)

💖 NAME 💖

okay bestie, welcome to the IMG_LoadAnimation_IO(3) page from the SDL_image3 FUNCTIONS manual ✨ and it's literally about how to load an animation from an SDL_IOStream. main character energy only 💅

✨ SYNOPSIS ✨

#include <SDL3_image/SDL_image.h>

IMG_Animation * IMG_LoadAnimation_IO(SDL_IOStream *src, bool closeio);

🦋 DESCRIPTION 🦋

So here's the vibe: if closeio is true, src will be closed before returning — and yes, that's whether this function succeeds or not. No cap. SDL_image reads everything it needs from src during this call in any case, so it's not gonna be like "wait, I still need that stream later" — it's giving self-sufficient.

When you're done with the returned animation, the app should dispose of it with a call to IMG_FreeAnimation(). Please don't ghost your animations, bestie — free them 🫶

🌸 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.

👑 RETURN VALUE 👑

Returns a new IMG_Animation, or NULL on error. Iconic when it works, NULL when it doesn't 😭

⭐ AVAILABILITY ⭐

This function is available since SDL_image 3.0.0 🌈

🌈 SEE ALSO 🌈

• IMG_CreateAnimatedCursor(3)
• IMG_LoadAnimation(3)
• IMG_LoadAnimationTyped_IO(3)
• IMG_LoadANIAnimation_IO(3)
• IMG_LoadAPNGAnimation_IO(3)
• IMG_LoadAVIFAnimation_IO(3)
• IMG_LoadGIFAnimation_IO(3)
• IMG_LoadWEBPAnimation_IO(3)
• IMG_FreeAnimation(3)

---

💖 cute little sign-off flex: this page is from SDL_image, version 3.4.4 — and the footer doesn't list a date, so I'm not inventing one, bestie. periodt 💅🎀