lqrcoldepth(3) [debian man page]

LQRCOLDEPTH(3)						     LqR library API reference						    LQRCOLDEPTH(3)

NAME

       LqrColDepth - carver objects colour depth specification

DESCRIPTION

       The default LqrCarver object constructor lqr_carver_new uses a colour depth of 8 bits per channel, and therefore its input must be an array
       of unsigned chars. However, the LqrCarver objects can handle images of grater colour depth, if they are created with the lqr_carver_new_ext
       constructor. The possible colour depths are specified through variables of type LqrColDepth, which is an enum type; its possible values,
       and the type of the input buffer associated with them, are:

       LQR_COLDEPTH_8I
	   use type guchar (8 bit unsigned integers) - the default

       LQR_COLDEPTH_16I
	   use type guint16 (16 bit unsigned integers)

       LQR_COLDEPTH_32F
	   use type gfloat (32 bit floating point)

       LQR_COLDEPTH_64F
	   use type gdouble (64 bit floating point)

       These values are also relevant when reading out a LqrCarver object with the functions lqr_carver_scan_ext or lqr_carver_scan_line_ext,
       since the readout buffer must be cast to the appropriate type to be actually read.

       The colour depth of an LqrCarver object can be obtained with the function lqr_carver_get_col_depth.

SEE ALSO

       lqr_carver_new(3), lqr_carver_get_col_depth(3), lqr_carver_scan(3), lqr_carver_scan_line(3)

COPYRIGHT

       Copyright (C) 2007-2009 Carlo Baldassi

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

LQR_CARVER_SCAN(3)					     LqR library API reference						LQR_CARVER_SCAN(3)

NAME

       lqr_carver_scan, lqr_carver_scan_ext - read out a multi-size image one pixel at a time

SYNOPSIS

       #include <lqr.h>

       gboolean lqr_carver_scan(LqrCarver* carver, gint* x, gint* y, guchar** rgb);

       gboolean lqr_carver_scan_ext(LqrCarver* carver, gint* x, gint* y, void** rgb);

DESCRIPTION

       The functions lqr_carver_scan and lqr_carver_scan_ext are used to read out the multi-size image contained in the LqrCarver object pointed
       to by carver one pixel at a time. They store the pixel coordinates in the variables pointed to by x and y, and the pixel content in the
       array pointed to by rgb; then they move the readout pointer to the next pixel, or they reset it if the end of the image is reached.

       The first one must only be used on the LqrCarver objects created with lqr_carver_new, i.e. with 8-bit images, while the second one is
       general (see LqrColDepth(3)), but the rgb pointer must be cast to the appropriate type to be used (i.e pass the address of a pointer to
       void to the function lqr_carver_scan_ext, then cast it to a pointer of the appropriate type and use this last one for reading the output).

       The rgb variable will point to an array which is internal to the LqrCarver object, so there is no need to allocate memory for it. However,
       it should only be accessed right after a call to the scan functions, and writing to it must be avoided.

RETURN VALUE

       These functions return TRUE in case the readout is successful and the end of the image was not reached, FALSE otherwise. If lqr_carver_scan
       is called over a non-8-bit LqrCarver object, it will return FALSE.

SEE ALSO

       LqrColDepth(3), lqr_carver_scan_reset(3), lqr_carver_scan_line(3)

COPYRIGHT

       Copyright (C) 2007-2009 Carlo Baldassi

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