Skip to content

Commit 168ff36

Browse files
committed
Document the animation delay units
Fixes #550 (cherry picked from commit a8d223f)
1 parent 0dc1f1c commit 168ff36

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

include/SDL_image.h

+7-6
Original file line numberDiff line numberDiff line change
@@ -2039,16 +2039,17 @@ extern DECLSPEC int SDLCALL IMG_SaveJPG(SDL_Surface *surface, const char *file,
20392039
extern DECLSPEC int SDLCALL IMG_SaveJPG_RW(SDL_Surface *surface, SDL_RWops *dst, int freedst, int quality);
20402040

20412041
/**
2042-
* Animated image support.
2042+
* Animated image support
20432043
*
2044-
* Currently only animated GIFs are supported.
2044+
* Currently only animated GIFs and WEBP images are supported.
20452045
*/
20462046
typedef struct IMG_Animation
20472047
{
2048-
int w, h;
2049-
int count;
2050-
SDL_Surface **frames;
2051-
int *delays;
2048+
int w; /**< The width of the frames */
2049+
int h; /**< The height of the frames */
2050+
int count; /**< The number of frames */
2051+
SDL_Surface **frames; /**< An array of frames */
2052+
int *delays; /**< An array of frame delays, in milliseconds */
20522053
} IMG_Animation;
20532054

20542055
/**

0 commit comments

Comments
 (0)