diff options
Diffstat (limited to 'man/xpmread.man')
| -rw-r--r-- | man/xpmread.man | 65 |
1 files changed, 26 insertions, 39 deletions
diff --git a/man/xpmread.man b/man/xpmread.man index 4259eb4..5074d40 100644 --- a/man/xpmread.man +++ b/man/xpmread.man @@ -22,60 +22,47 @@ .\" other dealing in this Software without prior written authorization .\" from the X Consortium. .\" - +.hw XImage .TH XpmRead __libmansuffix__ __xorgversion__ "libXpm functions" .SH NAME XpmRead \- read an XPM file .SH SYNOPSIS .HP -int XpmReadFileToImage(display, filename, image_return, shapeimage_return, attributes) - Display *display; - char *filename; - XImage**image_return; - XImage**shapeimage_return; - XpmAttributes *attributes; +int XpmReadFileToImage( Display *display, char *filename, XImage **image_return, XImage **shapeimage_return, XpmAttributes *attributes ); .HP -int XpmReadFileToPixmap(display, d, filename, pixmap_return, shapemask_return, attributes) - Display *display; - Drawable d; - char *filename; - Pixmap*pixmap_return; - Pixmap*shapemask_return; - XpmAttributes *attributes; +int XpmReadFileToPixmap( Display *display, Drawable d, char *filename, Pixmap *pixmap_return, Pixmap *shapemask_return, XpmAttributes *attributes ); .HP -To create an XpmImage from an XPM file, use XpmReadFileToXpmImage. -int XpmReadFileToXpmImage(filename, image, info) - char *filename; - XpmImage*image; - XpmInfo *info; - +int XpmReadFileToXpmImage( char *filename, XpmImage *image, XpmInfo *info ); .HP -int XpmReadFileToBuffer(filename, buffer_return) - char *filename; - char **buffer_return; +int XpmReadFileToBuffer( char *filename, char **buffer_return ); .HP -int XpmReadFileToData(filename, data_return) - char *filename; - char ***data_return; +int XpmReadFileToData( char *filename, char ***data_return ); .SH ARGUMENTS -.nf - display Specifies the connection to the X server. - filename Specifies the file name to use. - image_return Returns the image which is created. - shapeimage_return Returns the shape mask image which is created if the color None is used. - attributes Specifies the location of a structure to get and store information (or NULL). - buffer_return Returns the buffer created. - data_return Returns the data array created. - image Specifies the image structure location. - info Specifies the location of a structure to store possible information (or NULL). - -.fi +.IP \fIdisplay\fP li +Specifies the connection to the X server. +.IP \fIfilename\fP li +Specifies the file name to use. +.IP \fIimage_return\fP li +Returns the image which is created. +.IP \fIshapeimage_return\fP li +Returns the shape mask image which is created if the color None is used. +.IP \fIattributes\fP li +Specifies the location of a structure to get and store information (or NULL). +.IP \fIbuffer_return\fP li +Returns the buffer created. +.IP \fIdata_return\fP li +Returns the data array created. +.IP \fIimage\fP li +Specifies the image structure location. +.IP \fIinfo\fP li +Specifies the location of a structure to store possible information (or NULL). .SH DESCRIPTION .SS XpmReadFileToImage -The XpmReadFileToImage function reads in a file in the XPM format. If the file cannot be opened it returns XpmOpenFailed. +The XpmReadFileToImage function reads in a file in the XPM format. +If the file cannot be opened it returns XpmOpenFailed. If the file can be opened but does not contain valid XPM data, it returns XpmFileInvalid. If insufficient working storage is allocated, it returns XpmNoMemory. If the passedXpmAttributes structure pointer is not NULL, XpmReadFileToImage looks for the following attributes: |