ImageGear for C and C++ on Windows v19.4 - Updated
IG_DIB_flush
API Reference Guide > Core Component API Reference > Core Component Functions Reference > DIB Functions > IG_DIB_flush

This function flushes the DIB if it uses a memory mapped file for storing pixels.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_DIB_flush(HIGEAR hIGear);

Arguments:

Name Type Description
hIGear HIGEAR Handle of the image whose pixel data should be flushed.

Return Value:

Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++, except:

Sample:

Pixel Access

Remarks:

Call this function periodically to flush the DIB if the application accesses individual pixels or rasters of an image, or accesses pixel data directly by the image or raster pointer, and the DIB uses a memory mapped file for storing pixels. Usually, it is sufficient to flush the DIB after accessing of 100 - 200 Mb of pixel data.

If memory mapping is not used for the DIB, the function does nothing.

See Also:

Accessing Pixels of a Gigabyte-Sized Image