XcmsStoreColor

Syntax

Status XcmsStoreColor(display, colormap, color)
      Display *display;
      Colormap colormap;
      XcmsColor *color;

Arguments

display	Specifies the connection to the X server.
colormap	Specifies the colormap.
color	Specifies the color cell and the color to store. Values specified in this XcmsColor structure remain unchanged upon return.

Description

The XcmsStoreColor() function converts the color specified in the XcmsColor structure into RGB values. It then uses this RGB specification in an XColor structure, whose three flags (DoRed, DoGreen, and DoBlue) are set, in a call to XStoreColor() to change the color cell specified by the pixel member of the XcmsColor 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 BadValue error results. If the color cell is unallocated or is allocated read-only, a BadAccess error results. If the colormap is an installed map for its screen, the changes are visible immediately.

Note that XStoreColor() has no return value; therefore, an XcmsSuccess return value from this function indicates that the conversion to RGB succeeded and the call to XStoreColor() was made. To obtain the actual color stored, use XcmsQueryColor(). Due to the screen's hardware limitations or gamut compression, the color stored in the colormap may not be identical to the color specified.

XcmsStoreColor() can generate BadAccess , BadColor , and BadValue errors.

Diagnostics

BadAccess	A client attempted to free a color map entry that it did not already allocate.
BadAccess	A client attempted to store into a read-only color map entry.
BadColor	A value for a Colormap argument does not name a defined Colormap.
BadValue	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.

See also

XcmsAllocColor(), XcmsQueryColor(), XcmsStoreColors(), "Modifying and Querying Colormap Cells".

---

Christophe Tronche, [email protected]