IMG_CREATEANIMATIONDECODER_IO(3)

💖 IMG_CreateAnimationDecoder_IO(3) 💖

okay so bestie, welcome to the SDL_image3 girlies' corner of the manual pages ✨ this one lives in the FUNCTIONS section and it's literally the glow-up your image-loading era has been waiting for.

---

🌸 NAME 🌸

IMG_CreateAnimationDecoder_IO — she builds you a decoder that reads a whole series of images (a.k.a. an animation, a.k.a. the moment it all pops off) straight out of an IOStream. 🎀

---

✨ SYNOPSIS ✨

#include <SDL3_image/SDL_image.h>

IMG_AnimationDecoder * IMG_CreateAnimationDecoder_IO(SDL_IOStream *src, bool closeio, const char *type);

no cap, that's the whole signature. one call. iconic. 💅

---

🦋 DESCRIPTION 🦋

here's the tea: this function hands you back a decoder, and that decoder is obsessed with reading a whole series of images from an IOStream. like, all the frames. the full main character arc. 🌈

these animation types are currently supported (the VIP list, the guest list, the whole thing):

• ANI
• APNG
• AVIFS
• GIF
• WEBP

now, about closeio, because this part lowkey matters a lot:

if closeio is true, then src will be closed before returning if this function fails — or it'll be closed when the animation decoder is closed, if this function succeeds. either way, true means you're handing over the keys and she's locking up when she leaves. 🗝️

---

🫶 FUNCTION PARAMETERS 🫶

• src — an SDL_IOStream holding a series of images. that's the source material, the raw footage, the content. 📼
• closeio — true to close the SDL_IOStream when done, false to leave it open. your call, bestie, but you do have to make one.
• type — a filename extension that represents this data ("WEBP", etc). yes it's a string, yes you write it like that. 💫

---

⭐ RETURN VALUE ⭐

returns a brand new IMG_AnimationDecoder on success — slay — or NULL on failure. 😭

if you get NULL, do not just sit there wondering what went wrong: call SDL_GetError() for more information. she will tell you. fr fr.

---

👑 AVAILABILITY 👑

this function is available since SDL_image 3.4.0. so if you're on something older, it's giving not yet, sorry babe. 💀

---

🔥 SEE ALSO 🔥

the whole friend group, obviously:

• IMG_CreateAnimationDecoder(3)
• IMG_CreateAnimationDecoderWithProperties(3)
• IMG_GetAnimationDecoderFrame(3)
• IMG_ResetAnimationDecoder(3)
• IMG_CloseAnimationDecoder(3)

---

and that's the page, bestie!! 🎀 this was SDL_image documentation, version SDL_image 3.4.8, and yes the header says IMG_CreateA...onDecoder_IO(3) because even manpage titles get truncated for the aesthetic. 💖 mwah, go decode something gorgeous. 🦋✨