Blame man/AllPlanes.man

Packit Service dc579d
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
Packit Service dc579d
.\"
Packit Service dc579d
.\" Permission is hereby granted, free of charge, to any person obtaining
Packit Service dc579d
.\" a copy of this software and associated documentation files (the
Packit Service dc579d
.\" "Software"), to deal in the Software without restriction, including
Packit Service dc579d
.\" without limitation the rights to use, copy, modify, merge, publish,
Packit Service dc579d
.\" distribute, sublicense, and/or sell copies of the Software, and to
Packit Service dc579d
.\" permit persons to whom the Software is furnished to do so, subject to
Packit Service dc579d
.\" the following conditions:
Packit Service dc579d
.\"
Packit Service dc579d
.\" The above copyright notice and this permission notice shall be included
Packit Service dc579d
.\" in all copies or substantial portions of the Software.
Packit Service dc579d
.\"
Packit Service dc579d
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Packit Service dc579d
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Packit Service dc579d
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Packit Service dc579d
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
Packit Service dc579d
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Packit Service dc579d
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Packit Service dc579d
.\" OTHER DEALINGS IN THE SOFTWARE.
Packit Service dc579d
.\"
Packit Service dc579d
.\" Except as contained in this notice, the name of the X Consortium shall
Packit Service dc579d
.\" not be used in advertising or otherwise to promote the sale, use or
Packit Service dc579d
.\" other dealings in this Software without prior written authorization
Packit Service dc579d
.\" from the X Consortium.
Packit Service dc579d
.\"
Packit Service dc579d
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Packit Service dc579d
.\" Digital Equipment Corporation
Packit Service dc579d
.\"
Packit Service dc579d
.\" Portions Copyright \(co 1990, 1991 by
Packit Service dc579d
.\" Tektronix, Inc.
Packit Service dc579d
.\"
Packit Service dc579d
.\" Permission to use, copy, modify and distribute this documentation for
Packit Service dc579d
.\" any purpose and without fee is hereby granted, provided that the above
Packit Service dc579d
.\" copyright notice appears in all copies and that both that copyright notice
Packit Service dc579d
.\" and this permission notice appear in all copies, and that the names of
Packit Service dc579d
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
Packit Service dc579d
.\" to this documentation without specific, written prior permission.
Packit Service dc579d
.\" Digital and Tektronix makes no representations about the suitability
Packit Service dc579d
.\" of this documentation for any purpose.
Packit Service dc579d
.\" It is provided ``as is'' without express or implied warranty.
Packit Service dc579d
.\" 
Packit Service dc579d
.\"
Packit Service dc579d
.ds xT X Toolkit Intrinsics \- C Language Interface
Packit Service dc579d
.ds xW Athena X Widgets \- C Language X Toolkit Interface
Packit Service dc579d
.ds xL Xlib \- C Language X Interface
Packit Service dc579d
.ds xC Inter-Client Communication Conventions Manual
Packit Service dc579d
.na
Packit Service dc579d
.de Ds
Packit Service dc579d
.nf
Packit Service dc579d
.\\$1D \\$2 \\$1
Packit Service dc579d
.ft CW
Packit Service dc579d
.\".ps \\n(PS
Packit Service dc579d
.\".if \\n(VS>=40 .vs \\n(VSu
Packit Service dc579d
.\".if \\n(VS<=39 .vs \\n(VSp
Packit Service dc579d
..
Packit Service dc579d
.de De
Packit Service dc579d
.ce 0
Packit Service dc579d
.if \\n(BD .DF
Packit Service dc579d
.nr BD 0
Packit Service dc579d
.in \\n(OIu
Packit Service dc579d
.if \\n(TM .ls 2
Packit Service dc579d
.sp \\n(DDu
Packit Service dc579d
.fi
Packit Service dc579d
..
Packit Service dc579d
.de IN		\" send an index entry to the stderr
Packit Service dc579d
..
Packit Service dc579d
.de Pn
Packit Service dc579d
.ie t \\$1\fB\^\\$2\^\fR\\$3
Packit Service dc579d
.el \\$1\fI\^\\$2\^\fP\\$3
Packit Service dc579d
..
Packit Service dc579d
.de ZN
Packit Service dc579d
.ie t \fB\^\\$1\^\fR\\$2
Packit Service dc579d
.el \fI\^\\$1\^\fP\\$2
Packit Service dc579d
..
Packit Service dc579d
.de hN
Packit Service dc579d
.ie t <\fB\\$1\fR>\\$2
Packit Service dc579d
.el <\fI\\$1\fP>\\$2
Packit Service dc579d
..
Packit Service dc579d
.ny0
Packit Service dc579d
.TH AllPlanes __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
Packit Service dc579d
.SH NAME
Packit Service dc579d
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
Packit Service dc579d
.SH SYNTAX
Packit Service dc579d
unsigned long AllPlanes; 
Packit Service dc579d
.HP
Packit Service dc579d
unsigned long BlackPixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^);
Packit Service dc579d
.HP
Packit Service dc579d
unsigned long WhitePixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int ConnectionNumber\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
Colormap DefaultColormap\^(\^Display *\fIdisplay\fP\^,
Packit Service dc579d
\^int \fIscreen_number\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int DefaultDepth\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int *XListDepths\^(\^Display *\fIdisplay\fP, int \fIscreen_number\fP, int
Packit Service dc579d
\fIcount_return\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
GC DefaultGC\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
Window DefaultRootWindow\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
Screen *DefaultScreenOfDisplay\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int DefaultScreen\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
Visual *DefaultVisual\^(\^Display *\fIdisplay\fP\^, \^int
Packit Service dc579d
\fIscreen_number\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int DisplayCells\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int DisplayPlanes\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
Packit Service dc579d
.HP
Packit Service dc579d
char *DisplayString\^(\^Display *\fIdisplay\fP\^);
Packit Service dc579d
.HP
Packit Service dc579d
long XMaxRequestSize(\^Display *\fIdisplay\fP\^)
Packit Service dc579d
.HP
Packit Service dc579d
long XExtendedMaxRequestSize(\^Display *\fIdisplay\fP\^)
Packit Service dc579d
.HP
Packit Service dc579d
unsigned long LastKnownRequestProcessed\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
unsigned long NextRequest\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int ProtocolVersion\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int ProtocolRevision\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int QLength\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
Window RootWindow\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
int ScreenCount\^(\^Display *\fIdisplay\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
Screen *ScreenOfDisplay\^(\^Display *\fIdisplay\fP, int
Packit Service dc579d
\fIscreen_number\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
char *ServerVendor\^(\^Display *\fIdisplay\fP\^)
Packit Service dc579d
.HP
Packit Service dc579d
int VendorRelease\^(\^Display *\fIdisplay\fP\^)
Packit Service dc579d
.SH ARGUMENTS
Packit Service dc579d
.IP \fIdisplay\fP 1i
Packit Service dc579d
Specifies the connection to the X server.
Packit Service dc579d
.IP \fIscreen_number\fP 1i
Packit Service dc579d
Specifies the appropriate screen number on the host server.
Packit Service dc579d
.ds Cn depths
Packit Service dc579d
.IP \fIcount_return\fP 1i
Packit Service dc579d
Returns the number of \*(Cn.
Packit Service dc579d
.SH DESCRIPTION
Packit Service dc579d
The
Packit Service dc579d
.ZN AllPlanes
Packit Service dc579d
macro returns a value with all bits set to 1 suitable for use in a plane 
Packit Service dc579d
argument to a procedure.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN BlackPixel
Packit Service dc579d
macro returns the black pixel value for the specified screen.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN WhitePixel
Packit Service dc579d
macro returns the white pixel value for the specified screen.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN ConnectionNumber
Packit Service dc579d
macro returns a connection number for the specified display.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DefaultColormap
Packit Service dc579d
macro returns the default colormap ID for allocation on the specified screen.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DefaultDepth
Packit Service dc579d
macro returns the depth (number of planes) of the default root window for the
Packit Service dc579d
specified screen.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN XListDepths
Packit Service dc579d
function returns the array of depths 
Packit Service dc579d
that are available on the specified screen.
Packit Service dc579d
If the specified screen_number is valid and sufficient memory for the array
Packit Service dc579d
can be allocated,
Packit Service dc579d
.ZN XListDepths
Packit Service dc579d
sets count_return to the number of available depths.
Packit Service dc579d
Otherwise, it does not set count_return and returns NULL.
Packit Service dc579d
To release the memory allocated for the array of depths, use
Packit Service dc579d
.ZN XFree .
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DefaultGC
Packit Service dc579d
macro returns the default GC for the root window of the
Packit Service dc579d
specified screen.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DefaultRootWindow
Packit Service dc579d
macro returns the root window for the default screen.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DefaultScreenOfDisplay
Packit Service dc579d
macro returns the default screen of the specified display.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DefaultScreen
Packit Service dc579d
macro returns the default screen number referenced in the
Packit Service dc579d
.ZN XOpenDisplay
Packit Service dc579d
routine.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DefaultVisual
Packit Service dc579d
macro returns the default visual type for the specified screen.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DisplayCells
Packit Service dc579d
macro returns the number of entries in the default colormap.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DisplayPlanes
Packit Service dc579d
macro returns the depth of the root window of the specified screen.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN DisplayString
Packit Service dc579d
macro returns the string that was passed to
Packit Service dc579d
.ZN XOpenDisplay
Packit Service dc579d
when the current display was opened.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN XMaxRequestSize
Packit Service dc579d
function returns the maximum request size (in 4-byte units) supported
Packit Service dc579d
by the server without using an extended-length protocol encoding.
Packit Service dc579d
Single protocol requests to the server can be no larger than this size
Packit Service dc579d
unless an extended-length protocol encoding is supported by the server.
Packit Service dc579d
The protocol guarantees the size to be no smaller than 4096 units
Packit Service dc579d
(16384 bytes).
Packit Service dc579d
Xlib automatically breaks data up into multiple protocol requests
Packit Service dc579d
as necessary for the following functions:
Packit Service dc579d
.ZN XDrawPoints ,
Packit Service dc579d
.ZN XDrawRectangles ,
Packit Service dc579d
.ZN XDrawSegments ,
Packit Service dc579d
.ZN XFillArcs ,
Packit Service dc579d
.ZN XFillRectangles ,
Packit Service dc579d
and 
Packit Service dc579d
.ZN XPutImage .
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN XExtendedMaxRequestSize
Packit Service dc579d
function returns zero if the specified display does not support an
Packit Service dc579d
extended-length protocol encoding; otherwise,
Packit Service dc579d
it returns the maximum request size (in 4-byte units) supported
Packit Service dc579d
by the server using the extended-length encoding.
Packit Service dc579d
The Xlib functions
Packit Service dc579d
.ZN XDrawLines ,
Packit Service dc579d
.ZN XDrawArcs ,
Packit Service dc579d
.ZN XFillPolygon ,
Packit Service dc579d
.ZN XChangeProperty ,
Packit Service dc579d
.ZN XSetClipRectangles ,
Packit Service dc579d
and
Packit Service dc579d
.ZN XSetRegion
Packit Service dc579d
will use the extended-length encoding as necessary, if supported
Packit Service dc579d
by the server.  Use of the extended-length encoding in other Xlib
Packit Service dc579d
functions (for example,
Packit Service dc579d
.ZN XDrawPoints ,
Packit Service dc579d
.ZN XDrawRectangles ,
Packit Service dc579d
.ZN XDrawSegments ,
Packit Service dc579d
.ZN XFillArcs ,
Packit Service dc579d
.ZN XFillRectangles ,
Packit Service dc579d
.ZN XPutImage )
Packit Service dc579d
is permitted but not required; an Xlib implementation may choose to
Packit Service dc579d
split the data across multiple smaller requests instead.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN LastKnownRequestProcessed
Packit Service dc579d
macro extracts the full serial number of the last request known by Xlib
Packit Service dc579d
to have been processed by the X server.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN NextRequest
Packit Service dc579d
macro extracts the full serial number that is to be used for the next request.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN ProtocolVersion
Packit Service dc579d
macro returns the major version number (11) of the X protocol associated with
Packit Service dc579d
the connected display.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN ProtocolRevision
Packit Service dc579d
macro returns the minor protocol revision number of the X server.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN QLength
Packit Service dc579d
macro returns the length of the event queue for the connected display.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN RootWindow
Packit Service dc579d
macro returns the root window.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN ScreenCount
Packit Service dc579d
macro returns the number of available screens.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN ScreenOfDisplay
Packit Service dc579d
macro returns a pointer to the screen of the specified display.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN ServerVendor
Packit Service dc579d
macro returns a pointer to a null-terminated string that provides
Packit Service dc579d
some identification of the owner of the X server implementation.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN VendorRelease
Packit Service dc579d
macro returns a number related to a vendor's release of the X server.
Packit Service dc579d
.SH "SEE ALSO"
Packit Service dc579d
BlackPixelOfScreen(__libmansuffix__),
Packit Service dc579d
ImageByteOrder(__libmansuffix__),
Packit Service dc579d
IsCursorKey(__libmansuffix__),
Packit Service dc579d
XOpenDisplay(__libmansuffix__)
Packit Service dc579d
.br
Packit Service dc579d
\fI\*(xL\fP