opensolaris man page for mlib_imageconstor

mlib_ImageConstOr(3MLIB)				    mediaLib Library Functions					  mlib_ImageConstOr(3MLIB)

NAME
       mlib_ImageConstOr - Or with a constant

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

       mlib_status mlib_ImageConstOr(mlib_image *dst, const mlib_image *src,
	    const mlib_s32 *c);

DESCRIPTION
       The mlib_ImageConstOr() function computes the logical Or of the source image with a constant on a pixel-by-pixel basis.

       It uses the following equation:

	 dst[x][y][i] = c[i] | src[x][y][i]

       The data type of the images can be MLIB_BIT, MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, or MLIB_INT.

PARAMETERS
       The function takes the following arguments:

       dst    Pointer to destination image.

       src    Pointer to source image.

       c      Array of constants to be applied to each pixel. c[i] contains the constant 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	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       mlib_ImageConstOr_Inp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007						  mlib_ImageConstOr(3MLIB)