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:

• image should not be NULL

• type should be MLIB_BIT, MLIB_BYTE, MLIB_SHORT, MLIB_USHORT, MLIB_INT, MLIB_FLOAT, or MLIB_DOUBLE

• channels should be between 1 and 4

• width should be greater than 0

• height should be greater than 0

• 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:

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)