opensolaris man page for mlib_imagesconv3x3_fp

mlib_ImageSConv3x3_Fp(3MLIB)				    mediaLib Library Functions				      mlib_ImageSConv3x3_Fp(3MLIB)

NAME
       mlib_ImageSConv3x3_Fp - separable 3x3 convolution

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

       mlib_status mlib_ImageSConv3x3_Fp(mlib_image *dst, const mlib_image *src,
	    const mlib_d64 *hkernel, const mlib_d64 *vkernel, mlib_s32 cmask,
	    mlib_edge edge);

DESCRIPTION
       The mlib_ImageSConv3x3_Fp() function performs a separable 3x3 convolution on the source image by using the user-supplied kernel.

       It uses the following equation:

			m-1-dm n-1-dn
	 dst[x][y][i] =  SUM	SUM  src[x+p][y+q][i]*h[p]*v[q]
			p=-dm  q=-dn

       where m = 3, n = 3, dm = (m - 1)/2 = 1, dn = (n - 1)/2 = 1.

PARAMETERS
       The function takes the following arguments:

       dst	  Pointer to destination image.

       src	  Pointer to source image.

       hkernel	  Pointer to the horizontal kernel.

       vkernel	  Pointer to the vertical kernel.

       cmask	  Channel  mask to indicate the channels to be convolved, each bit of which represents a channel in the image. The channels corre-
		  sponding to one bits are those to be processed. For a single-channel image, the channel mask is ignored.

       edge	  Type of edge condition. It can be one of the following:

		    MLIB_EDGE_DST_NO_WRITE
		    MLIB_EDGE_DST_FILL_ZERO
		    MLIB_EDGE_DST_COPY_SRC
		    MLIB_EDGE_SRC_EXTEND

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_ImageConv2x2(3MLIB),     mlib_ImageConv2x2_Fp(3MLIB),     mlib_ImageConv2x2Index(3MLIB),	 mlib_ImageConv3x3(3MLIB),     mlib_Image-
       Conv3x3_Fp(3MLIB),  mlib_ImageConv3x3Index(3MLIB),  mlib_ImageConv4x4(3MLIB),  mlib_ImageConv4x4_Fp(3MLIB),  mlib_ImageConv4x4Index(3MLIB),
       mlib_ImageConv5x5(3MLIB),     mlib_ImageConv5x5_Fp(3MLIB),     mlib_ImageConv5x5Index(3MLIB),	 mlib_ImageConv7x7(3MLIB),     mlib_Image-
       Conv7x7_Fp(3MLIB),     mlib_ImageConv7x7Index(3MLIB),	mlib_ImageConvKernelConvert(3MLIB),    mlib_ImageConvMxN(3MLIB),    mlib_ImageCon-
       vMxN_Fp(3MLIB), mlib_ImageConvMxNIndex(3MLIB),  mlib_ImageConvolveMxN(3MLIB),  mlib_ImageConvolveMxN_Fp(3MLIB),	mlib_ImageSConv3x3(3MLIB),
       mlib_ImageSConv5x5(3MLIB), mlib_ImageSConv5x5_Fp(3MLIB), mlib_ImageSConv7x7(3MLIB), mlib_ImageSConv7x7_Fp(3MLIB), mlib_ImageSConvKernelCon-
       vert(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					      mlib_ImageSConv3x3_Fp(3MLIB)