'\" te .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved .TH mlib_ImageSetFormat 3MLIB "2 Mar 2007" "SunOS 5.11" "mediaLib Library Functions" .SH NAME mlib_ImageSetFormat \- set format .SH SYNOPSIS .LP .nf cc [ \fIflag\fR... ] \fIfile\fR... \fB-lmlib\fR [ \fIlibrary\fR... ] #include \fBmlib_status\fR \fBmlib_ImageSetFormat\fR(\fBmlib_image *\fR\fIimg\fR, \fBmlib_format\fR \fIformat\fR); .fi .SH DESCRIPTION .sp .LP The \fBmlib_ImageSetFormat()\fR function sets a new value for the \fBformat\fR field of a \fBmlib_image\fR structure. .sp .LP The data type of the image can be \fBMLIB_BIT\fR, \fBMLIB_BYTE\fR, \fBMLIB_SHORT\fR, \fBMLIB_USHORT\fR, \fBMLIB_INT\fR, \fBMLIB_FLOAT\fR, or \fBMLIB_DOUBLE\fR. .SH PARAMETERS .sp .LP The function takes the following arguments: .sp .ne 2 .mk .na \fB\fIimg\fR\fR .ad .RS 10n .rt Pointer to a mediaLib image structure. .RE .sp .ne 2 .mk .na \fB\fIformat\fR\fR .ad .RS 10n .rt Image pixel format. It can be one of the following: .sp .in +2 .nf 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 .fi .in -2 .RE .SH RETURN VALUES .sp .LP The function returns \fBMLIB_SUCCESS\fR if successful. Otherwise it returns \fBMLIB_FAILURE\fR. .SH ATTRIBUTES .sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp .TS tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPEATTRIBUTE VALUE _ Interface StabilityCommitted _ MT-LevelMT-Safe .TE .SH SEE ALSO .sp .LP \fBmlib_ImageGetFormat\fR(3MLIB), \fBmlib_ImageCreate\fR(3MLIB), \fBmlib_ImageCreateStruct\fR(3MLIB), \fBmlib_ImageCreateSubimage\fR(3MLIB), \fBattributes\fR(5)