SDL Wiki
[ front page | index | search | recent changes | git repo | offline html ]
(This function is part of SDL_image, a separate library from SDL.)

IMG_AddAnimationEncoderFrame

Add a frame to an animation encoder.

Header File

Defined in <SDL3_image/SDL_image.h>

Syntax

bool IMG_AddAnimationEncoderFrame(IMG_AnimationEncoder *encoder, SDL_Surface *surface, Uint64 duration);

Function Parameters

IMG_AnimationEncoder * encoder the receiving images.
SDL_Surface * surface the surface to add as the next frame in the animation.
Uint64 duration the duration of the frame, usually in milliseconds but can be other units if the IMG_PROP_ANIMATION_ENCODER_CREATE_TIMEBASE_DENOMINATOR_NUMBER property is set when creating the encoder.

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


CategoryAPI, CategoryAPIFunction, CategorySDLImage


[ edit | delete | history | feedback | raw ]

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