<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xcmssclrman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->

<!--  Permission is hereby granted, free of charge, to any person obtaining -->
<!--  a copy of this software and associated documentation files (the -->
<!--  "Software"), to deal in the Software without restriction, including -->
<!--  without limitation the rights to use, copy, modify, merge, publish, -->
<!--  distribute, sublicense, and/or sell copies of the Software, and to -->
<!--  permit persons to whom the Software is furnished to do so, subject to -->
<!--  the following conditions: -->

<!--  The above copyright notice and this permission notice shall be included -->
<!--  in all copies or substantial portions of the Software. -->

<!--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
<!--  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
<!--  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
<!--  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
<!--  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
<!--  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
<!--  OTHER DEALINGS IN THE SOFTWARE. -->

<!--  Except as contained in this notice, the name of the X Consortium shall -->
<!--  not be used in advertising or otherwise to promote the sale, use or -->
<!--  other dealings in this Software without prior written authorization -->
<!--  from the X Consortium. -->

<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by -->
<!--  Digital Equipment Corporation -->

<!--  Portions Copyright \(co 1990, 1991 by -->
<!--  Tektronix, Inc. -->

<!--  Permission to use, copy, modify and distribute this documentation for -->
<!--  any purpose and without fee is hereby granted, provided that the above -->
<!--  copyright notice appears in all copies and that both that copyright notice -->
<!--  and this permission notice appear in all copies, and that the names of -->
<!--  Digital and Tektronix not be used in in advertising or publicity pertaining -->
<!--  to this documentation without specific, written prior permission. -->
<!--  Digital and Tektronix makes no representations about the suitability -->
<!--  of this documentation for any purpose. -->
<!--  It is provided ``as is'' without express or implied warranty. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XcmsSClr.man,v 1.3 2003/04/28 22:17:58 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XcmsStoreColor</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XcmsStoreColor</refname>
<refname>XcmsStoreColors</refname>
<refpurpose>set colors</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>Status XcmsStoreColor&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Colormap <emphasis remap='I'>colormap</emphasis>&hairsp;,
XcmsColor *<emphasis remap='I'>color</emphasis>&hairsp;);</para> 

<para>Status XcmsStoreColors&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Colormap
<emphasis remap='I'>colormap</emphasis>&hairsp;, XcmsColor <emphasis remap='I'>colors</emphasis>&hairsp;[&hairsp;]&hairsp;, int <emphasis remap='I'>ncolors</emphasis>&hairsp;, Bool
<emphasis remap='I'>compression_flags_return</emphasis>&hairsp;[&hairsp;]&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>color</emphasis></term>
  <listitem>
<para>Specifies the color cell and the color to store.
Values specified in this
<emphasis remap='I'>&hairsp;XcmsColor&hairsp;</emphasis>
structure remain unchanged on return.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>colors</emphasis></term>
  <listitem>
<para>Specifies the color specification array of
<emphasis remap='I'>&hairsp;XcmsColor&hairsp;</emphasis>
structures, each specifying a color cell and the color to store in that
cell.
Values specified in the array remain unchanged upon return.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>colormap</emphasis></term>
  <listitem>
<para>Specifies the colormap.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>compression_flags_return</emphasis></term>
  <listitem>
<para>Returns an array of Boolean values indicating compression status.
If a non-NULL pointer is supplied,
each element of the array is set to
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>
if the corresponding color was compressed and
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>
otherwise.
Pass NULL if the compression status is not useful.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>ncolors</emphasis></term>
  <listitem>
