opensolaris man page for mlib_imageclearedge

mlib_ImageClearEdge(3MLIB)				    mediaLib Library Functions					mlib_ImageClearEdge(3MLIB)

NAME
       mlib_ImageClearEdge - sets edges of an image to a specific color

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

       mlib_status mlib_ImageClearEdge(mlib_image *img, mlib_s32 dx, mlib_s32 dy,
	    const mlib_s32 *color);

DESCRIPTION
       The  mlib_ImageClearEdge()  function sets edges of an image to a specific color. This function can be used in conjunction with the convolve
       and other spatial functions to fill in the pixel values along the edges. The data type of the image can be MLIB_BIT, MLIB_BYTE, MLIB_SHORT,
       MLIB_USHORT, or MLIB_INT.

PARAMETERS
       The function takes the following arguments:

       img	Pointer to an image.

       dx	Number of columns on the left and right edges of the image to be cleared.

       dy	Number of rows at the top and bottom edges of the image to be cleared.

       color	Array of color values by channel. color[i] contains the value 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_ImageClear(3MLIB), mlib_ImageClear_Fp(3MLIB), mlib_ImageClearEdge_Fp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007						mlib_ImageClearEdge(3MLIB)