XcmsStoreColor man page on BSDOS

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



XcmsStoreColor(3X11)	XLIB FUNCTIONS	   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,
       compression_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 XcmsColor structure
		 remain unchanged on return.

       colors	Specifies the color specification array of Xcms-
		 Color 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
		 Returns an array of Boolean values indicating
		 compression status.  If a non-NULL pointer is
		 supplied, each element of the array is set to
		 True if the corresponding color was compressed
		 and False otherwise.  Pass NULL if the compres-
		 sion status is not useful.

       ncolors	Specifies the number of XcmsColor structures in
		 the color-specification array.

DESCRIPTION
       The XcmsStoreColor function converts the color specified
       in the XcmsColor structure into RGB values.  It then uses
       this RGB specification in an XColor structure, whose three
       flags (DoRed, DoGreen, and DoBlue) are set, in a call to
       XStoreColor to change the color cell specified by the
       pixel member of the XcmsColor 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 BadValue error results.  If the color cell is

X Version 11		Release 6.4				1

XcmsStoreColor(3X11)	XLIB FUNCTIONS	   XcmsStoreColor(3X11)

       unallocated or is allocated read-only, a BadAccess error
       results. If the colormap is an installed map for its
       screen, the changes are visible immediately.

       Note that XStoreColor has no return value; therefore, an
       XcmsSuccess return value from this function indicates that
       the conversion to RGB succeeded and the call to XStore-
       Color was made.	To obtain the actual color stored, use
       XcmsQueryColor.	Because of the screen's hardware limita-
       tions or gamut compression, the color stored in the col-
       ormap may not be identical to the color specified.

       XcmsStoreColor can generate BadAccess, BadColor, and Bad-
       Value errors.

       The XcmsStoreColors function converts the colors specified
       in the array of XcmsColor structures into RGB values and
       then uses these RGB specifications in XColor structures,
       whose three flags (DoRed, DoGreen, and DoBlue) are set, in
       a call to XStoreColors to change the color cells specified
       by the pixel member of the corresponding XcmsColor struc-
       ture.  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 BadValue error results.	If a
       color cell is unallocated or is allocated read-only, a
       BadAccess error results. If more than one pixel is in
       error, the one that gets reported is arbitrary.	If the
       colormap is an installed map for its screen, the changes
       are visible immediately.

       Note that XStoreColors has no return value; therefore, an
       XcmsSuccess return value from this function indicates that
       conversions to RGB succeeded and the call to XStoreColors
       was made.  To obtain the actual colors stored, use
       XcmsQueryColors. Because of the screen's hardware limita-
       tions or gamut compression, the colors stored in the col-
       ormap may not be identical to the colors specified.

       XcmsStoreColors can generate BadAccess, BadColor, and Bad-
       Value 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

X Version 11		Release 6.4				2

XcmsStoreColor(3X11)	XLIB FUNCTIONS	   XcmsStoreColor(3X11)

		 values accepted by the request.  Unless a spe-
		 cific 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
       XcmsAllocColor(3X11), XcmsQueryColor(3X11)
       Xlib - C Language X Interface

X Version 11		Release 6.4				3

[top]
                             _         _         _ 
                            | |       | |       | |     
                            | |       | |       | |     
                         __ | | __ __ | | __ __ | | __  
                         \ \| |/ / \ \| |/ / \ \| |/ /  
                          \ \ / /   \ \ / /   \ \ / /   
                           \   /     \   /     \   /    
                            \_/       \_/       \_/ 
More information is available in HTML format for server BSDOS

List of man pages available for BSDOS

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