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

IMG_CreateAnimationDecoderWithProperties

Create an animation decoder with the specified properties.

Header File

Syntax

IMG_AnimationDecoder * IMG_CreateAnimationDecoderWithProperties(SDL_PropertiesID props);


#define IMG_PROP_ANIMATION_DECODER_CREATE_FILENAME_STRING                "SDL_image.animation_decoder.create.filename"
#define IMG_PROP_ANIMATION_DECODER_CREATE_IOSTREAM_POINTER               "SDL_image.animation_decoder.create.iostream"
#define IMG_PROP_ANIMATION_DECODER_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN     "SDL_image.animation_decoder.create.iostream.autoclose"
#define IMG_PROP_ANIMATION_DECODER_CREATE_TYPE_STRING                    "SDL_image.animation_decoder.create.type"
#define IMG_PROP_ANIMATION_DECODER_CREATE_TIMEBASE_NUMERATOR_NUMBER      "SDL_image.animation_decoder.create.timebase.numerator"
#define IMG_PROP_ANIMATION_DECODER_CREATE_TIMEBASE_DENOMINATOR_NUMBER    "SDL_image.animation_decoder.create.timebase.denominator"

Function Parameters

SDL_PropertiesID

props

the properties of the animation decoder.

Return Value

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

Remarks

These are the supported properties:

IMG_PROP_ANIMATION_DECODER_CREATE_FILENAME_STRING: the file to load, if an SDL_IOStream isn't being used. This is required if IMG_PROP_ANIMATION_DECODER_CREATE_IOSTREAM_POINTER isn't set.
IMG_PROP_ANIMATION_DECODER_CREATE_IOSTREAM_POINTER: an SDL_IOStream containing a series of images. This should not be closed until the animation decoder is closed. This is required if IMG_PROP_ANIMATION_DECODER_CREATE_FILENAME_STRING isn't set.
IMG_PROP_ANIMATION_DECODER_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN: true if closing the animation decoder should also close the associated SDL_IOStream.
IMG_PROP_ANIMATION_DECODER_CREATE_TYPE_STRING: the input file type, e.g. "webp", defaults to the file extension if IMG_PROP_ANIMATION_DECODER_CREATE_FILENAME_STRING is set.

Version

This function is available since SDL_image 3.4.0.