LEARN ABOUT HPUX
xcmsstoreca
XcmsStoreColor() XcmsStoreColor()
Name
XcmsStoreColor - store a specified color into a read/write colormap cell.
Synopsis
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.
Returns
Zero on failure, non-zero on success.
Availability
Release 5 and later.
Description
XcmsStoreColor() converts the color specified in the XcmsColor structure into RGB values and 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 vis-
ible immediately.
Note that XStoreColor() does not return a Status therefore this function's return status can only indicate if a color conversion was suc-
cessful and the call to XStoreColor() was made. XcmsStoreColor() returns XcmsSuccess if it succeeded in converting the color specification
and called XStoreColor(). It returns XcmsSuccessWithCompression if it converted the requested device-independent color to the device RGB
color space with gamut compression and completed the call to XStoreColor(). It returns XcmsFailure if it could not convert the specified
color at all. 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.
Errors
BadAccess The specified colormap cell was read-only.
BadColor The colormap argument does not name a defined colormap.
BadValue The specified pixel does not represent a valid color cell in the specified colormap.
Structures
The XcmsColor structure and XcmsColorFormat type are shown on the XcmsColor reference page.
See Also
XcmsAllocColor(), XcmsAllocNamedColor(), XcmsLookupColor(), XcmsQueryColor(), XcmsQueryColors(), XcmsStoreColors(), XcmsStoreNamedColor,
XAllocColor(), XAllocNamedColor(), XLookupColor(), XParseColor(), XQueryColor(), XQueryColors(), XStoreColor(), XStoreColors().
Xlib - Device-independent Color XcmsStoreColor()
06-16-2010
Colibri 1.1.1
About Colibri