opensolaris man page for mlib_imageblend2_inp

mlib_ImageBlend2_Inp(3MLIB)				    mediaLib Library Functions				       mlib_ImageBlend2_Inp(3MLIB)

NAME
       mlib_ImageBlend2_Inp - blend with an alpha image, in place

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

       mlib_status mlib_ImageBlend2_Inp(mlib_image *src2dst,
	    const mlib_image *src1, const mlib_image *alpha);

DESCRIPTION
       The  mlib_ImageBlend2_Inp()  function  blends  two images together, in place, on a pixel-by-pixel basis using an alpha image, when alpha is
       also on a pixel basis. The alpha image can be a single-channel image or have the same number of channels  as  the  source  and  destination
       images.

       It uses the following equation when the alpha image is a single-channel image:

	 src2dst[x][y][i] = a[x][y][0]*src1[x][y][i] +
			    (1 - a[x][y][0])*src2dst[x][y][i]

       It uses the following equation when the alpha image has the same number of channels as the source and destination images:

	 src2dst[x][y][i] = a[x][y][i]*src1[x][y][i] +
			    (1 - a[x][y][i])*src2dst[x][y][i]

PARAMETERS
       The function takes the following arguments:

       src2dst	  Pointer to second source and destination image.

       src1	  Pointer to first source image.

       alpha	  Alpha  image	used  to  control  blending.  The  a  value  equals  (alpha * 2**(-8)) for MLIB_BYTE image, (alpha * 2**(-15)) for
		  MLIB_SHORT image, (alpha * 2**(-16)) for MLIB_USHORT image, and (alpha * 2**(-31)) for MLIB_INT image.

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_ImageBlend(3MLIB),	   mlib_ImageBlend_Fp(3MLIB),	  mlib_ImageBlend1_Fp_Inp(3MLIB),     mlib_ImageBlend1_Inp(3MLIB),     mlib_Image-
       Blend2_Fp_Inp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					       mlib_ImageBlend2_Inp(3MLIB)