gp_progress_callback.h File Reference

A progress callback. More...

#include <core/gp_types.h>

Go to the source code of this file.

Data Structures
struct	gp_progress_cb
	Progress callback. More...

Functions
static int	gp_progress_cb_report (gp_progress_cb *callback, unsigned int val, unsigned int max, unsigned int mul __attribute__((unused)))
	Reports progress.

Detailed Description

A progress callback.

Progress callbacks serves following purposes:

• ability to visibly show algorithm progress
• ability to abort operation in the middle of processing
• ability to override default number of threads to use for the operation

Definition in file gp_progress_callback.h.

Function Documentation

gp_progress_cb_report()

static int gp_progress_cb_report ( gp_progress_cb *  callback, unsigned int  val, unsigned int  max, unsigned int mul   __attribute__(unused)  )

inlinestatic

Reports progress.

This function is called by image loaders and filters to report progress.

The progress is reported as percentage based on the val where max is 100%.

Parameters

callback	A progress callback, passed from application.
val	Current value.
max	A maximal value.

Definition at line 62 of file gp_progress_callback.h.

References gp_progress_cb::callback.