IMG_CREATEANIMATIONENCODER_IO(3)

💖 IMG_CreateAnimationEncoder_IO(3) 💖

okay bestie, welcome to the SDL_image3 functions corner of the manual — this is where the magic happens ✨

🌸 NAME 🌸

IMG_CreateAnimationEncoder_IO — creates an encoder so you can save a whole series of images into an IOStream. it's giving "make me a little movie" energy 🎬

---

✨ SYNOPSIS ✨

#include <SDL3_image/SDL_image.h>

IMG_AnimationEncoder * IMG_CreateAnimationEncoder_IO(SDL_IOStream *dst, bool closeio, const char *type);

like yes, that's the whole thing, she's compact 👑

---

🦋 DESCRIPTION 🦋

so these animation types are the ones currently supported, no cap:

• ANI
• APNG
• AVIFS
• GIF
• WEBP

now listen, about closeio — this is the part where you actually pay attention 🙈 If closeio is true, then dst will be closed before returning if this function fails, or when the animation encoder is closed if this function succeeds. literally both paths, she's covered 💅

---

🎀 FUNCTION PARAMETERS 🎀

• dst — an SDL_IOStream that's gonna be used to save the stream. that's her job, that's what she does 🫶
• closeio — true to close the SDL_IOStream when done, false to leave it open. your call, main character 💜
• type — a filename extension that represents this data ("WEBP", etc). yes, extensions, the little strings, iconic ⭐

---

🌈 RETURN VALUE 🌈

returns a shiny new IMG_AnimationEncoder, or NULL on failure 😭 — and if you get NULL, go call SDL_GetError() for more information, she'll tell you what went wrong, fr fr.

---

💫 AVAILABILITY 💫

this function is available since SDL_image 3.4.0. old news but still slaying ✨

---

👑 SEE ALSO 👑

• IMG_CreateAnimationEncoder(3)
• IMG_CreateAnimationEncoderWithProperties(3)
• IMG_AddAnimationEncoderFrame(3)
• IMG_CloseAnimationEncoder(3)

the whole friend group, go read them too 🧚

---

mwah 💋 that's the page, bestie — brought to you by SDL_image 3.4.8, aka the version this manual page came from. go forth and encode your little animations, i'm obsessed 🍓💖