IMG_CreateAnimationDecoder - Man Page

Create a decoder to read a series of images from a file.

Synopsis

#include <SDL3_image/SDL_image.h>

IMG_AnimationDecoder * IMG_CreateAnimationDecoder(const char *file);

Description

These animation types are currently supported:

· ANI

· APNG

· AVIFS

· GIF

· WEBP

The file type is determined from the file extension, e.g. "file.webp" will be decoded using WEBP.

Function Parameters

file

the file containing a series of images.

Return Value

Returns a new IMG_AnimationDecoder, or NULL on failure; call SDL_GetError() for more information.

Availability

This function is available since SDL_image 3.4.0.

See Also

IMG_CreateAnimationDecoder_IO(3), IMG_CreateAnimationDecoderWithProperties(3), IMG_GetAnimationDecoderFrame(3), IMG_ResetAnimationDecoder(3), IMG_CloseAnimationDecoder(3)

Referenced By

IMG_CloseAnimationDecoder(3), IMG_CreateAnimationDecoder_IO(3), IMG_CreateAnimationDecoderWithProperties(3), IMG_GetAnimationDecoderFrame(3), IMG_GetAnimationDecoderProperties(3), IMG_ResetAnimationDecoder(3).

SDL_image 3.4.0 SDL_image3 FUNCTIONS