XmGetPixmap(3Xm)

NAME
XmGetPixmap — a pixmap caching function that generates a pixmap, stores it in a pixmap cache, and returns the pixmap.

SYNOPSIS
#include <Xm/Xm.h>

Pixmap XmGetPixmap (screen, image_name, foreground, background)
    Screen    * screen;
    char    * image_name;
    Pixel    foreground;
    Pixel    background;

DESCRIPTION
XmGetPixmap uses the parameter data to perform a lookup in the pixmap cache to see if a pixmap has already been generated which matches the data. If one is found, a reference count is incremented and the pixmap is returned. Applications should use XmDestroyPixmap when the pixmap is no longer needed.

If a pixmap is not found, image_name is used to perform a lookup in the image cache. If an image is found, it is used to generate the pixmap, which is then cached and returned.

If an image is not found, the image_name is used as a file name, and a search is made for an X10 or X11 bitmap file. If it is found, the file is read, converted into an image, and cached in the image cache. The image is then used to generate a pixmap, which is cached and returned.

Several paths are searched to find the file. The user can specify an environment variable XBMLANGPATH, which is used to generate one set of paths. See XtInitialize(3Xm) for an explanation of using this environment variable. If XBMLANGPATH is not set, the following path names are searched:
    /usr/lib/X11/%L/bitmaps/%N/%B
    /usr/lib/X11/%L/bitmaps/%B
    /usr/lib/X11/bitmaps/%B
    /usr/include/X11/bitmaps/%B

Parameter descriptions are listed below:

screen
    Specifies the display screen on which the pixmap is to be drawn and is used to ensure that the pixmap matches the visual required for the screen.

image_name
    Specifies the name of the image to be used to generate the pixmap.

foreground
    Combines the image with the foreground color to create the pixmap if the image referenced is a bit-per-pixel image.

background
    Combines the image with the background color to create the pixmap if the image referenced is a bit-per-pixel image.

RETURN VALUE
Returns a pixmap when successful; returns XmUNSPECIFIED_PIXMAP if the image corresponding to the image_name cannot be found.

RELATED INFORMATION
XmDestroyPixmap(3Xm), XmInstallImage(3Xm), and XmUninstallImage(3Xm).