XcmsQueryColors

Syntax

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 color specification array.
result_format	Specifies the color format for the returned color specification.

Description

The XcmsQueryColors() function obtains the RGB values for pixel values in the pixel members of XcmsColor structures and then converts the values to the target format as 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.

XcmsQueryColors() can generate BadColor and BadValue errors.

Diagnostics

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(), XcmsLookupColor(), XcmsQueryColor(), XcmsStoreColor(), "Modifying and Querying Colormap Cells".

---

Christophe Tronche, [email protected]