XReadBitmapFile, XReadBitmapFileData, 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 XReadBitmapFileData(char *filename, unsigned int *width_return, unsigned int *height_return, unsigned char *data_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);



Specifies the bitmap.


Returns the bitmap that is created.


Specifies the drawable that indicates the screen.


Specifies the data in bitmap format.


Specifies the location of the bitmap data.


Returns the bitmap data.


Specifies the depth of the pixmap.


Specifies the connection to the X server.



Specify the foreground and background pixel values to use.


Specifies the file name to use. The format of the file name is operating-system dependent.



Specify the width and height.


Return the width and height values of the read in bitmap file.



Specify where to place the hotspot coordinates (or −1,−1 if none are present) in the file.


Return the hotspot coordinates.


The XReadBitmapFile 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 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 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 when finished. If name_x_hot and name_y_hot exist, XReadBitmapFile returns them to x_hot_return and y_hot_return; otherwise, it returns −1,−1.

XReadBitmapFile can generate BadAlloc and BadDrawable errors.

The XReadBitmapFileData function reads in a file containing a bitmap, in the same manner as XReadBitmapFile, but returns the data directly rather than creating a pixmap in the server. The bitmap data is returned in data_return; the client must free this storage when finished with it by calling XFree. The status and other return values are the same as for XReadBitmapFile.

The XWriteBitmapFile function writes a bitmap out to a file in the X Version 11 format. The name used in the output file is derived from the file name by deleting the directory prefix. 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 returns BitmapNoMemory; otherwise, on no error, it returns BitmapSuccess. If x_hot and y_hot are not −1, −1, XWriteBitmapFile writes them out as the hotspot coordinates for the bitmap.

XWriteBitmapFile can generate BadDrawable and BadMatch errors.

The XCreatePixmapFromBitmapData function creates a pixmap of the given depth and then does a bitmap-format XPutImage of the data into it. The depth must be supported by the screen of the specified drawable, or a BadMatch error results.

XCreatePixmapFromBitmapData can generate BadAlloc and BadMatch errors.

The XCreateBitmapFromData function allows you to include in your C program (using #include) a bitmap file that was written out by XWriteBitmapFile (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 returns None. It is your responsibility to free the bitmap using XFreePixmap when finished.

XCreateBitmapFromData can generate a BadAlloc error.



The server failed to allocate the requested resource or server memory.


A value for a Drawable argument does not name a defined Window or Pixmap.


An InputOnly window is used as a Drawable.


XCreatePixmap(3), XPutImage(3)
Xlib − C Language X Interface

More Linux Commands

getopt_long_only(3) - Parse command-line options (Man Page)
The getopt() function parses the command-line arguments. Its arguments argc and argv are the argument count and array as passed to the main() function on progra

vipw(8) - edit the password, group or shadow file (ManPage)
The vipw and vigr commands edits the files /etc/passwd and /etc/group, respectively. With the -s flag, they will edit the shadow versions of those files, /etc/s

optionOnlyUsage(3) Print usage text for just the options....
This routine will print only the usage for each option. This function may be used when the emitted usage must incorporate information not available to AutoOpts.

glEvalCoord2fv(3gl) - evaluate enabled one- and two-dimensio
glEvalCoord1 evaluates enabled one-dimensional maps at argument u. glEvalCoord2 does the same for two-dimensional maps using two domain values, u and v. To defi

XkbGetNameChanges(3) - Update the local copy of the keyboard
XkbGetNameChanges examines the changes parameter, retrieves the necessary information from the server, and places the results into the xkb keyboard description.

catanhl(3) - complex arc tangents hyperbolic (Man Page).....
The catanh() function calculates the complex arc hyperbolic tangent of z. If y = catanh(z), then z = ctanh(y). The imaginary part of y is chosen in the interval

smi_class(3) - (unknown subject) (Library - Linux man page)
These functions retrieve information on a SMIng class definition (SMIng). smiGetClass(SmiModule *smiModulePtr,char *name) returns a pointer to struct SmiClass t

SDL_SetColors(3) - Sets a portion of the colormap for the gi
Sets a portion of the colormap for the given 8-bit surface. When surface is the surface associated with the current display, the display colormap will be update

pam_env.conf(5) - the environment variables config file.....
The /etc/security/pam_env.conf file specifies the environment variables to be set, unset or modified by pam_env(8). When someone logs in, this file is read and

rpmspec(8) - RPM Spec Tool (Administration - Linux man page)
rpmspec {-q|--query} [select-options] [query-options] SPEC_FILE ... select-options [-rpms] [-srpms] query-options [--qf,--queryformat QUERYFMT] ..............

my_print_defaults(1) - display options from option files....
my_print_defaults displays the options that are present in option groups of option files. The output indicates what options will be used by programs that read t

cleanlinks(1) - remove dangling symbolic links and empty dir
The cleanlinks program searches the directory tree descended from the current directory for symbolic links whose targets do not exist, and removes them. It then

We can't live, work or learn in freedom unless the software we use is free.