summaryrefslogtreecommitdiff
path: root/man/xpmcreatepixmap.man
diff options
context:
space:
mode:
Diffstat (limited to 'man/xpmcreatepixmap.man')
-rw-r--r--man/xpmcreatepixmap.man59
1 files changed, 23 insertions, 36 deletions
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