lqr_progress_set_update(3)

lqr_progress_set_update3

Execude custom code at regular steps during each rescaling operation

Usage

#include <lqr.h>

LqrRetVal lqr_progress_set_update(LqrProgress* p, LqrProgressFuncUpdate update_func);

Overview

The function lqr_progress_set_update sets the hook update_func to the LqrProgress object pointed to by p.

The function update_func is of type LqrProgressFuncUpdate, whose prototype is defined by:

typedef LqrRetVal (*LqrProgressFuncUpdate) (gdouble completion_percentage);

Each time that the function lqr_carver_resize(3) performs a rescale operation (recall that it can perform more than one rescale operation at each call) this function will be called at regular intervale, with the current completion percentage completion_percentage as an argument.

The update step can be set with the function lqr_progress_set_update_step(3).

Return value

The return value follows the Liquid Rescale library signalling system.

Releases

Unchanged in 2 releases since Debian 6.0 (Squeeze).

  1. 6.0–7

From liblqr-1-0-dev 0.4.1-2 in Debian 7 (Wheezy). Parsed by carta from the page's man source.