summaryrefslogtreecommitdiffstats
path: root/doc/GetPixmap.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2008-06-30 22:57:00 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2008-06-30 22:57:00 (GMT)
commitd6e7f6b3743e98803d7e8c7debc709c072c6e6a5 (patch)
treed6714c53bb2368a4c8befd4c7dc0085d88b31a15 /doc/GetPixmap.3
parent8ab3b0fffbe37701d924b4da873e6f231a843e5f (diff)
downloadtk-d6e7f6b3743e98803d7e8c7debc709c072c6e6a5.zip
tk-d6e7f6b3743e98803d7e8c7debc709c072c6e6a5.tar.gz
tk-d6e7f6b3743e98803d7e8c7debc709c072c6e6a5.tar.bz2
Minor doc updates (removing out of date changebars, improving typedef formatting,
etc.)
Diffstat (limited to 'doc/GetPixmap.3')
-rw-r--r--doc/GetPixmap.3110
1 files changed, 54 insertions, 56 deletions
diff --git a/doc/GetPixmap.3 b/doc/GetPixmap.3
index a8cb5e1..d851387 100644
--- a/doc/GetPixmap.3
+++ b/doc/GetPixmap.3
@@ -1,56 +1,54 @@
-'\"
-'\" Copyright (c) 1990 The Regents of the University of California.
-'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
-'\"
-'\" See the file "license.terms" for information on usage and redistribution
-'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
-'\"
-'\" RCS: @(#) $Id: GetPixmap.3,v 1.2 1998/09/14 18:22:50 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_GetPixmap 3 4.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_GetPixmap, Tk_FreePixmap \- allocate and free pixmaps
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-Pixmap
-\fBTk_GetPixmap(\fIdisplay, d, width, height, depth\fB)\fR
-.sp
-\fBTk_FreePixmap(\fIdisplay, pixmap\fB)\fR
-.SH ARGUMENTS
-.AS "Drawable" *pixelPtr
-.AP Display *display in
-X display for the pixmap.
-.AP Drawable d in
-Pixmap or window where the new pixmap will be used for drawing.
-.AP "int" width in
-Width of pixmap.
-.AP "int" height in
-Height of pixmap.
-.AP "int" depth in
-Number of bits per pixel in pixmap.
-.AP Pixmap pixmap in
-Pixmap to destroy.
-.BE
-
-.SH DESCRIPTION
-.PP
-These procedures are identical to the Xlib procedures \fBXCreatePixmap\fR
-and \fBXFreePixmap\fR, except that they have extra code to manage X
-resource identifiers so that identifiers for deleted pixmaps can be
-reused in the future.
-It is important for Tk applications to use these procedures rather
-than \fBXCreatePixmap\fR and \fBXFreePixmap\fR; otherwise long-running
-applications may run out of resource identifiers.
-.PP
-\fBTk_GetPixmap\fR creates a pixmap suitable for drawing in \fId\fR,
-with dimensions given by \fIwidth\fR, \fIheight\fR, and \fIdepth\fR,
-and returns its identifier.
-\fBTk_FreePixmap\fR destroys the pixmap given by \fIpixmap\fR and makes
-its resource identifier available for reuse.
-
-.SH KEYWORDS
-pixmap, resource identifier
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: GetPixmap.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_GetPixmap 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_GetPixmap, Tk_FreePixmap \- allocate and free pixmaps
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+Pixmap
+\fBTk_GetPixmap(\fIdisplay, d, width, height, depth\fB)\fR
+.sp
+\fBTk_FreePixmap(\fIdisplay, pixmap\fB)\fR
+.SH ARGUMENTS
+.AS "Drawable" *pixelPtr
+.AP Display *display in
+X display for the pixmap.
+.AP Drawable d in
+Pixmap or window where the new pixmap will be used for drawing.
+.AP "int" width in
+Width of pixmap.
+.AP "int" height in
+Height of pixmap.
+.AP "int" depth in
+Number of bits per pixel in pixmap.
+.AP Pixmap pixmap in
+Pixmap to destroy.
+.BE
+.SH DESCRIPTION
+.PP
+These procedures are identical to the Xlib procedures \fBXCreatePixmap\fR
+and \fBXFreePixmap\fR, except that they have extra code to manage X
+resource identifiers so that identifiers for deleted pixmaps can be
+reused in the future.
+It is important for Tk applications to use these procedures rather
+than \fBXCreatePixmap\fR and \fBXFreePixmap\fR; otherwise long-running
+applications may run out of resource identifiers.
+.PP
+\fBTk_GetPixmap\fR creates a pixmap suitable for drawing in \fId\fR,
+with dimensions given by \fIwidth\fR, \fIheight\fR, and \fIdepth\fR,
+and returns its identifier.
+\fBTk_FreePixmap\fR destroys the pixmap given by \fIpixmap\fR and makes
+its resource identifier available for reuse.
+.SH KEYWORDS
+pixmap, resource identifier