XFreeColors
Syntax
XFreeColors(display, colormap, pixels, npixels, planes)
Display *display;
Colormap colormap;
unsigned long pixels[];
int npixels;
unsigned long planes;
Arguments
| display
| Specifies the connection to the X server.
|
| colormap
| Specifies the colormap.
|
| pixels
| Specifies an array of pixel values that map to the cells in the specified colormap.
|
| npixels
| Specifies the number of pixels.
|
| planes
| Specifies the planes you want to free.
|
Description
The
XFreeColors()
function frees the cells represented by pixels whose values are in the
pixels array.
The planes argument should not have any bits set to 1 in common with any of the
pixels.
The set of all pixels is produced by ORing together subsets of
the planes argument with the pixels.
The request frees all of these pixels that
were allocated by the client (using
XAllocColor(),
XAllocNamedColor(),
XAllocColorCells(),
and
XAllocColorPlanes()).
Note that freeing an
individual pixel obtained from
XAllocColorPlanes()
may not actually allow
it to be reused until all of its related pixels are also freed.
Similarly,
a read-only entry is not actually freed until it has been freed by all clients,
and if a client allocates the same read-only entry multiple times,
it must free the entry that many times before the entry is actually freed.
All specified pixels that are allocated by the client in the colormap are
freed, even if one or more pixels produce an error.
If a specified pixel is not a valid index into the colormap, a
BadValue
error results.
If a specified pixel is not allocated by the
client (that is, is unallocated or is only allocated by another client)
or if the colormap was created with all entries writable (by passing
AllocAll
to
XCreateColormap()),
a
BadAccess
error results.
If more than one pixel is in error,
the one that gets reported is arbitrary.
XFreeColors()
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
XAllocColor(),
XAllocColorCells(),
XAllocColorPlanes(),
XAllocNamedColor(),
XCreateColormap(),
XQueryColor(),
XStoreColors(),
"
Allocating and Freeing Color Cells".
Christophe Tronche, [email protected]
