IMG_SaveWEBPAnimation_IO(3)

💖 IMG_SaveWEBPAnimation_IO(3) 💖

okay so bestie, welcome to the SDL_image3 FUNCTIONS section of the manual, and today's main character is IMG_SaveWEBPAnimation_IO. she's the one who takes your whole animation and drops it into a WEBP file, through an SDL_IOStream. no cap. 🎀

---

✨ NAME ✨

IMG_SaveWEBPAnimation_IO — save an animation in WEBP format to an SDL_IOStream. literally that's her whole job and she ate. 🦋

---

🌸 SYNOPSIS 🌸

#include <SDL3_image/SDL_image.h>

bool IMG_SaveWEBPAnimation_IO(IMG_Animation *anim, SDL_IOStream *dst, bool closeio, int quality);

---

🫶 DESCRIPTION 🫶

so here's the tea, and it's actually important tea: if closeio is true, then dst is gonna get closed before the function returns. and not like "only if it worked" — whether this function succeeds or not. it's closing either way. so don't be out here planning to keep using dst afterwards, okay? 💅

---

🎀 FUNCTION PARAMETERS 🎀

• anim — the animation you wanna save. your lil masterpiece. your baby. 👑
• dst — an SDL_IOStream from which data will be written to. (yes bestie, the manpage really does say "from which data will be written to" — she's a little quirky like that, we love her anyway 🙈)
• closeio — true means close/free the SDL_IOStream before returning, false means leave it open. pick wisely, this one has consequences. 😭
• quality — a number between 0 and 100. and she means two different things depending on your vibe:
  • for lossy: 0 gives the smallest size, 100 gives the largest. ✨
  • for lossless: this parameter is the amount of effort put into the compression. 0 is the fastest but gives larger files, compared to the slowest, but best, 100. so like... speed vs. quality, the eternal struggle. ⭐

---

🔥 RETURN VALUE 🔥

returns true on success or false on failure. and if it fails? call SDL_GetError() for more information, because she will not be explaining herself unprompted. 💀

---

🌈 AVAILABILITY 🌈

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

---

👑 SEE ALSO 👑

• IMG_SaveAnimation(3)
• IMG_SaveAnimationTyped_IO(3)
• IMG_SaveANIAnimation_IO(3)
• IMG_SaveAPNGAnimation_IO(3)
• IMG_SaveAVIFAnimation_IO(3)
• IMG_SaveGIFAnimation_IO(3)

the whole save-animation friend group, fr fr. go say hi. 🍓

---

and that's the page!! mwah 💖 this was brought to you by SDL_image version 3.4.8, straight from the SDL_image corner of the world — go forth and save your animations, bestie, you've got this. 🎀✨🦋