mlib_ImageResetSubimageStruct(3MLIB) mediaLib Library Functions mlib_ImageResetSubimageStruct(3MLIB)
NAME
mlib_ImageResetSubimageStruct - reset sub-image data structure
SYNOPSIS
cc [ flag... ] file... -lmlib [ library... ]
#include <mlib.h>
mlib_status mlib_ImageResetSubimageStruct(mlib_image *subimg,
const mlib_image *img, mlib_s32 x, mlib_s32 y,
mlib_s32 w, mlib_s32 h);
DESCRIPTION
The mlib_ImageResetSubimageStruct() function resets a sub-image's data structure using parameters supplied by the user.
The mlib_ImageResetSubimageStruct() function returns MLIB_FAILURE if the supplied parameters do not pass the following sanity checks:
o subimg != NULL
o img != NULL
o 0 < w <= mlib_ImageGetWidth(img)
o 0 < h <= mlib_ImageGetHeight(img)
o 0 <= x <= (mlib_ImageGetWidth(img) - w)
o 0 <= y <= (mlib_ImageGetHeight(img) - h)
Whenever MLIB_FAILURE is returned, the original image data structure is not changed.
If mlib_ImageIsUserAllocated(subimg)==0, the original data buffer is freed, otherwise the original data buffer is not freed.
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 reset successfully. MLIB_FAILURE is returned when the image data structure can not
be reset according to the parameters supplied.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
+-----------------------------+-----------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+-----------------------------+-----------------------------+
|Interface Stability |Committed |
+-----------------------------+-----------------------------+
|MT-Level |MT-Safe |
+-----------------------------+-----------------------------+
SEE ALSO
mlib_ImageCreate(3MLIB), mlib_ImageCreateSubimage(3MLIB), mlib_ImageCreateStruct(3MLIB), mlib_ImageSetStruct(3MLIB), mlib_ImageReset-
Struct(3MLIB), mlib_ImageSetSubimageStruct(3MLIB), mlib_ImageDelete(3MLIB), mlib_ImageSetFormat(3MLIB), mlib_ImageSetPaddings(3MLIB),
attributes(5)
SunOS 5.11 10 Sep 2007 mlib_ImageResetSubimageStruct(3MLIB)