Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   10987 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

XcmsStoreColor()					      XcmsStoreColor()

Name
  XcmsStoreColor  –  store  a  specified color into a read/write colormap
  cell.

Synopsis
  Status XcmsStoreColor(display, colormap, color)
	Display *display;
	Colormap colormap;
	XcmsColor *color;

Arguments
  display   Specifies the connection to the X server.

  colormap  Specifies the colormap.

  color	    Specifies the color cell and  the  color  to  store.   Values
	    specified  in  this XcmsColor structure remain unchanged upon
	    return.

Returns
  Zero on failure, non-zero on success.

Availability
  Release 5 and later.

Description
  XcmsStoreColor() converts the color specified in the	XcmsColor  struc‐
  ture	into RGB values and 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 unallo‐
  cated 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() does not return a Status therefore  this  func‐
  tion's  return  status can only indicate if a color conversion was suc‐
  cessful and the  call	 to  XStoreColor()  was	 made.	 XcmsStoreColor()
  returns  XcmsSuccess if it succeeded in converting the color specifica‐
  tion and called XStoreColor().  It  returns  XcmsSuccessWithCompression
  if  it  converted  the requested device-independent color to the device
  RGB color space with	gamut  compression  and	 completed  the	 call  to
  XStoreColor().   It  returns	XcmsFailure  if	 it could not convert the
  specified color at all.  To obtain the actual color stored,  use  Xcms‐
  QueryColor().	  Due  to the screen's hardware limitations or gamut com‐
  pression, the color stored in the colormap may not be identical to  the
  color specified.

Errors
  BadAccess The specified colormap cell was read-only.

  BadColor  The colormap argument does not name a defined colormap.

  BadValue  The	 specified pixel does not represent a valid color cell in
	    the specified colormap.

Structures
  The XcmsColor structure and XcmsColorFormat type are shown on the Xcms‐
  Color reference page.

See Also
  XcmsAllocColor(),  XcmsAllocNamedColor(), XcmsLookupColor(), XcmsQuery‐
  Color(),  XcmsQueryColors(),	XcmsStoreColors(),   XcmsStoreNamedColor,
  XAllocColor(),   XAllocNamedColor(),	 XLookupColor(),   XParseColor(),
  XQueryColor(), XQueryColors(), XStoreColor(), XStoreColors().

Xlib - Device-independent Color				      XcmsStoreColor()

Vote for polarhome