<para>Specifies the number of 
<emphasis remap='I'>&hairsp;XcmsColor&hairsp;</emphasis>
structures in the color-specification array.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XcmsStoreColor&hairsp;</emphasis>
function converts the color specified in the
<emphasis remap='I'>&hairsp;XcmsColor&hairsp;</emphasis>
structure into RGB values.
It then uses this RGB specification in an
<emphasis remap='I'>&hairsp;XColor&hairsp;</emphasis>
structure, whose three flags 
(<emphasis remap='I'>&hairsp;DoRed&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;DoGreen&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;DoBlue&hairsp;</emphasis>)
are set, in a call to
<emphasis remap='I'>&hairsp;XStoreColor&hairsp;</emphasis>
to change the color cell specified by the pixel member of the
<emphasis remap='I'>&hairsp;XcmsColor&hairsp;</emphasis>
structure.
This pixel value must be a valid index for the specified colormap,
and the color cell specified by the pixel value must be a read/write cell.
If the pixel value is not a valid index, a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error results.
If the color cell is unallocated or is allocated read-only, a
<emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis>
error results.
If the colormap is an installed map for its screen, 
the changes are visible immediately.</para>

<para>Note that 
<emphasis remap='I'>&hairsp;XStoreColor&hairsp;</emphasis>
has no return value; therefore, an
<emphasis remap='I'>&hairsp;XcmsSuccess&hairsp;</emphasis>
return value from this function indicates that the conversion 
to RGB succeeded and the call to
<emphasis remap='I'>&hairsp;XStoreColor&hairsp;</emphasis>
was made.
To obtain the actual color stored, use
<emphasis remap='I'>&hairsp;XcmsQueryColor&hairsp;</emphasis>.
Because of the screen's hardware limitations or gamut compression,
the color stored in the colormap may not be identical
to the color specified.</para>

<para><emphasis remap='I'>&hairsp;XcmsStoreColor&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadColor&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
errors.</para>

<para>The
<emphasis remap='I'>&hairsp;XcmsStoreColors&hairsp;</emphasis>
function converts the colors specified in the array of
<emphasis remap='I'>&hairsp;XcmsColor&hairsp;</emphasis>
structures into RGB values and then uses these RGB specifications in
<emphasis remap='I'>&hairsp;XColor&hairsp;</emphasis>
structures, whose three flags 
(<emphasis remap='I'>&hairsp;DoRed&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;DoGreen&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;DoBlue&hairsp;</emphasis>)
are set, in a call to
<emphasis remap='I'>&hairsp;XStoreColors&hairsp;</emphasis>
to change the color cells specified by the pixel member of the corresponding
<emphasis remap='I'>&hairsp;XcmsColor&hairsp;</emphasis>
structure.
Each pixel value must be a valid index for the specified colormap,
and the color cell specified by each pixel value must be a read/write cell.
If a pixel value is not a valid index, a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error results.
If a color cell is unallocated or is allocated read-only, a
<emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis>
error results.
If more than one pixel is in error,
the one that gets reported is arbitrary.
If the colormap is an installed map for its screen, 
the changes are visible immediately.</para>

<para>Note that 
<emphasis remap='I'>&hairsp;XStoreColors&hairsp;</emphasis>
has no return value; therefore, an
<emphasis remap='I'>&hairsp;XcmsSuccess&hairsp;</emphasis>
return value from this function indicates that conversions 
to RGB succeeded and the call to
<emphasis remap='I'>&hairsp;XStoreColors&hairsp;</emphasis>
was made.
To obtain the actual colors stored, use
<emphasis remap='I'>&hairsp;XcmsQueryColors&hairsp;</emphasis>.
Because of the screen's hardware limitations or gamut compression,
the colors stored in the colormap may not be identical
to the colors specified.</para>


<para><emphasis remap='I'>&hairsp;XcmsStoreColors&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadColor&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
errors.</para>
</refsect1>

<refsect1 id='diagnostics'><title>DIAGNOSTICS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis></term>
  <listitem>
<para>A client attempted
to free a color map entry that it did not already allocate.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis></term>
  <listitem>
<para>A client attempted
to store into a read-only color map entry.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadColor&hairsp;</emphasis></term>
  <listitem>
<para>A value for a Colormap argument does not name a defined Colormap.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis></term>
  <listitem>
<para>Some numeric value falls outside the range of values accepted by the request.
Unless a specific range is specified for an argument, the full range defined
by the argument's type is accepted.  Any argument defined as a set of
alternatives can generate this error.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>XcmsAllocColor(3X11),
XcmsQueryColor(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

