diff options
Diffstat (limited to 'man/xpmcreatexpmimage.man')
| -rw-r--r-- | man/xpmcreatexpmimage.man | 66 |
1 files changed, 28 insertions, 38 deletions
diff --git a/man/xpmcreatexpmimage.man b/man/xpmcreatexpmimage.man index 2429273..305ea13 100644 --- a/man/xpmcreatexpmimage.man +++ b/man/xpmcreatexpmimage.man @@ -22,54 +22,44 @@ .\" other dealing in this Software without prior written authorization .\" from the X Consortium. .\" - +.hw XImage .TH XpmCreateXpmImage __libmansuffix__ __xorgversion__ "libXpm functions" .SH NAME XpmCreateXpmImage \- create an Xpm image .SH SYNOPSIS -.HP -int XpmCreateXpmImageFromData(data, image, info) - char **data; - XpmImage*image; - XpmInfo*info; .HP -int XpmCreateXpmImageFromBuffer(buffer, image, info) -char *buffer; -XpmImage*image; -XpmInfo*info; - +int XpmCreateXpmImageFromData( char **data, XpmImage *image, XpmInfo*info ); .HP -int XpmCreateXpmImageFromImage(display, image, shapeimage, xpmimage, attributes) - Display *display; - XImage*image; - XImage*shapeimage; - XpmImage*xpmimage - XpmAttributes *attributes; - +int XpmCreateXpmImageFromBuffer( char *buffer, XpmImage *image, XpmInfo *info ); .HP -int XpmCreateXpmImageFromPixmap(display, pixmap, shapemask, xpmimage, attributes) - Display *display; - Pixmap*pixmap; - Pixmap*shapemask; - XpmImage*xpmimage; - XpmAttributes *attributes; +int XpmCreateXpmImageFromImage( Display *display, XImage *image, XImage *shapeimage, XpmImage *xpmimage, XpmAttributes *attributes; +.HP +int XpmCreateXpmImageFromPixmap( Display *display, Pixmap *pixmap, Pixmap *shapemask, XpmImage *xpmimage, XpmAttributes *attributes ); .SH ARGUMENTS -.nf -data Specifies the location of the data. -image Specifies the image structure location. -info Specifies the location of an XpmInfo structure to get and store information (or NULL). -display Specifies the connection to the X server. -image Specifies the image which is created. -shapeimage Specifies the shape mask image which is created if any. -xpmimage Specifies the location of an XpmImage structure. -attributes Specifies the location of a structure containing information (or NULL). -.fi + +.IP \fIdata\fP li +Specifies the location of the data. +.IP \fIimage\fP li +Specifies the image structure location. +.IP \fIinfo\fP li +Specifies the location of an XpmInfo structure to get and store information (or NULL). +.IP \fIdisplay\fP li +Specifies the connection to the X server. +.IP \fIimage\fP li +Specifies the image which is created. +.IP \fIshapeimage\fP li +Specifies the shape mask image which is created if any. +.IP \fIxpmimage\fP li +Specifies the location of an XpmImage structure. +.IP \fIattributes\fP li +Specifies the location of a structure containing information (or NULL). + .SH DESCRIPTION .SS XpmCreateXpmImageFromBuffer -To create an XpmImage from an XPM buffer, use XpmCreateXpmImageFromBuffer.a -The XpmCreateXpmImageFromBuffer reads the given buffer to fill in the given XpmImage structure. +To create an XpmImage from an XPM buffer, use XpmCreateXpmImageFromBuffer. +The XpmCreateXpmImageFromBuffer reads the given buffer to fill in the given XpmImage structure. If the buffer does not contain valid XPM data, it returns XpmFileInvalid. If insufficient working storage is allocated, it returns XpmNoMemory, and returns XpmSuccess on success. If the passed XpmInfo structure pointer is not NULL, XpmCreateXpmImageFromBuffer looks for the following attributes: @@ -85,8 +75,8 @@ at least zero, otherwise unpredictable errors can occur. .SS XpmCreateXpmImageFromData To create an XpmImage from an XPM data, use XpmCreateXpmImageFromData. XpmCreateXpmImageFromData fills in the given XpmImage structure from the given data. If the data does not -contain validXPM data, it returnsXpmFileInvalid. If insufficient working storage is allocated, it returnsXpm- -NoMemory, on success it returns XpmSuccess. +contain validXPM data, it returnsXpmFileInvalid. If insufficient working storage is allocated, it returns +XpmNoMemory, on success it returns XpmSuccess. If the passed XpmInfo structure pointer is not NULL, XpmCreateXpmImageFromData looks for the following attributes: XpmReturnExtensions, and sets possibly the XpmHotspot attribute when returning. As specified in the table (page 28), if the data related to the attribute |