libXext-1.0.2/man/XcupGetReservedColormapEntries.man

   1 .\" $XdotOrg: $
   2 .\"
   3 .\" Copyright \(co 1986-1997   The Open Group    All Rights Reserved
   4 .\" Copyright 1999, 2005 Sun Microsystems, Inc.  All Rights Reserved
   5 .\"
   6 .\" Permission is hereby granted, free of charge, to any person obtaining a
   7 .\" copy of this software and associated documentation files (the "Software"),
   8 .\" to deal in the Software without restriction, including without limitation
   9 .\" the rights to use, copy, modify, merge, publish, distribute,
  10 .\" sublicense, and/or sell copies of the Software, and to permit persons
  11 .\" to whom the Software is furnished to do so, subject to the following
  12 .\" conditions:
  13 .\"
  14 .\" The above copyright notice and this permission notice shall be
  15 .\" included in all copies or substantial portions of the Software.
  16 .\"
  17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  20 .\" IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
  23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24 .\"
  25 .\" Except as contained in this notice, the names of the copyright holders
  26 .\" shall not be used in advertising or otherwise to promote the sale, use
  27 .\" or other dealings in this Software without prior written authorization
  28 .\" from said copyright holders.
  29 .\"
  30 .\" X Window System is a trademark of The Open Group.
  31 .\"
  32 .de ZN
  33 .ie t \fB\^\\$1\^\fR\\$2
  34 .el \fI\^\\$1\^\fP\\$2
  35 ..
  36 .TH XCUP __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  37 .SH NAME
  38 XcupGetReservedColormapEntries \- list colormap entries reserved by the system
  39 .SH SYNOPSIS
  40 .PP
  41 .nf
  42 \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
  43 \&#include <X11/extensions/Xcup.h>
  44 .HP
  45 Status \fBXcupGetReservedColormapEntries\fP\^(\^Display *\fIdisplay\fP\^,
  46 int \fIscreen\fP\^, XColor **\fIcolors_out\fP\^, int *\fIncolors\fP\^);
  47 .if n .ti +5n
  48 .if t .ti +.5i
  49 .SH ARGUMENTS
  50 .IP \fIdisplay\fP 1i
  51 Specifies the connection to the X server.
  52 .IP \fIscreen\fP 1i
  53 Screen number on the host server.
  54 .IP \fIcolors_out\fP 1i
  55 Returns the values reserved by the server.
  56 .IP \fIncolors\fP 1i
  57 Returns the number of items in \fIcolors_out\fP.
  58 .SH DESCRIPTION
  59 .LP
  60 The
  61 .ZN XcupGetReservedColormapEntries
  62 function returns a list of colormap entries (pixels) that are reserved
  63 by the system. This list will, at a minimum, contain entries for the
  64 BlackPixel and WhitePixel of the specified screen. Use
  65 .ZN XFree
  66 to free
  67 .I colors_out.
  68 .LP
  69 To minimize colormap flash, an application which installs its own private
  70 colormap should query the special colors by calling
  71 .ZN XCupGetReservedColormapEntries ,
  72 and can then store those entries (in the
  73 proper location) in its private colormap using
  74 .ZN XCupStoreColors .
  75 .SH "SEE ALSO"
  76 .BR XcupQueryVersion (3Xext),
  77 .BR XcupStoreColors (3Xext),
  78 .BR XFree (3X11),
  79 .br
  80 \fIColormap Utilization Policy and Extension\fP