XBlackPixel*() XBlackPixel*()
Name
XBlackPixel, XBlackPixelOfScreen, BlackPixel, BlackPixelOfScreen – get
the black pixel value.
Synopsis
unsigned long XBlackPixelOfScreen(screen)
Screen *screen;
unsigned long XBlackPixel(display, screen_number)
Display *display;
int screen_number;
Arguments
screen Specifies the appropriate Screen structure.
display Specifies a connection to an X server; returned from
XOpenDisplay().
screen_number
Specifies the appropriate screen number.
Returns
A pixel value.
Description
Each screen has a default colormap which has pixel values for black and
white already allocated. These functions return the black pixel value.
Note that this pixel value only represents black in a screen's default
colormap.
XBlackPixel() and XBlackPixelOfScreen() are equivalent except that they
require different arguments. One requires a pointer to a Screen struc‐
ture, while the other requires a screen number. Unless you already
have the pointer to a Screen structure in a variable, XBlackPixel*() is
more convenient.
The C language macros BlackPixel() and BlackPixelOfScreen() are equiva‐
lent and slightly more efficient.
See Also
XWhitePixel*(), XWhitePixelOfScreen(), XDefaultColormap*().
Xlib - Macro Equivalents XBlackPixel*()