opensolaris man page for mlib_imagecolorrgb2mono

mlib_ImageColorRGB2Mono(3MLIB)				    mediaLib Library Functions				    mlib_ImageColorRGB2Mono(3MLIB)

NAME
       mlib_ImageColorRGB2Mono - RGB to monochrome conversion

SYNOPSIS
       cc [ flag... ] file... -lmlib [ library... ]
       #include <mlib.h>

       mlib_status mlib_ImageColorRGB2Mono(mlib_image *dst, const mlib_image *src,
	    const mlib_d64 *weight);

DESCRIPTION
       The  mlib_ImageColorRGB2Mono()  function  performs  a conversion from a red/green/blue to a monochromatic image. The source image must be a
       three-channel image. The destination image must be a single-channel image.

       It uses the following equation:

	 dst[x][y][0] = weight[0]*src[x][y][0] +
			weight[1]*src[x][y][1] +
			weight[2]*src[x][y][2]

PARAMETERS
       The function takes the following arguments:

       dst	 Pointer to destination image.

       src	 Pointer to source image.

       weight	 Array of three blending coefficients. It is recommended that these sum to 1.0, but it is not required.

RETURN VALUES
       The function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       mlib_ImageColorRGB2CIEMono(3MLIB), mlib_ImageColorRGB2CIEMono_Fp(3MLIB), mlib_ImageColorRGB2Mono_Fp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					    mlib_ImageColorRGB2Mono(3MLIB)