man/XStoreColors.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XStoreColors __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XStoreColors, XStoreColor, XStoreNamedColor \- set colors
 145 .SH SYNTAX
 146 .HP
 147 int XStoreColors\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^,
 148 XColor \fIcolor\fP\^[\^]\^, int \fIncolors\fP\^);
 149 .HP
 150 int XStoreColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^,
 151 XColor *\fIcolor\fP\^);
 152 .HP
 153 int XStoreNamedColor\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^,
 154 char *\^\fIcolor\fP\^, unsigned long \fIpixel\fP\^, int \fIflags\fP\^);
 155 .SH ARGUMENTS
 156 .ds Co pixel and RGB values or the color name string (for example, red)
 157 .IP \fIcolor\fP 1i
 158 Specifies the \*(Co.
 159 .IP \fIcolor\fP 1i
 160 Specifies an array of color definition structures to be stored.
 161 .IP \fIcolormap\fP 1i
 162 Specifies the colormap.
 163 .IP \fIdisplay\fP 1i
 164 Specifies the connection to the X server.
 165 .IP \fIflags\fP 1i
 166 Specifies which red, green, and blue components are set.
 167 .IP \fIncolors\fP 1i
 168 .\"Specifies the number of color definition structures.
 169 Specifies the number of
 170 .ZN XColor
 171 structures in the color definition array.
 172 .IP \fIpixel\fP 1i
 173 Specifies the entry in the colormap.
 174 .SH DESCRIPTION
 175 The
 176 .ZN XStoreColors
 177 function changes the colormap entries of the pixel values
 178 specified in the pixel members of the
 179 .ZN XColor
 180 structures.
 181 You specify which color components are to be changed by setting
 182 .ZN DoRed ,
 183 .ZN DoGreen ,
 184 and/or
 185 .ZN DoBlue
 186 in the flags member of the
 187 .ZN XColor
 188 structures.
 189 If the colormap is an installed map for its screen, the
 190 changes are visible immediately.
 191 .ZN XStoreColors
 192 changes the specified pixels if they are allocated writable in the colormap
 193 by any client, even if one or more pixels generates an error.
 194 If a specified pixel is not a valid index into the colormap, a
 195 .ZN BadValue
 196 error results.
 197 If a specified pixel either is unallocated or is allocated read-only, a
 198 .ZN BadAccess
 199 error results.
 200 If more than one pixel is in error,
 201 the one that gets reported is arbitrary.
 202 .LP
 203 .ZN XStoreColors
 204 can generate
 205 .ZN BadAccess ,
 206 .ZN BadColor ,
 207 and
 208 .ZN BadValue
 209 errors.
 210 .LP
 211 The
 212 .ZN XStoreColor
 213 function changes the colormap entry of the pixel value specified in the
 214 pixel member of the
 215 .ZN XColor
 216 structure.
 217 You specified this value in the
 218 pixel member of the
 219 .ZN XColor
 220 structure.
 221 This pixel value must be a read/write cell and a valid index into the colormap.
 222 If a specified pixel is not a valid index into the colormap,
 223 a
 224 .ZN BadValue
 225 error results.
 226 .ZN XStoreColor
 227 also changes the red, green, and/or blue color components.
 228 You specify which color components are to be changed by setting
 229 .ZN DoRed ,
 230 .ZN DoGreen ,
 231 and/or
 232 .ZN DoBlue
 233 in the flags member of the
 234 .ZN XColor
 235 structure.
 236 If the colormap is an installed map for its screen,
 237 the changes are visible immediately.
 238 .LP
 239 .ZN XStoreColor
 240 can generate
 241 .ZN BadAccess ,
 242 .ZN BadColor ,
 243 and
 244 .ZN BadValue
 245 errors.
 246 .LP
 247 The
 248 .ZN XStoreNamedColor
 249 function looks up the named color with respect to the screen associated with
 250 the colormap and stores the result in the specified colormap.
 251 The pixel argument determines the entry in the colormap.
 252 The flags argument determines which of the red, green, and blue components
 253 are set.
 254 You can set this member to the
 255 bitwise inclusive OR of the bits
 256 .ZN DoRed ,
 257 .ZN DoGreen ,
 258 and
 259 .ZN DoBlue .
 260 If the color name is not in the Host Portable Character Encoding,
 261 the result is implementation-dependent.
 262 Use of uppercase or lowercase does not matter.
 263 If the specified pixel is not a valid index into the colormap, a
 264 .ZN BadValue
 265 error results.
 266 If the specified pixel either is unallocated or is allocated read-only, a
 267 .ZN BadAccess
 268 error results.
 269 .LP
 270 .ZN XStoreNamedColor
 271 can generate
 272 .ZN BadAccess ,
 273 .ZN BadColor ,
 274 .ZN BadName ,
 275 and
 276 .ZN BadValue
 277 errors.
 278 .SH DIAGNOSTICS
 279 .TP 1i
 280 .ZN BadAccess
 281 A client attempted
 282 to free a color map entry that it did not already allocate.
 283 .TP 1i
 284 .ZN BadAccess
 285 A client attempted
 286 to store into a read-only color map entry.
 287 .TP 1i
 288 .ZN BadColor
 289 A value for a Colormap argument does not name a defined Colormap.
 290 .TP 1i
 291 .ZN BadName
 292 A font or color of the specified name does not exist.
 293 .TP 1i
 294 .ZN BadValue
 295 Some numeric value falls outside the range of values accepted by the request.
 296 Unless a specific range is specified for an argument, the full range defined
 297 by the argument's type is accepted.  Any argument defined as a set of
 298 alternatives can generate this error.
 299 .SH "SEE ALSO"
 300 XAllocColor(__libmansuffix__),
 301 XCreateColormap(__libmansuffix__),
 302 XQueryColor(__libmansuffix__)
 303 .br
 304 \fI\*(xL\fP