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

IMG_LoadAnimationTyped_IO

Load an animation from an SDL datasource

Header File

Defined in SDL_image.h

Syntax

IMG_Animation * IMG_LoadAnimationTyped_IO(SDL_IOStream *src, SDL_bool closeio, const char *type);

Function Parameters

src	an SDL_IOStream that data will be read from.
closeio	SDL_TRUE to close/free the SDL_IOStream before returning, SDL_FALSE to leave it open.
type	a filename extension that represent this data ("GIF", etc).

Return Value

Returns a new IMG_Animation, or NULL on error.

Remarks

Even though this function accepts a file type, SDL_image may still try other decoders that are capable of detecting file type from the contents of the image data, but may rely on the caller-provided type string for formats that it cannot autodetect. If type is NULL, SDL_image will rely solely on its ability to guess the format.

If closeio is SDL_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.