IMG_CloseAnimationDecoder - Man Page

Close an animation decoder, finishing any decoding.

Synopsis

#include <SDL3_image/SDL_image.h>

bool IMG_CloseAnimationDecoder(IMG_AnimationDecoder *decoder);

Description

Calling this function frees the animation decoder, and returns the final status of the decoding process.

Function Parameters

decoder

the decoder to close.

Return Value

Returns true on success or false on failure; call SDL_GetError() for more information.

Availability

This function is available since SDL_image 3.4.0.

See Also

IMG_CreateAnimationDecoder(3), IMG_CreateAnimationDecoder_IO(3), IMG_CreateAnimationDecoderWithProperties(3)

Referenced By

IMG_CreateAnimationDecoder(3), IMG_CreateAnimationDecoder_IO(3), IMG_CreateAnimationDecoderWithProperties(3), IMG_GetAnimationDecoderFrame(3), IMG_ResetAnimationDecoder(3).

SDL_image 3.4.0 SDL_image3 FUNCTIONS