#include <gig.h>
Public Member Functions | |
progress_t () | |
Public Attributes | |
void(* | callback )(progress_t *) |
Callback function pointer which has to be assigned to a function for progress notification. | |
float | factor |
Reflects current progress as value between 0.0 and 1.0. | |
void * | custom |
This pointer can be used for arbitrary data. | |
float | __range_min |
Only for internal usage, do not modify! | |
float | __range_max |
Only for internal usage, do not modify! |
The function pointer argument has to be supplied with a valid function of the given signature which will then be called on progress changes. An equivalent progress_t structure will be passed back as argument to the callback function on each progress change. The factor field of the supplied progress_t structure will then reflect the current progress as value between 0.0 and 1.0. You might want to use the custom field for data needed in your callback function.
Definition at line 317 of file gig.h.
gig::progress_t::progress_t | ( | ) |
Only for internal usage, do not modify!
Definition at line 322 of file gig.h.
Referenced by gig::File::GetInstrument(), and progress_t().
Only for internal usage, do not modify!
Definition at line 321 of file gig.h.
Referenced by gig::File::GetInstrument(), and progress_t().
void(* gig::progress_t::callback)(progress_t *) |
Callback function pointer which has to be assigned to a function for progress notification.
Referenced by gig::File::GetInstrument(), and progress_t().
void* gig::progress_t::custom |
This pointer can be used for arbitrary data.
Definition at line 320 of file gig.h.
Referenced by progress_t().
float gig::progress_t::factor |