AllPlanes.man 9.16 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, sublicense, and/or sell copies of the Software, and to
.\" permit persons to whom the Software is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be included
.\" in all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
.\" OTHER DEALINGS IN THE SOFTWARE.
.\"
.\" Except as contained in this notice, the name of the X Consortium shall
.\" not be used in advertising or otherwise to promote the sale, use or
.\" other dealings in this Software without prior written authorization
.\" from the X Consortium.
.\"
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
.\" Digital Equipment Corporation
.\"
.\" Portions Copyright \(co 1990, 1991 by
.\" Tektronix, Inc.
.\"
.\" Permission to use, copy, modify and distribute this documentation for
.\" any purpose and without fee is hereby granted, provided that the above
.\" copyright notice appears in all copies and that both that copyright notice
.\" and this permission notice appear in all copies, and that the names of
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
.\" to this documentation without specific, written prior permission.
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
Walter Harms's avatar
Walter Harms committed
41
.\" It is provided "as is" without express or implied warranty.
42
.\"
Egbert Eich's avatar
Egbert Eich committed
43
.\"
44 45 46 47
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
48
.TH AllPlanes __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
49 50 51
.SH NAME
AllPlanes, BlackPixel, WhitePixel, ConnectionNumber, DefaultColormap, DefaultDepth, XListDepths, DefaultGC, DefaultRootWindow, DefaultScreenOfDisplay, DefaultScreen, DefaultVisual, DisplayCells, DisplayPlanes, DisplayString, XMaxRequestSize, XExtendedMaxRequestSize, LastKnownRequestProcessed, NextRequest, ProtocolVersion, ProtocolRevision, QLength, RootWindow, ScreenCount, ScreenOfDisplay, ServerVendor, VendorRelease \- Display macros and functions
.SH SYNTAX
52
unsigned long AllPlanes;
Egbert Eich's avatar
Egbert Eich committed
53 54 55
.HP
unsigned long BlackPixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^);
.HP
56
unsigned long WhitePixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^);
Egbert Eich's avatar
Egbert Eich committed
57
.HP
58
int ConnectionNumber\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
59 60
.HP
Colormap DefaultColormap\^(\^Display *\fIdisplay\fP\^,
61
\^int \fIscreen_number\fP\^);
Egbert Eich's avatar
Egbert Eich committed
62
.HP
63
int DefaultDepth\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
Egbert Eich's avatar
Egbert Eich committed
64 65
.HP
int *XListDepths\^(\^Display *\fIdisplay\fP, int \fIscreen_number\fP, int
66
\fIcount_return\fP\^);
Egbert Eich's avatar
Egbert Eich committed
67
.HP
68
GC DefaultGC\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
Egbert Eich's avatar
Egbert Eich committed
69
.HP
70
Window DefaultRootWindow\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
71
.HP
72
Screen *DefaultScreenOfDisplay\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
73
.HP
74
int DefaultScreen\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
75 76
.HP
Visual *DefaultVisual\^(\^Display *\fIdisplay\fP\^, \^int
77
\fIscreen_number\fP\^);
Egbert Eich's avatar
Egbert Eich committed
78
.HP
79
int DisplayCells\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
Egbert Eich's avatar
Egbert Eich committed
80 81 82 83 84 85 86 87 88
.HP
int DisplayPlanes\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
char *DisplayString\^(\^Display *\fIdisplay\fP\^);
.HP
long XMaxRequestSize(\^Display *\fIdisplay\fP\^)
.HP
long XExtendedMaxRequestSize(\^Display *\fIdisplay\fP\^)
.HP
89
unsigned long LastKnownRequestProcessed\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
90
.HP
91
unsigned long NextRequest\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
92
.HP
93
int ProtocolVersion\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
94
.HP
95
int ProtocolRevision\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
96
.HP
97
int QLength\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
98
.HP
99
Window RootWindow\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
Egbert Eich's avatar
Egbert Eich committed
100
.HP
101
int ScreenCount\^(\^Display *\fIdisplay\fP\^);
Egbert Eich's avatar
Egbert Eich committed
102 103
.HP
Screen *ScreenOfDisplay\^(\^Display *\fIdisplay\fP, int
104
\fIscreen_number\fP\^);
Egbert Eich's avatar
Egbert Eich committed
105 106 107 108
.HP
char *ServerVendor\^(\^Display *\fIdisplay\fP\^)
.HP
int VendorRelease\^(\^Display *\fIdisplay\fP\^)
109 110 111 112 113 114
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIscreen_number\fP 1i
Specifies the appropriate screen number on the host server.
.IP \fIcount_return\fP 1i
Walter Harms's avatar
Walter Harms committed
115
Returns the number of depths.
116 117
.SH DESCRIPTION
The
118
.B AllPlanes
119
macro returns a value with all bits set to 1 suitable for use in a plane
120 121 122
argument to a procedure.
.LP
The
123
.B BlackPixel
124 125 126
macro returns the black pixel value for the specified screen.
.LP
The
127
.B WhitePixel
128 129 130
macro returns the white pixel value for the specified screen.
.LP
The
131
.B ConnectionNumber
132 133 134
macro returns a connection number for the specified display.
.LP
The
135
.B DefaultColormap
136 137 138
macro returns the default colormap ID for allocation on the specified screen.
.LP
The
139
.B DefaultDepth
140 141 142 143
macro returns the depth (number of planes) of the default root window for the
specified screen.
.LP
The
144
.B XListDepths
145
function returns the array of depths
146 147 148
that are available on the specified screen.
If the specified screen_number is valid and sufficient memory for the array
can be allocated,
149
.B XListDepths
150 151 152
sets count_return to the number of available depths.
Otherwise, it does not set count_return and returns NULL.
To release the memory allocated for the array of depths, use
153
.BR XFree .
154 155
.LP
The
156
.B DefaultGC
157 158 159 160
macro returns the default GC for the root window of the
specified screen.
.LP
The
161
.B DefaultRootWindow
162 163 164
macro returns the root window for the default screen.
.LP
The
165
.B DefaultScreenOfDisplay
166 167 168
macro returns the default screen of the specified display.
.LP
The
169
.B DefaultScreen
170
macro returns the default screen number referenced in the
171
.B XOpenDisplay
172 173 174
routine.
.LP
The
175
.B DefaultVisual
176 177 178
macro returns the default visual type for the specified screen.
.LP
The
179
.B DisplayCells
180 181 182
macro returns the number of entries in the default colormap.
.LP
The
183
.B DisplayPlanes
184 185 186
macro returns the depth of the root window of the specified screen.
.LP
The
187
.B DisplayString
188
macro returns the string that was passed to
189
.B XOpenDisplay
190 191 192
when the current display was opened.
.LP
The
193
.B XMaxRequestSize
194 195 196 197 198 199 200 201
function returns the maximum request size (in 4-byte units) supported
by the server without using an extended-length protocol encoding.
Single protocol requests to the server can be no larger than this size
unless an extended-length protocol encoding is supported by the server.
The protocol guarantees the size to be no smaller than 4096 units
(16384 bytes).
Xlib automatically breaks data up into multiple protocol requests
as necessary for the following functions:
202 203 204 205 206
.BR XDrawPoints ,
.BR XDrawRectangles ,
.BR XDrawSegments ,
.BR XFillArcs ,
.BR XFillRectangles ,
207
and
208
.BR XPutImage .
209 210
.LP
The
211
.B XExtendedMaxRequestSize
212 213 214 215 216
function returns zero if the specified display does not support an
extended-length protocol encoding; otherwise,
it returns the maximum request size (in 4-byte units) supported
by the server using the extended-length encoding.
The Xlib functions
217 218 219 220 221
.BR XDrawLines ,
.BR XDrawArcs ,
.BR XFillPolygon ,
.BR XChangeProperty ,
.BR XSetClipRectangles ,
222
and
223
.B XSetRegion
224
will use the extended-length encoding as necessary, if supported
225 226
by the server.
Use of the extended-length encoding in other Xlib
227
functions (for example,
228 229 230 231 232 233
.BR XDrawPoints ,
.BR XDrawRectangles ,
.BR XDrawSegments ,
.BR XFillArcs ,
.BR XFillRectangles ,
.BR XPutImage )
234 235 236 237
is permitted but not required; an Xlib implementation may choose to
split the data across multiple smaller requests instead.
.LP
The
238
.B LastKnownRequestProcessed
239 240 241 242
macro extracts the full serial number of the last request known by Xlib
to have been processed by the X server.
.LP
The
243
.B NextRequest
244 245 246
macro extracts the full serial number that is to be used for the next request.
.LP
The
247
.B ProtocolVersion
248 249 250 251
macro returns the major version number (11) of the X protocol associated with
the connected display.
.LP
The
252
.B ProtocolRevision
253 254 255
macro returns the minor protocol revision number of the X server.
.LP
The
256
.B QLength
257 258 259
macro returns the length of the event queue for the connected display.
.LP
The
260
.B RootWindow
261 262 263
macro returns the root window.
.LP
The
264
.B ScreenCount
265 266 267
macro returns the number of available screens.
.LP
The
268
.B ScreenOfDisplay
269 270 271
macro returns a pointer to the screen of the specified display.
.LP
The
272
.B ServerVendor
273 274 275 276
macro returns a pointer to a null-terminated string that provides
some identification of the owner of the X server implementation.
.LP
The
277
.B VendorRelease
278 279
macro returns a number related to a vendor's release of the X server.
.SH "SEE ALSO"
280 281 282 283
BlackPixelOfScreen(__libmansuffix__),
ImageByteOrder(__libmansuffix__),
IsCursorKey(__libmansuffix__),
XOpenDisplay(__libmansuffix__)
284 285
.br
\fI\*(xL\fP