NAME

cxParamColorPackedGet - convert a string color parameter into a packed integer format

C SPECIFICATION

#include <cx/DataAccess.h>


cxErrorCode cxParamColorPackedGet(
      cxParameter *src,
      unsigned int *color );

FORTRAN SPECIFICATION

integer function cxParamColorPackedGet( src, color )
integer src
integer color

DESCRIPTION

cxParamColorPackedGet converts src, a cxParameter in "color format" , into a packed integer format stored in color. The cxParameter color format and its conversion is described in the cxParamColorFloatGet(3E) man page. Red, green, blue and alpha values are scaled to [0..255] and are packed into color in the format 0xRRGGBBAA.

A value of cx_err_error is returned and color is unchanged if any conversion error occurs, otherwise cx_err_none is returned.

SEE ALSO

cxParamColorFloatGet(3E), cxParamColorFloatSet(3E), cxParamColorPackedSet(3E), cxRGBtoHSV(3E).
Last modified: May 27 12:28 1999
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1999