mlib_imagesetsubimagestruct(3mlib) [opensolaris man page]
mlib_ImageSetSubimageStruct(3MLIB) mediaLib Library Functions mlib_ImageSetSubimageStruct(3MLIB)NAME
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:
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.
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:
+-----------------------------+-----------------------------+
| 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_ImageResetSubimageStruct(3MLIB), mlib_ImageDelete(3MLIB), mlib_ImageSetFormat(3MLIB), mlib_ImageSetPaddings(3MLIB),
attributes(5)SunOS 5.11 10 Sep 2007 mlib_ImageSetSubimageStruct(3MLIB)
Check Out this Related Man Page
mlib_ImageResetStruct(3MLIB)mlib_ImageResetStruct(3MLIB)NAME
mlib_ImageResetStruct - reset image data structure
SYNOPSIS
cc [ flag... ] file... -lmlib [ library... ]
#include <mlib.h>
mlib_status mlib_ImageResetStruct(mlib_image *image, mlib_type type, mlib_s32 channels, mlib_s32 width, mlib_s32 height, mlib_s32 stride,
const void *datbuf);
The mlib_ImageResetStruct() function resets a mediaLib image data structure using parameters supplied by the user.
The mlib_ImageResetStruct() function returns MLIB_FAILURE if the supplied parameters do not pass the following sanity checks:
o image should not be NULL
o type should be MLIB_BIT, MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, MLIB_INT, MLIB_FLOAT, or MLIB_DOUBLE
o channels should be between 1 and 4
o width should be greater than 0
o height should be greater than 0
o stride should be no less than width * channels * (size of type in bytes)
Whenever MLIB_FAILURE is returned, the original image data structure is not changed.
When datbuf is NULL, the original data buffer is reused. If mlib_ImageIsUserAllocated(image)==0, such as the case the image data structure
was created by mlib_ImageCreate(), and the data buffer size required by the parameters supplied is larger than the original, MLIB_FAILURE
is returned.
When datbuf is not NULL, if mlib_ImageIsUserAllocated(image)==0, the original data buffer is freed, otherwise the original data buffer is
not freed. If datbuf points to the original data buffer, it is not freed.
The function takes the following arguments:
image Pointer to the image data structure.
type Image data type. It can be MLIB_BIT, MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, MLIB_INT, MLIB_FLOAT, or MLIB_DOUBLE.
channels Number of channels in the image.
width Width of image in pixels.
height Height of image in pixels.
stride Stride of each row of the data space in bytes.
datbuf Pointer to the image data buffer.
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.
See attributes(5) for descriptions of the following attributes:
+-----------------------------+-----------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+-----------------------------+-----------------------------+
|Interface Stability |Evolving |
+-----------------------------+-----------------------------+
|MT-Level |MT-Safe |
+-----------------------------+-----------------------------+
mlib_ImageCreate(3MLIB), mlib_ImageCreateSubimage(3MLIB), mlib_ImageCreateStruct(3MLIB), mlib_ImageSetStruct(3MLIB),
mlib_ImageDelete(3MLIB), mlib_ImageSetFormat(3MLIB), mlib_ImageSetPaddings(3MLIB), attributes(5)
1 Mar 2005 mlib_ImageResetStruct(3MLIB)