opensolaris man page for mlib_imageblendcolor_fp

mlib_ImageBlendColor_Fp(3MLIB)				    mediaLib Library Functions				    mlib_ImageBlendColor_Fp(3MLIB)

NAME
       mlib_ImageBlendColor_Fp - blend an image and a color

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

       mlib_status mlib_ImageBlendColor_Fp(mlib_image *dst, const mlib_image *src,
	    const mlib_d64 *color, mlib_s32 cmask);

DESCRIPTION
       The mlib_ImageBlendColor_Fp() function blends an image and a color with the alpha channel.

       It uses the following equation:

	 Cd = Cs*As + Cc*(1 - As)
	 Ad = 1.0

       where,  Cs  and	Cd are the RGB color components of the source and destination images, respectively.  As and Ad are the alpha components of
       the source and destination images, respectively. Cc is the color component of the constant color.

       For MLIB_FLOAT and MLIB_DOUBLE images, the alpha coefficients are assumed to be in the range of [0.0, 1.0].

       The images can have two to four channels. The length of color array must not be less than the number of channels in the images.

PARAMETERS
       The function takes the following arguments:

       dst	Pointer to destination image.

       src	Pointer to source image.

       color	Array of constant color components.

       cmask	Channel mask to indicate the alpha channel. Each bit of cmask represents a channel in the image. The channel corresponding to  the
		highest bit with value 1 is the alpha channel.

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_ImageBlendColor_Fp_Inp(3MLIB), mlib_ImageBlendColor(3MLIB), mlib_ImageBlendColor_Inp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					    mlib_ImageBlendColor_Fp(3MLIB)