ImageGear for C and C++ on Linux v18.10 - Updated
IG_display_animation_delay_set
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Display Functions > IG_display_animation_delay_set

This function sets the animation delay for image hIGear (currently, this quantity is meaningful only with GIF format files).

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_display_animation_delay_set (
        HIGEAR hIGear, 
        UINT nDelay 
);

Arguments:

Name Type Description
hIGear HIGEAR HIGEAR handle of image.
nDelay UINT Animation delay, in milliseconds. A setting of 100 would mean 10 frames per second.

Return Value:

Returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

This function does not process image pixels.

Example:

 
Copy Code
HIGEAR            hIGear;                        /* HIGEAR handle of image                               */
/* Set for 5 frames per second: */
IG_display_animation_delay_set ( hIGear, 200 );

Remarks:

ImageGear does not provide functions for creating animation. This function is for setting this value in the HIGEAR. You will need to write your own code to display the images in succession (animate).