mlib_ImageSetSubimageStruct

- set sub-image data structure

Synopsis

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

mlib_status mlib_ImageSetSubimageStruct(mlib_image *subimg,
     const mlib_image *img, mlib_s32 x, mlib_s32 y, 
     mlib_s32 w, mlib_s32 h);

Description

The mlib_ImageSetSubimageStruct() function sets a sub-image's data structure using parameters supplied by the user.

The mlib_ImageSetSubimageStruct() function returns MLIB_FAILURE if the supplied parameters do not pass the following sanity checks:

• subimg != NULL

• img != NULL

• 0 < w ≤ mlib_ImageGetWidth(img)

• 0 < h ≤ mlib_ImageGetHeight(img)

• 0 ≤ x ≤ (mlib_ImageGetWidth(img) - w)

• 0 ≤ y ≤ (mlib_ImageGetHeight(img) - h)

Whenever MLIB_FAILURE is returned, the original image data structure is not changed.

Parameters

The function takes the following arguments:

subimg

Pointer to the sub-image data structure.

img

Pointer to the source image data structure.

x

X coordinate of the left border in the source image.

y

Y coordinate of the top border in the source image.

w

Width of the sub-image.

h

Height of the sub-image.

Return Values

MLIB_SUCCESS is returned if the image data structure is set successfully. MLIB_FAILURE is returned when the image data structure can not be set according to the parameters supplied.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

mlib_ImageCreate(3MLIB), mlib_ImageCreateSubimage(3MLIB), mlib_ImageCreateStruct(3MLIB), mlib_ImageSetStruct(3MLIB), mlib_ImageResetStruct(3MLIB), mlib_ImageResetSubimageStruct(3MLIB), mlib_ImageDelete(3MLIB), mlib_ImageSetFormat(3MLIB), mlib_ImageSetPaddings(3MLIB), attributes(5)