Updater functions

Some functions that do a lot of computation take updater call-back functions that will be called from time to time during the computation to allow the user to, for example, update an on-screen progress indicator. The arguments of this function are described below.

void (*updater)(int done,int of,void *user);

done

A number indicating how much of the job is complete. The proportion of the job completed is given by $\frac{done}{of}$ .

of

A number to which the done parameter should be compared when judging completion.

user

The pointer to user data passed in to the function that to which the updater function was also passed.