Man page 3 : XCreateColormap

XCreateColormap, XCopyColormapAndFree, XFreeColormap, XColor - create, copy, or destroy colormaps and color structure

Colormap XCreateColormap(Display *display, Window w, Visual *visual, int alloc); Colormap XCopyColormapAndFree(Display *display, Colormap colormap); int XFreeColormap(Display *display, Colormap colormap);

alloc 1i Specifies the colormap entries to be allocated. You can pass .ZN AllocNone or .ZN AllocAll .

colormap 1i Specifies the colormap \*(Cm.

display 1i Specifies the connection to the X server.

visual 1i Specifies a visual type supported on the screen. If the visual type is not one supported by the screen, a .ZN BadMatch error results.

w 1i Specifies the window \*(Wi.

The .ZN XCreateColormap function creates a colormap of the specified visual type for the screen on which the specified window resides and returns the colormap ID associated with it. Note that the specified window is only used to determine the screen.

The initial values of the colormap entries are undefined for the visual classes .ZN GrayScale , .ZN PseudoColor , and .ZN DirectColor . For .ZN StaticGray , .ZN StaticColor , and .ZN TrueColor , the entries have defined values, but those values are specific to the visual and are not defined by X. For .ZN StaticGray , .ZN StaticColor , and .ZN TrueColor , alloc must be .ZN AllocNone , or a .ZN BadMatch error results. For the other visual classes, if alloc is .ZN AllocNone , the colormap initially has no allocated entries, and clients can allocate them. For information about the visual types, see section 3.1.

If alloc is .ZN AllocAll , the entire colormap is allocated writable. The initial values of all allocated entries are undefined. For .ZN GrayScale and .ZN PseudoColor , the effect is as if an .ZN XAllocColorCells call returned all pixel values from zero to N - 1, where N is the colormap entries value in the specified visual. For .ZN DirectColor , the effect is as if an .ZN XAllocColorPlanes call returned a pixel value of zero and red_mask, green_mask, and blue_mask values containing the same bits as the corresponding masks in the specified visual. However, in all cases, none of these entries can be freed by using .ZN XFreeColors .

.ZN XCreateColormap can generate .ZN BadAlloc , .ZN BadMatch , .ZN BadValue , and .ZN BadWindow errors.

The .ZN XCopyColormapAndFree function creates a colormap of the same visual type and for the same screen as the specified colormap and returns the new colormap ID. It also moves all of the client's existing allocation from the specified colormap to the new colormap with their color values intact and their read-only or writable characteristics intact and frees those entries in the specified colormap. Color values in other entries in the new colormap are undefined. If the specified colormap was created by the client with alloc set to .ZN AllocAll , the new colormap is also created with .ZN AllocAll , all color values for all entries are copied from the specified colormap, and then all entries in the specified colormap are freed. If the specified colormap was not created by the client with .ZN AllocAll , the allocations to be moved are all those pixels and planes that have been allocated by the client using .ZN XAllocColor , .ZN XAllocNamedColor , .ZN XAllocColorCells , or .ZN XAllocColorPlanes and that have not been freed since they were allocated.

.ZN XCopyColormapAndFree can generate .ZN BadAlloc and .ZN BadColor errors.

The .ZN XFreeColormap function deletes the association between the colormap resource ID and the colormap and frees the colormap storage. However, this function has no effect on the default colormap for a screen. If the specified colormap is an installed map for a screen, it is uninstalled (see .ZN XUninstallColormap ). If the specified colormap is defined as the colormap for a window (by .ZN XCreateWindow , .ZN XSetWindowColormap , or .ZN XChangeWindowAttributes ), .ZN XFreeColormap changes the colormap associated with the window to .ZN None and generates a .ZN ColormapNotify event. X does not define the colors displayed for a window with a colormap of .ZN None .

.ZN XFreeColormap can generate a .ZN BadColor error.

The .ZN XColor structure contains:

.TA .5i 2.5i .5i 2.5i typedef struct { unsigned long pixel; /* pixel value */ unsigned short red, green, blue; /* rgb values */ char flags; /* DoRed, DoGreen, DoBlue */ char pad; } XColor; .De

The red, green, and blue values are always in the range 0 to 65535 inclusive, independent of the number of bits actually used in the display hardware. The server scales these values down to the range used by the hardware. Black is represented by (0,0,0), and white is represented by (65535,65535,65535). In some functions, the flags member controls which of the red, green, and blue members is used and can be the inclusive OR of zero or more of .ZN DoRed , .ZN DoGreen , and .ZN DoBlue .

• .ZN BadAlloc
   The server failed to allocate the requested resource or server memory.
• .ZN BadColor
   A value for a Colormap argument does not name a defined Colormap.
• .ZN BadMatch
   An .ZN InputOnly window is used as a Drawable.
• .ZN BadMatch
   Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.
• .ZN 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.
• .ZN BadWindow
   A value for a Window argument does not name a defined Window.

XAllocColor(3), XChangeWindowAttributes(3), XCreateWindow(3), XQueryColor(3), XStoreColors(3)
\*(xL