lqr_carver_set_enl_step(3)

lqr_carver_set_enl_step3

Set the enlargement step of a lqrcarver object

Usage

#include <lqr.h>

LqrRetVal lqr_carver_set_enl_step(LqrCarver* carver, gfloat enl_step);

Overview

The function lqr_carver_set_enl_step sets the enlargement step of the LqrCarver object pointed to by carver to the value specified in enl_step, which must be strictly greater than 1 and less than 2.

The enlargement step is the maximum enlargement ratio (with respect to either the original width or original height of carver) which the function lqr_carver_resize applies in a single step; if that function is asked a greater enlargement, it divides the process in multiple steps (and updates the original sizes accordingly at each new step - these can be readout at any time with lqr_carver_get_ref_width(3) and lqr_carver_get_ref_height(3)).

The default value for new LqrCarver objects is 2.0.

Return value

The return value follows the Liquid Rescale library signalling system. LQR_ERROR is returned if the enl_step parameter is out of bounds.

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.