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

IMG_LoadAnimation_RW

Load an animation from an SDL_RWops.

Syntax

IMG_Animation * IMG_LoadAnimation_RW(SDL_RWops *src, SDL_bool freesrc);

Function Parameters

src an SDL_RWops that data will be read from.
freesrc SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE to leave it open.

Return Value

Returns a new IMG_Animation, or NULL on error.

Remarks

If freesrc is SDL_TRUE, the RWops will be closed before returning, whether this function succeeds or not. SDL_image reads everything it needs from the RWops 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.

CategoryAPI