(This function is part of SDL_image, a separate library from SDL.)

IMG_LoadAnimation_IO

Load an animation from an SDL_IOStream.

Header File

Syntax

IMG_Animation * IMG_LoadAnimation_IO(SDL_IOStream *src, bool closeio);

Function Parameters

SDL_IOStream *	src	an SDL_IOStream that data will be read from.
bool	closeio	true to close/free the SDL_IOStream before returning, false to leave it open.

Return Value

(IMG_Animation *) Returns a new IMG_Animation, or NULL on error.

Remarks

If closeio is true, src will be closed before returning, whether this function succeeds or not. SDL_image reads everything it needs from src during this call in any case.

When done with the returned animation, the app should dispose of it with a call to IMG_FreeAnimation().

Version

This function is available since SDL_image 3.0.0.