sunos man page for mlib_imagecopymask

mlib_ImageCopyMask(3MLIB)				    mediaLib Library Functions					 mlib_ImageCopyMask(3MLIB)

NAME
       mlib_ImageCopyMask - copy with mask

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

       mlib_status mlib_ImageCopyMask(mlib_image *dst, const mlib_image *src, const mlib_image *mask, const mlib_s32 *thresh);

DESCRIPTION
       The  mlib_ImageCopyMask()  function  copies one image to another image via a mask image by using it as a yes/no indicator. The data type of
       the images can be MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, or MLIB_INT.

       It uses the following equation:

       dst[x][y][i] = src[x][y][i]  if mask[x][y][i] <= thresh[i]
       dst[x][y][i] = dst[x][y][i]  if mask[x][y][i] > thresh[i]

PARAMETERS
       The function takes the following arguments:

       dst	       Pointer to destination image.

       src	       Pointer to source image.

       mask	       Pointer to mask image.

       thresh	       Threshold for the mask image. thresh[i] contains the threshold for channel i.

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	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       mlib_ImageCopy(3MLIB), mlib_ImageCopyArea(3MLIB), mlib_ImageCopyMask_Fp(3MLIB), mlib_ImageCopySubimage(3MLIB), attributes(5)

SunOS 5.10							    10 Nov 2004 					 mlib_ImageCopyMask(3MLIB)