libgig  4.0.0
RIFF::progress_t Struct Reference

Used for indicating the progress of a certain task. More...

#include <RIFF.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. More...
 
float factor
 Reflects current progress as value between 0.0 and 1.0. More...
 
void * custom
 This pointer can be used for arbitrary data. More...
 
float __range_min
 Only for internal usage, do not modify! More...
 
float __range_max
 Only for internal usage, do not modify! More...
 

Detailed Description

Used for indicating the progress of a certain task.

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 191 of file RIFF.h.

Constructor & Destructor Documentation

◆ progress_t()

RIFF::progress_t::progress_t ( )

Definition at line 60 of file RIFF.cpp.

References __range_max, __range_min, callback, and custom.

Member Data Documentation

◆ __range_max

float RIFF::progress_t::__range_max

Only for internal usage, do not modify!

Definition at line 196 of file RIFF.h.

Referenced by gig::File::GetInstrument(), and progress_t().

◆ __range_min

float RIFF::progress_t::__range_min

Only for internal usage, do not modify!

Definition at line 195 of file RIFF.h.

Referenced by gig::File::GetInstrument(), and progress_t().

◆ callback

void(* RIFF::progress_t::callback) (progress_t *)

Callback function pointer which has to be assigned to a function for progress notification.

Definition at line 192 of file RIFF.h.

Referenced by gig::File::GetInstrument(), and progress_t().

◆ custom

void* RIFF::progress_t::custom

This pointer can be used for arbitrary data.

Definition at line 194 of file RIFF.h.

Referenced by progress_t().

◆ factor

float RIFF::progress_t::factor

Reflects current progress as value between 0.0 and 1.0.

Definition at line 193 of file RIFF.h.


The documentation for this struct was generated from the following files: