opensolaris man page for mlib_imageblendmulti

mlib_ImageBlendMulti(3MLIB)				    mediaLib Library Functions				       mlib_ImageBlendMulti(3MLIB)

NAME
       mlib_ImageBlendMulti - blend multiple images

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

       mlib_status mlib_ImageBlendMulti(mlib_image *dst, const mlib_image **srcs,
	    const mlib_image **alphas, const mlib_s32 *c, mlib_s32 n);

DESCRIPTION
       The mlib_ImageBlendMulti() function blends multiple source images, using multiple alpha images, into a single destination image.

       All images involved should have the same data type and same size and the source and destination images should have the same number of chan-
       nels.  The alpha images should have either 1 channel or the same number of channels as the sources and destination.  A single-channel alpha
       image  would  be applied to all channels of the corresponding source image.  Single and multi-channel alpha images can be mixed in the same
       invocation.

       It uses the following equation:

			 n-1
			 SUM {alphas[k][x][y][j] * srcs[k][x][y][i]}
			 k=0
	 dst[x][y][i] = ---------------------------------------------
			 n-1
			 SUM {alphas[k][x][y][j]}
			 k=0

       or

				   n-1
	 dst[x][y][i] = c[i]	if SUM {alphas[k][x][y][j]} = 0
				   k=0

       where j = i for multi-channel alpha images; j = 0 for signle-channel alpha images.

PARAMETERS
       The function takes the following arguments:

       dst	 Pointer to destination image.

       srcs	 Pointer to an array of source images.

       alphas	 Pointer to an array of alpha images.

       c	 Background color.

       n	 Number of source images to be blended.

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_ImageBlendMulti_Fp(3MLIB), mlib_ImageBlend(3MLIB), mlib_ImageBlend_Fp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					       mlib_ImageBlendMulti(3MLIB)