IMG_CreateAnimationEncoder_IO - Man Page

Create an encoder to save a series of images to an IOStream.

Synopsis

#include <SDL3_image/SDL_image.h>

IMG_AnimationEncoder * IMG_CreateAnimationEncoder_IO(SDL_IOStream *dst, bool closeio, const char *type);

Description

These animation types are currently supported:

· ANI

· APNG

· AVIFS

· GIF

· WEBP

If closeio is true, dst will be closed before returning if this function fails, or when the animation encoder is closed if this function succeeds.

Function Parameters

dst

an SDL_IOStream that will be used to save the stream.

closeio

true to close the SDL_IOStream when done, false to leave it open.

type

a filename extension that represent this data ("WEBP", etc).

Return Value

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

Availability

This function is available since SDL_image 3.4.0.

See Also

IMG_CreateAnimationEncoder(3), IMG_CreateAnimationEncoderWithProperties(3), IMG_AddAnimationEncoderFrame(3), IMG_CloseAnimationEncoder(3)

Referenced By

IMG_AddAnimationEncoderFrame(3), IMG_CloseAnimationEncoder(3), IMG_CreateAnimationEncoder(3), IMG_CreateAnimationEncoderWithProperties(3).

SDL_image 3.4.0 SDL_image3 FUNCTIONS