XAllocStandardColormap man page on Ultrix

Man page or keyword search:  
man Server   3690 pages
apropos Keyword Search (all sections)
Output format
Ultrix logo
[printable version]

XAllocStandardColormap(3X11)	     X11R5	  XAllocStandardColormap(3X11)

NAME
       XAllocStandardColormap, XSetRGBColormaps, XGetRGBColormaps, XStandard‐
       Colormap - allocate, set, or read a standard colormap structure

SYNTAX
       XStandardColormap *XAllocStandardColormap()

       void XSetRGBColormaps(display, w, std_colormap, count, property)
	     Display *display;
	     Window w;
	     XStandardColormap *std_colormap;
	     int count;
	     Atom property;

       Status XGetRGBColormaps(display, w, std_colormap_return, count_return,
       property)
	     Display *display;
	     Window w;
	     XStandardColormap **std_colormap_return;
	     int *count_return;
	     Atom property;

ARGUMENTS
       display	 Specifies the connection to the X server.

       count	 Specifies the number of colormaps.

       count_return
		 Returns the number of colormaps.

       property	 Specifies the property name.

       std_colormap
		 Specifies the structure to be used.

       std_colormap_return
		 Returns the structure.

DESCRIPTION
       The function allocates and returns a pointer to a structure.  Note that
       all fields in the structure are initially set to zero.  If insufficient
       memory is available, returns NULL.  To free the memory allocated to
       this structure, use

       The function replaces the RGB colormap definition in the specified
       property on the named window.  If the property does not already exist,
       sets the RGB colormap definition in the specified property on the named
       window.	The property is stored with a type of RGB_COLOR_MAP and a for‐
       mat of 32.  Note that it is the caller's responsibility to honor the
       ICCCM restriction that only RGB_DEFAULT_MAP contain more than one defi‐
       nition.

       The function usually is only used by window or session managers.	 To
       create a standard colormap, follow this procedure:

       1.   Open a new connection to the same server.

       2.   Grab the server.

       3.   See if the property is on the property list of the root window for
	    the screen.

       4.   If the desired property is not present:

	    ·	 Create a colormap (unless using the default colormap of the
		 screen).

	    ·	 Determine the color characteristics of the visual.

	    ·	 Call or to allocate cells in the colormap.

	    ·	 Call to store appropriate color values in the colormap.

	    ·	 Fill in the descriptive members in the structure.

	    ·	 Attach the property to the root window.

	    ·	 Use to make the resource permanent.

       5.   Ungrab the server.

       can generate and errors.

       The function returns the RGB colormap definitions stored in the speci‐
       fied property on the named window.  If the property exists, is of type
       RGB_COLOR_MAP, is of format 32, and is long enough to contain a col‐
       ormap definition, allocates and fills in space for the returned col‐
       ormaps and returns a nonzero status.  If the visualid is not present,
       assumes the default visual for the screen on which the window is
       located; if the killid is not present, is assumed, which indicates that
       the resources cannot be released.  Otherwise, none of the fields are
       set, and returns a zero status.	Note that it is the caller's responsi‐
       bility to honor the ICCCM restriction that only RGB_DEFAULT_MAP contain
       more than one definition.

       can generate and errors.

STRUCTURES
       The structure contains:

       /* Hints */

       #define	     ( (XID) 1L)
       /* Values */

       typedef struct {
	       Colormap colormap;
	       unsigned long red_max;
	       unsigned long red_mult;
	       unsigned long green_max;
	       unsigned long green_mult;
	       unsigned long blue_max;
	       unsigned long blue_mult;
	       unsigned long base_pixel;
	       VisualID visualid;
	       XID killid;
       } XStandardColormap;

       The colormap member is the colormap created by the function.  The
       red_max, green_max, and blue_max members give the maximum red, green,
       and blue values, respectively.  Each color coefficient ranges from zero
       to its max, inclusive.  For example, a common colormap allocation is
       3/3/2 (3 planes for red, 3 planes for green, and 2 planes for blue).
       This colormap would have red_max = 7, green_max = 7, and blue_max = 3.
       An alternate allocation that uses only 216 colors is red_max = 5,
       green_max = 5, and blue_max = 5.

       The red_mult, green_mult, and blue_mult members give the scale factors
       used to compose a full pixel value.  (See the discussion of the
       base_pixel members for further information.)  For a 3/3/2 allocation,
       red_mult might be 32, green_mult might be 4, and blue_mult might be 1.
       For a 6-colors-each allocation, red_mult might be 36, green_mult might
       be 6, and blue_mult might be 1.

       The base_pixel member gives the base pixel value used to compose a full
       pixel value.  Usually, the base_pixel is obtained from a call to the
       function.  Given integer red, green, and blue coefficients in their
       appropriate ranges, one then can compute a corresponding pixel value by
       using the following expression:

       (r * red_mult + g * green_mult + b * blue_mult + base_pixel) & 0xFFFFFFFF

       For colormaps, only the colormap, red_max, red_mult, and base_pixel
       members are defined.  The other members are ignored.  To compute a
       pixel value, use the following expression:

       (gray * red_mult + base_pixel) & 0xFFFFFFFF

       Negative multipliers can be represented by converting the 2's comple‐
       ment representation of the multiplier into an unsigned long and storing
       the result in the appropriate _mult field.  The step of masking by
       0xFFFFFFFF effectively converts the resulting positive multiplier into
       a negative one.	The masking step will take place automatically on many
       machine architectures, depending on the size of the integer type used
       to do the computation.

       The visualid member gives the ID number of the visual from which the
       colormap was created.  The killid member gives a resource ID that indi‐
       cates whether the cells held by this standard colormap are to be
       released by freeing the colormap ID or by calling the function on the
       indicated resource.  (Note that this method is necessary for allocating
       out of an existing colormap.)

       The properties containing the information have the type RGB_COLOR_MAP.

DIAGNOSTICS
       The server failed to allocate the requested resource or server memory.

       A value for an Atom argument does not name a defined Atom.

       A value for a Window argument does not name a defined Window.

SEE ALSO
       XAllocColor(3X11), XCreateColormap(3X11), XFree(3X11), XSetCloseDown‐
       Mode(3X11)
       Xlib - C Language X Interface

						  XAllocStandardColormap(3X11)
[top]

List of man pages available for Ultrix

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net