IMG_ResetAnimationDecoder - Man Page

Reset an animation decoder.

Synopsis

#include <SDL3_image/SDL_image.h>

bool IMG_ResetAnimationDecoder(IMG_AnimationDecoder *decoder);

Description

Calling this function resets the animation decoder, allowing it to start from the beginning again. This is useful if you want to decode the frame sequence again without creating a new decoder.

Function Parameters

decoder

the decoder to reset.

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), IMG_GetAnimationDecoderFrame(3), IMG_CloseAnimationDecoder(3)

Referenced By

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

SDL_image 3.4.0 SDL_image3 FUNCTIONS