opensolaris man page for mlib_imagechannelmerge

mlib_ImageChannelMerge(3MLIB)				    mediaLib Library Functions				     mlib_ImageChannelMerge(3MLIB)

NAME
       mlib_ImageChannelMerge - channel merge

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

       mlib_status mlib_ImageChannelMerge(mlib_image *dst,
	    const mlib_image **srcs);

DESCRIPTION
       The mlib_ImageChannelMerge() function converts an array of single-channel images into a multi-channel image.

	 A0 A1 A2 ...
	 B0 B1 B2 ...  ===>  A0 B0 C0 A1 B1 C1 A2 B2 C2 ...
	 C0 C1 C2 ...

       All  images  must  have	the same type, same width, and same height. The data type of the images can be MLIB_BYTE, MLIB_SHORT, MLIB_USHORT,
       MLIB_INT, MLIB_FLOAT, or MLIB_DOUBLE. The destination image must have the number of channels equal to the number  of  images  in  the  srcs
       array. The source images must be single-channel images.

PARAMETERS
       The function takes the following arguments:

       dst     Pointer to a multi-channel destination image.

       srcs    Pointer to an array of single-channel source images.

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_ImageChannelCopy(3MLIB), mlib_ImageChannelExtract(3MLIB), mlib_ImageChannelInsert(3MLIB), mlib_ImageChannelSplit(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					     mlib_ImageChannelMerge(3MLIB)