Manual pages › X Window and screen libraries (3X)

XInstCmap(3X)

control colormaps

From the original Amiga UNIX 2.1 manual. Some things it mentions may not be in this release.

NAME

XInstallColormap, XUninstallColormap, XListInstalledColormaps - control colormaps

SYNTAX

XInstallColormap(display, colormap)
      Display *display;
      Colormap colormap;

XUninstallColormap(display, colormap)
      Display *display;
      Colormap colormap;

Colormap *XListInstalledColormaps(display, w, num_return)
      Display *display;
      Window w;
      int *num_return;

ARGUMENTS

colormap  Specifies the colormap.

display   Specifies the connection to the XWIN server.

num_return

Returns the number of currently installed colormaps.

w         Specifies the window that determines the screen.

DESCRIPTION

The XInstallColormap function installs the specified color-
map for its associated screen.  All windows associated with
this colormap immediately display with true colors.  You
associated the windows with this colormap when you created
them by calling XCreateWindow, XCreateSimpleWindow,
XChangeWindowAttributes, or XSetWindowColormap.

If the specified colormap is not already an installed color-
map, the XWIN server generates a ColormapNotify event on
each window that has that colormap.  In addition, for every
other colormap that is installed as a result of a call to
XInstallColormap, the XWIN server generates a ColormapNotify
event on each window that has that colormap.

XInstallColormap can generate a BadColor error.

     The XUninstallColormap function removes the specified color-
     map from the required list for its screen.  As a result, the
     specified colormap might be uninstalled, and the XWIN server
     might implicitly install or uninstall additional colormaps.
     Which colormaps get installed or uninstalled is server-
     dependent except that the required list must remain

XWIN 3.0               Last change: 9/1/88                 .ie t

installed.

If the specified colormap becomes uninstalled, the XWIN
server generates a ColormapNotify event on each window that
has that colormap.  In addition, for every other colormap
that is installed or uninstalled as a result of a call to
XUninstallColormap, the XWIN server generates a ColormapNo-
tify event on each window that has that colormap.

XUninstallColormap can generate a BadColor error.

The XListInstalledColormaps function returns a list of the
currently installed colormaps for the screen of the speci-
fied window.  The order of the colormaps in the list is not
significant and is no explicit indication of the required
list.  When the allocated list is no longer needed, free it
by using XFree.

XListInstalledColormaps can generate a BadWindow error.

DIAGNOSTICS

BadColor  A value for a Colormap argument does not name a
          defined Colormap.

BadWindow A value for a Window argument does not name a