lqr_vmap_new(3) [debian man page]

LQR_VMAP_NEW(3) 					     LqR library API reference						   LQR_VMAP_NEW(3)

NAME

       lqr_vmap_new - the LqrVMap object constructor

SYNOPSIS

       #include <lqr.h>

       LqrVMap* lqr_vmap_new(gint* buffer, gint width, gint height, gint depth, gint orientation);

DESCRIPTION

       The function lqr_vmap_new is the constructor for LqrVMap objects. It can be used to convert saved data in a format which can be loaded in
       an LqrCarver object.

       The parameter buffer must point to an an array of width * height ints holding the visibility information.

       The parameter depth represents the maximum possible amount of rescaling with the given map.

       The parameter orientation must be 0 if the map is to be used for horizontal rescaling, 1 if it is to be used for vertical rescaling.

VISIBILITY MAPS FORMAT

       The buffer must be an array of integers of size width * height. For an horizontally oriented visibility map, the format is as such: each
       row must contain all values between 1 and depth (included) exactly once, with low values indicating the pixels which will be operated on
       first during rescaling. All other pixels must be 0, which means that they won't be affected by rescaling. Such a map allows for horizontal
       rescaling in the range from width - depth to width + depth. The same applies to vertically oriented visibility maps, with columns in place
       of rows and height in place of width.

RETURN VALUE

       The function returns the newly created LqrVMap if successful, or NULL in case of insufficient memory.

SEE ALSO

       lqr_vmap_destroy(3), lqr_vmap_load(3)

COPYRIGHT

       Copyright (C) 2007-2009 Carlo Baldassi

LqR library 0.4.1 API (3:1:3)					    10 Maj 2009 						   LQR_VMAP_NEW(3)

LQR_CARVER_NEW(3)					     LqR library API reference						 LQR_CARVER_NEW(3)

NAME

       lqr_carver_new, lqr_carver_new_ext - the LqrCarver object constructors

SYNOPSIS

       #include <lqr.h>

       LqrCarver* lqr_carver_new(guchar* buffer, gint width, gint height, gint channels);

       LqrCarver* lqr_carver_new_ext(void* buffer, gint width, gint height, gint channels, LqrColDepth colour_depth);

DESCRIPTION

       The functions lqr_carver_new and lqr_carver_new_ext create a new LqrCarver object from an image of size width * height with channels colour
       channels.

       The image must be stored in buffer as a plain array of unsigned chars (for lqr_carver_new) or the appropriate type cast to void (for
       lqr_carver_new_ext), ordered by row, then by column, then by colour channel.

       In the extended constructor lqr_carver_new_ext, the additional parameter colour_depth is required to specify the colour depth of the buffer
       (see LqrColDepth(3) for more information).

       After calling the function, the buffer will be owned by the LqrCarver object and must not be accessed any more, unless you subsequently
       call the lqr_carver_set_preserve_input_image(3) function.

       The image type is et automatically from the value of channels according to this table:

       Table 3.1. Image types assigned by default
       +---------+------------------+
       |channels | type 	    |
       +---------+------------------+
       |1	 | LQR_GREY_IMAGE   |
       +---------+------------------+
       |2	 | LQR_GREYA_IMAGE  |
       +---------+------------------+
       |3	 | LQR_RGB_IMAGE    |
       +---------+------------------+
       |4	 | LQR_RGBA_IMAGE   |
       +---------+------------------+
       |5	 | LQR_CMYKA_IMAGE  |
       +---------+------------------+
       |>5	 | LQR_CUSTOM_IMAGE |
       +---------+------------------+

RETURN VALUE

       The return value is the address of the newly created LqrCarver object, or NULL in case of failure (insufficient memory).

SEE ALSO

       LqrColDepth(3), LqrImageType(3), lqr_carver_destroy(3), lqr_carver_init(3), lqr_carver_set_preserve_input_image(3)

COPYRIGHT

       Copyright (C) 2007-2009 Carlo Baldassi

LqR library 0.4.1 API (3:1:3)					    10 Maj 2009 						 LQR_CARVER_NEW(3)