IMG_SaveAnimationTyped_IO - Man Page

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

anim

the animation to save.

dst

an SDL_IOStream that data will be written to.

closeio

true to close/free the SDL_IOStream before returning, false to leave it open.

type

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)

Referenced By

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

SDL_image 3.4.0 SDL_image3 FUNCTIONS