XcmsStoreColor(3X11) X11R5 XcmsStoreColor(3X11)NAME
XcmsStoreColor, XcmsStoreColors - set colors
SYNTAX
Status XcmsStoreColor(display, colormap, color)
Display *display;
Colormap colormap;
XcmsColor *color;
Status XcmsStoreColors(display, colormap, colors, ncolors, compres‐
sion_flags_return)
Display *display;
Colormap colormap;
XcmsColor colors[];
int ncolors;
Bool compression_flags_return[];
ARGUMENTS
display Specifies the connection to the X server.
color Specifies the color cell and the color to store. Values
specified in this structure remain unchanged upon return.
colors Specifies the color specification array of structures, each
specifying a color cell and the color to store in that cell.
Values specified in the array remain unchanged upon return.
colormap Specifies the colormap.
compression_flags_return
Specifies an array of Boolean values for returning compres‐
sion status. If a non-NULL pointer is supplied, each element
of the array is set to if the corresponding color was com‐
pressed, and otherwise. Pass NULL if the compression status
is not useful.
ncolors Specifies the number of structures in the color specification
array.
DESCRIPTION
The function converts the color specified in the structure into RGB
values and then uses this RGB specification in an structure, whose
three flags and are set, in a call to to change the color cell speci‐
fied by the pixel member of the 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 error results. If the color cell is unallocated or is
allocated read-only, a error results. If the colormap is an installed
map for its screen, the changes are visible immediately.
Note that has no return value; therefore, a return value from this
function indicates that the conversion to RGB succeeded and the call to
was made. To obtain the actual color stored, use Due to the screen's
hardware limitations or gamut compression, the color stored in the col‐
ormap may not be identical to the color specified.
can generate and errors.
The function converts the colors specified in the array of structures
into RGB values and then uses these RGB specifications in an struc‐
tures, whose three flags and are set, in a call to to change the color
cells specified by the pixel member of the corresponding 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 error results. If a color
cell is unallocated or is allocated read-only, a error results. If
more than one pixel is in error, the one that gets reported is arbi‐
trary. If the colormap is an installed map for its screen, the changes
are visible immediately.
Note that has no return value; therefore, a return value from this
function indicates that conversions to RGB succeeded and the call to
was made. To obtain the actual colors stored, use Due to the screen's
hardware limitations or gamut compression, the colors stored in the
colormap may not be identical to the colors specified.
can generate and errors.
DIAGNOSTICS
A client attempted
to free a color map entry that it did not already allocate.
A client attempted
to store into a read-only color map entry.
A value for a Colormap argument does not name a defined Colormap.
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 ALSOXcmsAllocColor(3X11), XcmsQueryColor(3X11)
Xlib - C Language X Interface
XcmsStoreColor(3X11)
