1AllPlanes(3)                    XLIB FUNCTIONS                    AllPlanes(3)
2
3
4

NAME

6       AllPlanes,  BlackPixel,  WhitePixel, ConnectionNumber, DefaultColormap,
7       DefaultDepth,  XListDepths,  DefaultGC,   DefaultRootWindow,   Default‐
8       ScreenOfDisplay,  DefaultScreen,  DefaultVisual, DisplayCells, Display‐
9       Planes, DisplayString, XMaxRequestSize, XExtendedMaxRequestSize,  Last‐
10       KnownRequestProcessed,  NextRequest, ProtocolVersion, ProtocolRevision,
11       QLength, RootWindow, ScreenCount, ScreenOfDisplay,  ServerVendor,  Ven‐
12       dorRelease - Display macros and functions
13

SYNTAX

15       unsigned long AllPlanes;
16
17       unsigned long BlackPixel(Display *display, int screen_number);
18
19       unsigned long WhitePixel(Display *display, int screen_number);
20
21       int ConnectionNumber(Display *display);
22
23       Colormap DefaultColormap(Display *display, int screen_number);
24
25       int DefaultDepth(Display *display, int screen_number);
26
27       int  *XListDepths(Display  *display,  int screen_number, int *count_re‐
28              turn);
29
30       GC DefaultGC(Display *display, int screen_number);
31
32       Window DefaultRootWindow(Display *display);
33
34       Screen *DefaultScreenOfDisplay(Display *display);
35
36       int DefaultScreen(Display *display);
37
38       Visual *DefaultVisual(Display *display, int screen_number);
39
40       int DisplayCells(Display *display, int screen_number);
41
42       int DisplayPlanes(Display *display, int screen_number);
43
44       char *DisplayString(Display *display);
45
46       long XMaxRequestSize(Display *display);
47
48       long XExtendedMaxRequestSize(Display *display);
49
50       unsigned long LastKnownRequestProcessed(Display *display);
51
52       unsigned long NextRequest(Display *display);
53
54       int ProtocolVersion(Display *display);
55
56       int ProtocolRevision(Display *display);
57
58       int QLength(Display *display);
59
60       Window RootWindow(Display *display, int screen_number);
61
62       int ScreenCount(Display *display);
63
64       Screen *ScreenOfDisplay(Display *display, int screen_number);
65
66       char *ServerVendor(Display *display);
67
68       int VendorRelease(Display *display);
69

ARGUMENTS

71       display   Specifies the connection to the X server.
72
73       screen_number
74                 Specifies the appropriate screen number on the host server.
75
76       count_return
77                 Returns the number of depths.
78

DESCRIPTION

80       The AllPlanes macro returns a value with all bits set to 1 suitable for
81       use in a plane argument to a procedure.
82
83       The  BlackPixel  macro  returns the black pixel value for the specified
84       screen.
85
86       The WhitePixel macro returns the white pixel value  for  the  specified
87       screen.
88
89       The  ConnectionNumber  macro returns a connection number for the speci‐
90       fied display.
91
92       The DefaultColormap macro returns the default colormap ID  for  alloca‐
93       tion on the specified screen.
94
95       The  DefaultDepth macro returns the depth (number of planes) of the de‐
96       fault root window for the specified screen.
97
98       The XListDepths function returns the array of depths that are available
99       on  the  specified screen.  If the specified screen_number is valid and
100       sufficient memory for the array  can  be  allocated,  XListDepths  sets
101       count_return to the number of available depths.  Otherwise, it does not
102       set count_return and returns NULL.  To release the memory allocated for
103       the array of depths, use XFree.
104
105       The  DefaultGC  macro returns the default GC for the root window of the
106       specified screen.
107
108       The DefaultRootWindow macro returns the root  window  for  the  default
109       screen.
110
111       The  DefaultScreenOfDisplay  macro  returns  the  default screen of the
112       specified display.
113
114       The DefaultScreen macro returns the default screen number referenced in
115       the XOpenDisplay routine.
116
117       The  DefaultVisual macro returns the default visual type for the speci‐
118       fied screen.
119
120       The DisplayCells macro returns the number of  entries  in  the  default
121       colormap.
122
123       The  DisplayPlanes  macro  returns  the depth of the root window of the
124       specified screen.
125
126       The DisplayString macro returns the string that was passed to XOpenDis‐
127       play when the current display was opened.
128
129       The  XMaxRequestSize  function  returns  the  maximum  request size (in
130       4-byte units) supported by the server without using an  extended-length
131       protocol  encoding.   Single  protocol requests to the server can be no
132       larger than this size unless an extended-length  protocol  encoding  is
133       supported  by  the  server.   The protocol guarantees the size to be no
134       smaller than 4096 units (16384 bytes).  Xlib automatically breaks  data
135       up into multiple protocol requests as necessary for the following func‐
136       tions: XDrawPoints, XDrawRectangles, XDrawSegments,  XFillArcs,  XFill‐
137       Rectangles, and XPutImage.
138
139       The XExtendedMaxRequestSize function returns zero if the specified dis‐
140       play does not support an extended-length protocol encoding;  otherwise,
141       it  returns the maximum request size (in 4-byte units) supported by the
142       server using the extended-length encoding.  The Xlib  functions  XDraw‐
143       Lines,  XDrawArcs,  XFillPolygon,  XChangeProperty, XSetClipRectangles,
144       and XSetRegion will use the extended-length encoding as  necessary,  if
145       supported  by the server.  Use of the extended-length encoding in other
146       Xlib functions (for example,  XDrawPoints,  XDrawRectangles,  XDrawSeg‐
147       ments,  XFillArcs, XFillRectangles, XPutImage) is permitted but not re‐
148       quired; an Xlib implementation may choose to split the data across mul‐
149       tiple smaller requests instead.
150
151       The  LastKnownRequestProcessed macro extracts the full serial number of
152       the last request known by Xlib to have been processed by the X server.
153
154       The NextRequest macro extracts the full serial number  that  is  to  be
155       used for the next request.
156
157       The  ProtocolVersion macro returns the major version number (11) of the
158       X protocol associated with the connected display.
159
160       The ProtocolRevision macro returns the minor protocol  revision  number
161       of the X server.
162
163       The  QLength  macro  returns the length of the event queue for the con‐
164       nected display.
165
166       The RootWindow macro returns the root window.
167
168       The ScreenCount macro returns the number of available screens.
169
170       The ScreenOfDisplay macro returns a pointer to the screen of the speci‐
171       fied display.
172
173       The  ServerVendor  macro  returns a pointer to a null-terminated string
174       that provides some identification of the owner of the X  server  imple‐
175       mentation.
176
177       The  VendorRelease macro returns a number related to a vendor's release
178       of the X server.
179

SEE ALSO

181       BlackPixelOfScreen(3),  ImageByteOrder(3),  IsCursorKey(3),   XOpenDis‐
182       play(3)
183       Xlib - C Language X Interface
184
185
186
187X Version 11                    libX11 1.7.3.1                    AllPlanes(3)
Impressum