www/api/monitor.html
Select API Method
SetImageProgress() calls the monitoring callback with the progress of an image processing operation. It also sets the monitor:progress image artifact available with GetImageArtifact().
The format of the SetImageProgress method is:
MagickBooleanType SetImageProgress(const char \*text, const MagickOffsetType offset,const MagickSizeType extent)
A description of each parameter follows:
imagethe image. textdescription of the image processing operation. offsetthe offset relative to the extent parameter. extentthe extent of the progress.
SetImageProgressMonitor() sets the image progress monitor to the specified method and returns the previous progress monitor if any. The progress monitor method looks like this:
MagickBooleanType MagickProgressMonitor(const char \*text, const MagickOffsetType offset,const MagickSizeType extent, void \*client\_data)
If the progress monitor returns MagickFalse, the current operation is interrupted.
The format of the SetImageProgressMonitor method is:
MagickProgressMonitor SetImageProgressMonitor(Image \*image, const MagickProgressMonitor progress\_monitor,void \*client\_data)
A description of each parameter follows:
imagethe image. progress_monitorSpecifies a pointer to a method to monitor progress of an image operation. client_dataSpecifies a pointer to any client data.
SetImageInfoProgressMonitor() sets the image_info progress monitor to the specified method and returns the previous progress monitor if any. The progress monitor method looks like this:
MagickBooleanType MagickProgressMonitor(const char \*text, const MagickOffsetType offset,const MagickSizeType extent, void \*client\_data)
If the progress monitor returns MagickFalse, the current operation is interrupted.
The format of the SetImageInfoProgressMonitor method is:
MagickProgressMonitor SetImageInfoProgressMonitor(ImageInfo \*image\_info, const MagickProgressMonitor progress\_monitor,void \*client\_data)
A description of each parameter follows:
image_infothe image info. progress_monitorSpecifies a pointer to a method to monitor progress of an image operation. client_dataSpecifies a pointer to any client data.