IMG_LoadAnimationTyped_IO - Man Page

Load an animation from an SDL datasource

Header File

Defined in SDL3_image/SDL_image.h

Synopsis

#include "SDL3_image/SDL_image.h"

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

Description

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 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 ().

Function Parameters

src

an SDL_IOStream that data will be read from.

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

( IMG_Animation
*) Returns a new

IMG_Animation , or NULL on error.

Availability

This function is available since SDL_image 3.0.0.

See Also

·(3), IMG_LoadAnimation(3), ·(3), IMG_LoadAnimation_IO(3), ·(3), IMG_FreeAnimation(3)

Referenced By

IMG_FreeAnimation(3), IMG_LoadGIFAnimation_IO(3), IMG_LoadWEBPAnimation_IO(3).

SDL_image 3.2.4 SDL_image3 FUNCTIONS