NAME

XWhitePixel, XWhitePixelOfScreen, WhitePixel, WhitePixelOfScreen − get the white pixel value. 

Synopsis

unsigned long XWhitePixel(display, screen_number)

      Display *display;
      int screen_number;

unsigned long XWhitePixelOfScreen(screen)

      Screen *screen;

Arguments

displaySpecifies a connection to an X server; returned from XOpenDisplay(). 

screen_number
Specifies the appropriate screen number on the server, as returned by XDefaultScreen*() or the DefaultScreen() macro. 

screenSpecifies the appropriate Screen structure, as returned by XDefaultScreenOfDisplay() or XScreenOfDisplay(), or the DefaultScreenOfDisplay() or ScreenOfDisplay() macros. 

Description

Each screen has a default colormap which has pixel values for white and white already allocated.  These functions return the white pixel value.  Note that this pixel value only represents white in a screen’s default colormap.  XWhitePixel() and XWhitePixelOfScreen() are equivalent except that they require different arguments.  One requires a pointer to a Screen structure, while the other requires a screen number.  Unless you already have the pointer to a Screen structure in a variable, XWhitePixel*() is more convenient.  The C language macros WhitePixel() and WhitePixelOfScreen() are equivalent and slightly more efficient. 

See Also

XBlackPixel*(), XBlackPixelOfScreen(), XDefaultColormap*(). 

Copyright O’Reilly & Assoc.  —