Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.

Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation

Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.

Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided "as is" without express or implied warranty.


XcmsAllocColor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
NAME
XcmsAllocColor, XcmsAllocNamedColor - allocate colors
SYNTAX

Status XcmsAllocColor\^(\^Display *display\^, Colormap colormap\^, XcmsColor *color_in_out\^, XcmsColorFormat result_format\^);

Status XcmsAllocNamedColor\^(\^Display *display\^, Colormap colormap\^, _Xconst char *color_string\^, XcmsColor *color_screen_return\^, XcmsColor *color_exact_return\^, XcmsColorFormat result_format\^);

ARGUMENTS
display 1i
Specifies the connection to the X server.
colormap 1i
Specifies the colormap.
color_exact_return 1i
Returns the color specification parsed from the color string or parsed from the corresponding string found in a color-name database.
color_in_out 1i
Specifies the color to allocate and returns the pixel and color that is actually used in the colormap.
color_screen_return 1i
Returns the pixel value of the color cell and color specification that actually is stored for that cell.
color_string 1i
Specifies the color string whose color definition structure is to be returned.
result_format 1i
Specifies the color format for the returned color specification.
DESCRIPTION
The XcmsAllocColor function is similar to XAllocColor except the color can be specified in any format. The XcmsAllocColor function ultimately calls XAllocColor to allocate a read-only color cell (colormap entry) with the specified color. XcmsAllocColor first converts the color specified to an RGB value and then passes this to XAllocColor . XcmsAllocColor returns the pixel value of the color cell and the color specification actually allocated. This returned color specification is the result of converting the RGB value returned by XAllocColor into the format specified with the result_format argument. If there is no interest in a returned color specification, unnecessary computation can be bypassed if result_format is set to XcmsRGBFormat . The corresponding colormap cell is read-only. If this routine returns XcmsFailure , the color_in_out color specification is left unchanged.

XcmsAllocColor can generate a BadColor errors.

The XcmsAllocNamedColor function is similar to XAllocNamedColor except that the color returned can be in any format specified. This function ultimately calls XAllocColor to allocate a read-only color cell with the color specified by a color string. The color string is parsed into an XcmsColor structure (see XcmsLookupColor ), converted to an RGB value, and finally passed to XAllocColor . If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter.

This function returns both the color specification as a result of parsing (exact specification) and the actual color specification stored (screen specification). This screen specification is the result of converting the RGB value returned by XAllocColor into the format specified in result_format. If there is no interest in a returned color specification, unnecessary computation can be bypassed if result_format is set to XcmsRGBFormat . If color_screen_return and color_exact_return point to the same structure, the pixel field will be set correctly, but the color values are undefined.

XcmsAllocNamedColor can generate a BadColor errors.

DIAGNOSTICS

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

"SEE ALSO"
XcmsQueryColor(__libmansuffix__), XcmsStoreColor(__libmansuffix__)

\*(xL