mlib_ImageSetFormat(3MLIB)mediaLib Library Functionsmlib_ImageSetFormat(3MLIB)NAMEmlib_ImageSetFormat - set format
SYNOPSIS
cc [ flag... ] file... -lmlib [ library... ]
#include <mlib.h>
mlib_status mlib_ImageSetFormat(mlib_image *img, mlib_format format);
DESCRIPTION
The mlib_ImageSetFormat() function sets a new value for the format
field of a mlib_image structure.
The data type of the image can be MLIB_BIT, MLIB_BYTE, MLIB_SHORT,
MLIB_USHORT, MLIB_INT, MLIB_FLOAT, or MLIB_DOUBLE.
PARAMETERS
The function takes the following arguments:
img Pointer to a mediaLib image structure.
format Image pixel format. It can be one of the following:
MLIB_FORMAT_UNKNOWN
MLIB_FORMAT_INDEXED
MLIB_FORMAT_GRAYSCALE
MLIB_FORMAT_RGB
MLIB_FORMAT_BGR
MLIB_FORMAT_ARGB
MLIB_FORMAT_ABGR
MLIB_FORMAT_PACKED_ARGB
MLIB_FORMAT_PACKED_ABGR
MLIB_FORMAT_GRAYSCALE_ALPHA
MLIB_FORMAT_RGBA
RETURN VALUES
The function returns MLIB_SUCCESS if successful. Otherwise it returns
MLIB_FAILURE.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌─────────────────────────────┬─────────────────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├─────────────────────────────┼─────────────────────────────┤
│Interface Stability │Committed │
├─────────────────────────────┼─────────────────────────────┤
│MT-Level │MT-Safe │
└─────────────────────────────┴─────────────────────────────┘
SEE ALSOmlib_ImageGetFormat(3MLIB), mlib_ImageCreate(3MLIB), mlib_ImageCreat‐
eStruct(3MLIB), mlib_ImageCreateSubimage(3MLIB), attributes(5)SunOS 5.11 2 Mar 2007 mlib_ImageSetFormat(3MLIB)