XcmsAllocColor(3X11)          SDK X11 R4.11MU05         XcmsAllocColor(3X11)


NAME
       XcmsAllocColor, XcmsAllocNamedColor - allocate colors

SYNTAX
       Status XcmsAllocColor(display, colormap, colorinout, resultformat)
             Display *display;
             Colormap colormap;
             XcmsColor *colorinout;
             XcmsColorFormat resultformat;

       Status XcmsAllocNamedColor(display, colormap, colorstring,
       resultformat, colorscreenreturn,
                                   colorexactreturn)
             Display *display;
             Colormap colormap;
             char *colorstring;
             XcmsColorFormat resultformat;
             XcmsColor *colorscreenreturn;
             XcmsColor *colorexactreturn;

ARGUMENTS
       display   Specifies the connection to the X server.

       colormap  Specifies the colormap.

       colorexactreturn
                 Returns the color specification parsed from the color
                 string or parsed from the corresponding string found in a
                 color name database.

       colorinout
                 Specifies the color to allocate and returns the pixel and
                 color that is actually used in the colormap.

       colorscreenreturn
                 Returns the pixel value of the color cell and color
                 specification that actually is stored for that cell.

       colorstring
                 Specifies the color string whose color definition structure
                 is to be returned.

       resultformat
                 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 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, then finally passed to the 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.


       XcmsAllocNamedColor can generate a BadColor errors.

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

SEE ALSO
       XcmsQueryColor(3X11), XcmsStoreColor(3X11)
       Xlib - C Language X Interface


Licensed material--property of copyright holder(s)