opensolaris man page for mlib_imagechannelextract

mlib_ImageChannelExtract(3MLIB) 			    mediaLib Library Functions				   mlib_ImageChannelExtract(3MLIB)

NAME
       mlib_ImageChannelExtract - channel extract

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

       mlib_status mlib_ImageChannelExtract(mlib_image *dst,
	    const mlib_image *src, mlib_s32 cmask);

DESCRIPTION
       In  the	mlib_ImageChannelExtract() function, the selected N channels in the source image are copied into the destination image, where N is
       the number of channels in the destination image. If more than N channels are selected, then the leftmost N channels are extracted. If  less
       than  N	channels are selected, then the function returns failure status. The channel mask is defined with respect to the source image. The
       data type of the image can be MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, MLIB_INT, MLIB_FLOAT, or MLIB_DOUBLE.

PARAMETERS
       The function takes the following arguments:

       dst	Pointer to a destination image.

       src	Pointer to a source image.

       cmask	Source or destination channel selection mask. Each bit of the mask represents a channel in the image data. The	least  significant
		bit  (LSB)  of	the  mask corresponds to the last channel in the image data. A bit with a value of 1 indicates that the channel is
		selected.

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_ImageChannelInsert(3MLIB), mlib_ImageChannelMerge(3MLIB), mlib_ImageChannelSplit(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					   mlib_ImageChannelExtract(3MLIB)