Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

(opensolaris section 3mlib)
man page for mlib_imageresetstruct

mlib_ImageResetStruct(3MLIB)				    mediaLib Library Functions				      mlib_ImageResetStruct(3MLIB)

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); DESCRIPTION
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. PARAMETERS
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. 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_ImageDelete(3MLIB), mlib_ImageSetFormat(3MLIB), mlib_ImageSetPaddings(3MLIB), attributes(5) SunOS 5.11 2 Mar 2007 mlib_ImageResetStruct(3MLIB)

Featured Tech Videos