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

IMG_AddAnimationFrame

Add a frame to a stream of images being saved.

Header File

Defined in <SDL3_image/SDL_image.h>

Syntax

bool IMG_AddAnimationFrame(IMG_AnimationStream *stream, SDL_Surface *surface, Uint64 pts);

Function Parameters

IMG_AnimationStream *	stream	the stream receiving images.
SDL_Surface *	surface	the surface to add as the next frame in the animation.
Uint64	pts	the presentation timestamp of the frame, usually in milliseconds but can be other units if the IMG_PROP_ANIMATION_STREAM_CREATE_TIMEBASE_DENOMINATOR_NUMBER property is set when creating the stream.

Return Value

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

Version

This function is available since SDL_image 3.4.0.

See Also

• IMG_CreateAnimationStream
• IMG_CreateAnimationStream_IO
• IMG_CreateAnimationStreamWithProperties
• IMG_CloseAnimationStream

---

CategoryAPI, CategoryAPIFunction, CategorySDLImage

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.