man pages section 3: Multimedia Library Functions

Exit Print View

Updated: July 2014
 
 

mlib_ImageCopyArea (3MLIB)

Name

mlib_ImageCopyArea - copy an area

Synopsis

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

mlib_status mlib_ImageCopyArea(mlib_image *img, mlib_s32 x, mlib_s32 y,
     mlib_s32 w, mlib_s32 h, mlib_s32 dx, mlib_s32 dy);

Description

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

It uses the following equation:

img[x+dx+i][y+dy+j][i] = img[x+i][y+j][i]

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

Parameters

The function takes the following arguments:

img

Pointer to source image.

x

X coordinate of the area origin in the source.

y

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.

dx

Horizontal displacement in pixels of the area to be copied.

dy

Vertical displacement in pixels 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_ImageCopyMask(3MLIB), mlib_ImageCopyMask_Fp(3MLIB), mlib_ImageCopySubimage(3MLIB), attributes(5)