XcmsQueryColors() XcmsQueryColors()
Name
XcmsQueryColors - obtain the color specifications of the specified colorcells.
Synopsis
Status XcmsQueryColors(display, colormap, colors_in_out, ncolors,
result_format)
Display *display;
Colormap colormap;
XcmsColor *colors_in_out[];
unsigned int ncolors;
XcmsColorFormat result_format;
Arguments
display Specifies the connection to the X server.
colormap Specifies the colormap.
colors_in_out
Specifies an array of XcmsColor structures, each pixel member indicating the color cell to query. The color specifications for
the color cells are returned in these structures.
ncolors Specifies the number of XcmsColor structures in the colors_in_out array.
result_format
Specifies the desired color format for the returned color specifications.
Returns
Zero on failure, non-zero on success.
Availability
Release 5 and later.
Description
XcmsQueryColors() obtains the RGB values for the colors stored in the colormap cells specified by the pixel fields of the specified Xcms-
Color structures, and then converts the values to the target format specified by the result_format argument. If a pixel is not a valid
index into the specified colormap, a BadValue error results. If more than one pixel is in error, the one that gets reported is arbitrary.
Errors
BadColor The colormap argument does not name a defined Colormap.
BadValue A 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(), XcmsStoreColor(), XcmsStoreColors(), XcmsStoreNamedColor, XcmsQueryColor(), XcmsLookupColor(),
XAllocColor(), XAllocNamedColor(), XQueryColor(), XQueryColors(), XStoreColor(), XStoreColors().
Xlib - Device-independent Color XcmsQueryColors()
