opensolaris man page for mlib_imagecopysubimage

mlib_ImageCopySubimage(3MLIB)				    mediaLib Library Functions				     mlib_ImageCopySubimage(3MLIB)

NAME
       mlib_ImageCopySubimage - copy subimage

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

       mlib_status mlib_ImageCopySubimage(mlib_image *dst, const mlib_image *src,
	    mlib_s32 xd, mlib_s32 yd, mlib_s32 xs, mlib_s32 ys, mlib_s32 w,
	    mlib_s32 h);

DESCRIPTION
       The  mlib_ImageCopySubimage()  function	copies	a specified rectangular area from one image to a specified area of another image. The data
       type of the images can be MLIB_BIT, MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, MLIB_INT, MLIB_FLOAT, or MLIB_DOUBLE.

       It uses the following equation:

	 dst[xd+i][yd+j][i] = src[xs+i][ys+j][i]

       where i = 0, 1, ..., w-1; j = 0, 1, ..., h-1.

PARAMETERS
       The function takes the following arguments:

       dst    Pointer to destination image.

       src    Pointer to source image.

       xd     X coordinate of the area origin in the destination.

       yd     Y coordinate of the area origin in the destination.

       xs     X coordinate of the area origin in the source.

       ys     Y coordinate of the area origin in the source.

       w      Width of the area to be copied.

       h      Height of the area to be copied.

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_ImageCopy(3MLIB), mlib_ImageCopyArea(3MLIB), mlib_ImageCopyMask(3MLIB), mlib_ImageCopyMask_Fp(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					     mlib_ImageCopySubimage(3MLIB)