XReadBitmapFile(), XWriteBitmapFile(), XCreatePixmapFromBitmapData(), XCreateBitmapFromData() - manipulate bitmaps
int XReadBitmapFile (Display *display, Drawable d,
char *filename, unsigned int *width_return,
unsigned int *height_return,
Pixmap *bitmap_return, int *x_hot_return,
int *y_hot_return)
int XWriteBitmapFile (Display *display, char *filename,
Pixmap bitmap, unsigned int width,
unsigned int height, int x_hot,
int y_hot)
Pixmap XCreatePixmapFromBitmapData (Display *display, Drawable d,
char *data,
unsigned int width,
unsigned int height,
unsigned long fg,
unsigned long bg,
unsigned int depth)
Pixmap XCreateBitmapFromData (Display *display, Drawable d,
char *data, unsigned int width,
unsigned int height)
The XReadBitmapFile(3) function reads in a file containing a bitmap. The file is parsed in the encoding of the current locale. The ability to read other than the standard format is implementation dependent. If the file cannot be opened, XReadBitmapFile(3) returns BitmapOpenFailed. If the file can be opened but does not contain valid bitmap data, it returns BitmapFileInvalid. If insufficient working storage is allocated, it returns BitmapNoMemory. If the file is readable and valid, it returns BitmapSuccess.
XReadBitmapFile(3) returns the bitmap's height and width, as read from the file, to width_return and height_return. It then creates a pixmap of the appropriate size, reads the bitmap data from the file into the pixmap, and assigns the pixmap to the caller's variable bitmap. The caller must free the bitmap using XFreePixmap(3) when finished. If <name>_x_hot and <name>_y_hot exist, XReadBitmapFile(3) returns them to x_hot_return and y_hot_return; otherwise, it returns -1,-1.
XReadBitmapFile(3) can generate BadAlloc and BadDrawable errors.
The XWriteBitmapFile(3) function writes a bitmap out to a file in the X version 11 format. The file is written in the encoding of the current locale. If the file cannot be opened for writing, it returns BitmapOpenFailed. If insufficient memory is allocated, XWriteBitmapFile(3) returns BitmapNoMemory; otherwise, on no error, it returns BitmapSuccess. If x_hot and y_hot are not -1, -1, XWriteBitmapFile(3) writes them out as the hotspot coordinates for the bitmap.
XWriteBitmapFile(3) can generate BadDrawable and BadMatch errors.
The XCreatePixmapFromBitmapData(3) function creates a pixmap of the given depth and then does a bitmap-format XPutImage(3) of the data into it. The depth must be supported by the screen of the specified drawable, or a BadMatch error results.
XCreatePixmapFromBitmapData(3) can generate BadAlloc and BadMatch errors.
The XCreateBitmapFromData(3) function allows you to include in your C program (using #include) a bitmap file that was written out by XWriteBitmapFile(3) (X version 11 format only) without reading in the bitmap file. The following example creates a gray bitmap:
#include "gray.bitmap"
Pixmap bitmap;
bitmap = XCreateBitmapFromData(display, window,
gray_bits, gray_width, gray_height);
If insufficient working storage was allocated, XCreateBitmapFromData(3) returns None. It is your responsibility to free the bitmap using XFreePixmap(3) when finished.
XCreateBitmapFromData(3) can generate a BadAlloc error.
Xlib