man/XcupGetReservedColormapEntries.man

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