diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/xpmcreatebuffer.man | 44 | ||||
| -rw-r--r-- | man/xpmcreatedata.man | 48 | ||||
| -rw-r--r-- | man/xpmcreateimage.man | 47 | ||||
| -rw-r--r-- | man/xpmcreatepixmap.man | 59 | ||||
| -rw-r--r-- | man/xpmcreatexpmimage.man | 66 | ||||
| -rw-r--r-- | man/xpmmisc.man | 59 | ||||
| -rw-r--r-- | man/xpmread.man | 65 | ||||
| -rw-r--r-- | man/xpmwrite.man | 73 |
8 files changed, 187 insertions, 274 deletions
diff --git a/man/xpmcreatebuffer.man b/man/xpmcreatebuffer.man index 3901870..ce9ce6b 100644 --- a/man/xpmcreatebuffer.man +++ b/man/xpmcreatebuffer.man @@ -22,43 +22,33 @@ .\" other dealing in this Software without prior written authorization .\" from the X Consortium. .\" - +.hw XImage .TH XpmCreateBuffer __libmansuffix__ __xorgversion__ "libXpm functions" .SH NAME XpmCreateBuffer \- create an Xpm-Buffer .SH SYNOPSIS .HP -int XpmCreateBufferFromImage(display, buffer_return, image, shapeimage, attributes) - Display *display; - char **buffer_return; - XImage*image; - XImage*shapeimage; - XpmAttributes *attributes; - +int XpmCreateBufferFromImage( Display *display, char **buffer_return, XImage *image, XImage *shapeimage, XpmAttributes *attributes ); .HP -int XpmCreateBufferFromPixmap(display, buffer_return, pixmap, shapemask, attributes) -Display *display; -char **buffer_return; -Pixmappixmap; -Pixmapshapemask; -XpmAttributes *attributes; - +int XpmCreateBufferFromPixmap( Display *display, char **buffer_return, Pixmap pixmap, Pixmap shapemask, XpmAttributes *attributes ); .HP -int XpmCreateBufferFromXpmImage(buffer_return, image, info) -char **buffer_return; -XpmImage*image; -XpmInfo*info; +int XpmCreateBufferFromXpmImage( char **buffer_return, XpmImage *image, XpmInfo *info ); .SH ARGUMENTS -.nf -display Specifies the connection to the X server. -buffer_return Returns the buffer which is created. -image Specifies the image. -shapeimage Specifies the shape mask image. -attributes Specifies the location of a structure containing information (or NULL). -info Specifies the location of a structure to get possible information (or NULL). -.fi + +.IP \fIdisplay\fP li +Specifies the connection to the X server. +.IP \fIbuffer_return\fP li +Returns the buffer which is created. +.IP \fIimage\fP li +Specifies the image. +.IP \fIshapeimage\fP li +Specifies the shape mask image. +.IP \fIattributes\fP li +Specifies the location of a structure containing information (or NULL). +.IP \fIinfo\fP li +Specifies the location of a structure to get possible information (or NULL). .SH DESCRIPTION diff --git a/man/xpmcreatedata.man b/man/xpmcreatedata.man index a59f528..91cd7df 100644 --- a/man/xpmcreatedata.man +++ b/man/xpmcreatedata.man @@ -22,45 +22,35 @@ .\" other dealing in this Software without prior written authorization .\" from the X Consortium. .\" - +.hw XImage .TH XpmCreateData __libmansuffix__ __xorgversion__ "libXpm functions" .SH NAME XpmCreateData \- create an Data structure .SH SYNOPSIS .HP -int XpmCreateDataFromImage(display, data_return, image, shapeimage, attributes) - Display *display; - char ***data_return; - XImage*image; - XImage*shapeimage; - XpmAttributes *attributes; - +int XpmCreateDataFromImage( Display *display, char ***data_return, XImage *image, XImage *shapeimage, XpmAttributes *attributes ); .HP -int XpmCreateDataFromPixmap(display, data_return, pixmap, shapemask, attributes) - Display *display; - char ***data_return; - Pixmappixmap; - Pixmapshapemask; - XpmAttributes *attributes; - +int XpmCreateDataFromPixmap( Display *display, char ***data_return, Pixmap pixmap, Pixmap shapemask, XpmAttributes *attributes ); .HP -int XpmCreateDataFromXpmImage(data_return, image, info) -char ***data_return; -XxpmImage*image; -XpmInfo*info; - +int XpmCreateDataFromXpmImage( char ***data_return, XpmImage *image, XpmInfo *info); .SH ARGUMENTS -.nf -display Specifies the connection to the X server. -data_return Returns the data which is created. -pixmap Specifies the pixmap. -shapemask Specifies the shape mask pixmap. -attributes Specifies the location of a structure containing information (or NULL). -info Specifies the location of a structure to get information. -image Specifies the image -.fi + +.IP \fIdisplay\fP li +Specifies the connection to the X server. +.IP \fIdata_return\fP li +Returns the data which is created. +.IP \fIpixmap\fP li +Specifies the pixmap. +.IP \fIshapemask\fP li +Specifies the shape mask pixmap. +.IP \fIattributes\fP li +Specifies the location of a structure containing information (or NULL). +.IP \fIinfo\fP li +Specifies the location of a structure to get information. +.IP \fIimage\fP li +Specifies the image .SH DESCRIPTION .SS XpmCreateDataFromImage diff --git a/man/xpmcreateimage.man b/man/xpmcreateimage.man index 348aa24..a25027b 100644 --- a/man/xpmcreateimage.man +++ b/man/xpmcreateimage.man @@ -22,43 +22,32 @@ .\" other dealing in this Software without prior written authorization .\" from the X Consortium. .\" - +.hw XImage .TH XpmCreateImage __libmansuffix__ __xorgversion__ "libXpm functions" .SH NAME XpmCreateImage \- create an Xpm-image .SH SYNOPSIS .HP -int XpmCreateImageFromData(display, data, image_return, shapeimage_return, attributes) -Display *display; -char **data; -XImage**image_return; -XImage**shapeimage_return; -XpmAttributes *attributes; - +int XpmCreateImageFromData( Display *display, char **data, XImage **image_return, XImage **shapeimage_return, XpmAttributes *attributes ); .HP -int XpmCreateImageFromBuffer(display, buffer, image_return, shapeimage_return, attributes) - Display *display; - char *buffer; - XImage**image_return; - XImage**shapeimage_return; - XpmAttributes *attributes; +int XpmCreateImageFromBuffer( Display *display, char *buffer, XImage **image_return, XImage **shapeimage_return, XpmAttributes *attributes ); .HP -int XpmCreateImageFromXpmImage(display, image, image_return, shapeimage_return, attributes) - Display *display; - XpmImage*image; - XImage*image_return; - XImage*shapeimage_return; - XpmAttributes *attributes; +int XpmCreateImageFromXpmImage( Display *display, XpmImage *image, XImage *image_return, XImage *shapeimage_return, XpmAttributes *attributes; .SH ARGUMENTS -.nf -display Specifies the connection to the X server. -data Specifies the location of the data. -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). -shapeimage Specifies the shape mask image which is created if any. -.fi + +.IP \fIdisplay\fP li +Specifies the connection to the X server. +.IP \fIdata\fP li +Specifies the location of the data. +.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 \fIshapeimage\fP li +Specifies the shape mask image which is created if any. .SH DESCRIPTION @@ -81,7 +70,7 @@ to deal with compressed files is not available here. .SS XpmCreateImageFromXpmImage To create an XImage from an XpmImage, use XpmCreateImageFromXpmImage. -From the givenXpmImage andXpmAttributes if notNULL, XpmCreateImageFromXpmImage allocates colors +From the given XpmImage and XpmAttributes if not NULL, XpmCreateImageFromXpmImage allocates colors and creates X images following the same mechanism as XpmReadFileToImage(). When finished the caller must free the images using XDestroyImage, the colors using XFreeColors, and possibly the diff --git a/man/xpmcreatepixmap.man b/man/xpmcreatepixmap.man index db8acd2..e834dae 100644 --- a/man/xpmcreatepixmap.man +++ b/man/xpmcreatepixmap.man @@ -22,59 +22,46 @@ .\" other dealing in this Software without prior written authorization .\" from the X Consortium. .\" - +.hw XImage .TH XpmCreatePixmap __libmansuffix__ __xorgversion__ "libXpm functions" .SH NAME XpmCreatePixmap \- create a pixmap .SH SYNOPSIS .HP -int XpmCreatePixmapFromData(display, d, data, pixmap_return, shapemask_return, attributes) - Display *display; - Drawable d; - char **data; - Pixmap*pixmap_return; - Pixmap*shapemask_return; - XpmAttributes *attributes; +int XpmCreatePixmapFromData( Display *display, Drawable d, char **data, Pixmap *pixmap_return, Pixmap *shapemask_return, XpmAttributes *attributes ); .HP -int XpmCreatePixmapFromBuffer(display, d, buffer, pixmap_return, shapemask_return, attributes) - Display *display; - Drawable d; - char *buffer; - Pixmap*pixmap_return; - Pixmap*shapemask_return; - XpmAttributes *attributes; - +int XpmCreatePixmapFromBuffer( Display *display, Drawable d, char *buffer, Pixmap *pixmap_return, Pixmap *shapemask_return, XpmAttributes *attributes; .HP -int XpmCreatePixmapFromXpmImage(display, d, image, pixmap_return, shapemask_return, attributes) - Display *display; - Drawable d; - XpmImage*image; - Pixmap*pixmap_return; - Pixmap*shapemask_return; - XpmAttributes *attributes; - +int XpmCreatePixmapFromXpmImage( Display *display, Drawable d, XpmImage *image, Pixmap *pixmap_return, Pixmap *shapemask_return, XpmAttributes *attributes; .SH ARGUMENTS -.nf -display Specifies the connection to the X server. -d Specifies which screen the pixmap is created on. -buffer Specifies the location of the buffer. -pixmap_return Returns the pixmap which is created if the color None. -shapemask_return Returns the shape mask pixmap which is created if the color None is used. -attributes Specifies the location of a structure to get and store information. -image Specifies the XpmImage. -.fi + +.IP \fIdisplay\fP li +Specifies the connection to the X server. +.IP \fId\fP li +Specifies which screen the pixmap is created on. +.IP \fIbuffer\fP li +Specifies the location of the buffer. +.IP \fIpixmap_return\fP li +Returns the pixmap which is created if the color None. +.IP \fIshapemask_return\fP li +Returns the shape mask pixmap which is created if the color None is used. +.IP \fIattributes\fP li +Specifies the location of a structure to get and store information. +.IP \fIimage\fP li +Specifies the XpmImage. + .SH DESCRIPTION .SS XpmCreatePixmapFromData To create a Pixmap from an XPM data, use XpmCreatePixmapFromData. -The XpmCreatePixmapFromData function creates X images usingXpmCreateImageFromData() and -thus returns the same errors. In addition on success it then creates the related pixmaps, usingXPutImage, +The XpmCreatePixmapFromData function creates X images using XpmCreateImageFromData() and +thus returns the same errors. In addition on success it then creates the related pixmaps, using XPutImage, which are returned to pixmap_return and shapemask_return if not NULL, and finally destroys the created images using XDestroyImage. Do not forget to free the returned pixmaps, the colors, and possibly the data returned into the XpmAttributes structure when done. .SS XpmCreatePixmapFromBuffer To create a Pixmap from an XPM buffer, use XpmCreatePixmapFromBuffer. -The XpmCreatePixmapFromBuffer function works the same way asXpmReadFileToPixmap (), +The XpmCreatePixmapFromBuffer function works the same way as XpmReadFileToPixmap (), it just calls XpmCreateImageFromBuffer instead of XpmReadFileToImage. .SS XpmCreatePixmapFromXpmImage 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 diff --git a/man/xpmmisc.man b/man/xpmmisc.man index 7e1cbc5..ee8b37b 100644 --- a/man/xpmmisc.man +++ b/man/xpmmisc.man @@ -22,57 +22,50 @@ .\" other dealing in this Software without prior written authorization .\" from the X Consortium. .\" - +.hw XImage .TH xpmmisc __libmansuffix__ __xorgversion__ "libXpm functions" .SH NAME Xpmmisc \- xpm misc functions to free used memory and handle errors .SH SYNOPSIS .HP -int XpmFreeXpmImage(image) -XpmImage*image; - +int XpmFreeXpmImage( XpmImage *image ); .HP -int XpmFreeXpmInfo(ainfo) -XpmInfo *info; - +int XpmFreeXpmInfo( XpmInfo *info ); .HP -int XpmFreeAttributes(attributes) - XpmAttributes *attributes; - +int XpmFreeAttributes( XpmAttributes *attributes ); .HP int XpmAttributesSize() - .HP -int XpmFreeExtensions(extensions, nextensions) - XpmExtension *extensions; - int nextensions; - +int XpmFreeExtensions( XpmExtension *extensions, int nextensions ); .HP -int XpmFree(ptr) -char *ptr; - +int XpmFree( char *ptr ); .HP -char *XpmGetErrorString(errorcode) -int errorcode; +char *XpmGetErrorString( int errorcode ); .HP int XpmLibraryVersion() .SH ARGUMENTS -.nf -image Specifies the structure to free -info Specifies the structure to free -ptr Specifies the data to free. -errorcode Specifies the XPM error. -extensions Specifies the array to free. -nextensions Specifies the number of extensions. -attributes Specifies the structure to free -.fi + +.IP \fIimage\fP li +Specifies the structure to free +.IP \fIinfo\fP li +Specifies the structure to free +.IP \fIptr\fP li +Specifies the data to free +.IP \fIerrorcode\fP li +Specifies the XPM error +.IP \fIextensions\fP li +Specifies the array to free +.IP \fInextensions\fP li +Specifies the number of extensions +.IP \fIattributes\fP li +Specifies the structure to free + .SH DESCRIPTION To free possible data stored into an XpmImage structure use XpmFreeXpmImage. - -TheXpmFreeXpmImagefrees the structure members which are not NULL, but not the structure itself. +The XpmFreeXpmImagefrees the structure members which are not NULL, but not the structure itself. To free possible data stored into an XpmInfo structure use XpmFreeXpmInfo. To free data possibly stored into an array of XpmExtension use XpmFreeExtensions. @@ -101,8 +94,8 @@ in the header file "xpm.h". These numbers are computed with the following formul Where XpmFormat is the version number of the format, XpmVersion is the library version number (which changes only if the API changes), and XpmRevision is the library minor version number. -This function frees all data stored in every extension and the array itself. Note that -XpmFreeAttributes call this function and thus most of the time it should not need to be explicitly called. +The XpmFreeExtensions function frees all data stored in every extension and the array itself. +Note that XpmFreeAttributes call this function and thus most of the time it should not need to be explicitly called. .SH "SEE ALSO" .BR XpmLibraryVersion(__libmansuffix__) , 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: diff --git a/man/xpmwrite.man b/man/xpmwrite.man index 2bd2994..f40d8c7 100644 --- a/man/xpmwrite.man +++ b/man/xpmwrite.man @@ -22,57 +22,43 @@ .\" other dealing in this Software without prior written authorization .\" from the X Consortium. .\" - +.hw XImage .TH XpmWrite __libmansuffix__ __xorgversion__ "libXpm functions" .SH NAME XpmWrite \- write an XPM file .SH SYNOPSIS .HP -int XpmWriteFileFromPixmap(display, filename, pixmap, shapemask, attributes) - Display *display; - char *filename; - Pixmap pixmap; - Pixmap shapemask; - XpmAttributes *attributes; - +int XpmWriteFileFromPixmap( Display *display, char *filename, Pixmap pixmap, Pixmap shapemask, XpmAttributes *attributes ); .HP -int XpmWriteFileFromImage(display, filename, image, shapeimage, attributes) - Display *display; - char *filename; - XImage*image; - XImage*shapeimage; - XpmAttributes *attributes; - +int XpmWriteFileFromImage( Display *display, char *filename, XImage *image, XImage *shapeimage, XpmAttributes *attributes ); .HP -int XpmWriteFileFromData(filename, data) - char *filename; - char **data; - +int XpmWriteFileFromData( char *filename, char **data ); .HP -int XpmWriteFileFromXpmImage(filename, image, shapeimage, info) - char *filename; - XpmImage*image; - XImage*shapeimage; - XpmInfo *info; - +int XpmWriteFileFromXpmImage( char *filename, XpmImage *image, XImage *shapeimage, XpmInfo *info ); .HP -int XpmWriteFileFromBuffer(filename, data) - char *filename; - char *buffer; +int XpmWriteFileFromBuffer( char *filename, char *buffer ); .SH ARGUMENTS -.nf -display Specifies the connection to the X server. -filename Specifies the file name to use. -pixmap Specifies the pixmap. -shapemask Specifies the shape mask pixmap. -attributes Specifies the location of a structure containing information (or NULL). -data Specifies the data array to read. -image Specifies the image. -info Specifies the location of a structure to get information from (or NULL). -buffer Specifies the buffer to read. -.fi + +.IP \fIdisplay\fP li +Specifies the connection to the X server. +.IP \fIfilename\fP li +Specifies the file name to use. +.IP \fIpixmap\fP li +Specifies the pixmap. +.IP \fIshapemask\fP li +Specifies the shape mask pixmap. +.IP \fIattributes\fP li +Specifies the location of a structure containing information (or NULL). +.IP \fIdata\fP li +Specifies the data array to read. +.IP \fIimage\fP li +Specifies the image. +.IP \fIinfo\fP li +Specifies the location of a structure to get information from (or NULL). +.IP \fIbuffer\fP li +Specifies the buffer to read. .SH DESCRIPTION .SS XpmWriteFileFromImage @@ -104,7 +90,7 @@ XpmWriteFileFromPixmap looks for the following atributes: XpmSize. If they are not defined it performs an XGetGeometry operation. Then it uses XGetImage to get from the given pixmaps the related X images which are passed to XpmWriteFileFromImage. Finally XpmWriteFileFromPixmap destroys the created images using XDestroyImage. -The XpmWriteFileFromPixmapfunction returns the same errors as XpmWriteFileFromImage. +The XpmWriteFileFromPixmap function returns the same errors as XpmWriteFileFromImage. .SS XpmWriteFileFromData XpmWriteFileFromData writes an XPM data array to an XPM file. @@ -114,8 +100,9 @@ XpmFileInvalid if this is not a valid XPM data, and XpmSuccess otherwise. .SS XpmWriteFileFromXpmImage To write out an XpmImage to an XPM file, use XpmWriteFileFromXpmImage. -The XpmWriteFileFromXpmImage function writes an image out to a file in theXPM format. If the file cannot be -opened, it returns XpmOpenFailed. If insufficient working storage is allocated, it returns XpmNoMemory. +The XpmWriteFileFromXpmImage function writes an image out to a file in the XPM format. +If the file cannot be opened, it returns XpmOpenFailed. +If insufficient working storage is allocated, it returns XpmNoMemory. If no error occurs then it returns XpmSuccess. If the passed XpmInfo structure pointer is not NULL, XpmWriteFileFromXpmImage looks for the following attributes: XpmComments, XpmExtensions, and XpmHotspot, and writes the related information out as well. @@ -130,7 +117,7 @@ XpmWriteFileFromBuffer returns XpmOpenFailed if it cannot open the file, and Xpm As a convenience, the XpmReadFileToBuffer and XpmWriteFileFromBuffer are provided to copy a file to a buffer and to write a file from a buffer. Thus for instance one may decide to use XpmReadFileToBuffer, XpmCreatePixmapFromBuffer, and XpmFree -instead ofXpmReadFileToPixmap. On some systems this may lead to a performance improvement, +instead of XpmReadFileToPixmap. On some systems this may lead to a performance improvement, since the parsing will be performed in memory, but it uses more memory. .SH "SEE ALSO" |