Scroll to navigation

IMG_SaveAnimationTyped_IO(3) SDL_image3 FUNCTIONS IMG_SaveAnimationTyped_IO(3)

NAME

IMG_SaveAnimationTyped_IO - Save an animation to an SDL_IOStream.

SYNOPSIS

#include <SDL3_image/SDL_image.h>
bool IMG_SaveAnimationTyped_IO(IMG_Animation *anim, SDL_IOStream *dst, bool closeio, const char *type);

DESCRIPTION

If you just want to save to a filename, you can use IMG_SaveAnimation() instead.

If closeio is true, dst will be closed before returning, whether this function succeeds or not.

For formats that accept a quality, a default quality of 90 will be used.

FUNCTION PARAMETERS

the animation to save.
an SDL_IOStream that data will be written to.
true to close/free the SDL_IOStream before returning, false to leave it open.
a filename extension that represent this data ("GIF", etc).

RETURN VALUE

Returns true on success or false on failure; call SDL_GetError() for more information.

AVAILABILITY

This function is available since SDL_image 3.4.0.

SEE ALSO

IMG_SaveAnimation(3), IMG_SaveANIAnimation_IO(3), IMG_SaveAPNGAnimation_IO(3), IMG_SaveAVIFAnimation_IO(3), IMG_SaveGIFAnimation_IO(3), IMG_SaveWEBPAnimation_IO(3)

SDL_image 3.4.0 SDL_image