OSF

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;
Pixelforeground;
Pixelbackground;

DESCRIPTION

XmGetPixmap uses the parameter data to perform a lookup in the pixmap cache to see if a pixmap has already been generated that 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 filename, 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.  If XBMLANGPATH is not set but the environment variable XAPPLRESDIR is set, the following path names are searched:   %B
$XAPPLRESDIR/%L/bitmaps/%N/%B
$XAPPLRESDIR/%l/bitmaps/%N/%B
$XAPPLRESDIR/bitmaps/%N/%B
$XAPPLRESDIR/%L/bitmaps/%B
$XAPPLRESDIR/%l/bitmaps/%B
$XAPPLRESDIR/bitmaps/%B
$HOME/%B
/usr/lib/X11/%L/bitmaps/%N/%B
/usr/lib/X11/%l/bitmaps/%N/%B
/usr/lib/X11/bitmaps/%N/%B
/usr/lib/X11/%L/bitmaps/%B
/usr/lib/X11/%l/bitmaps/%B
/usr/lib/X11/bitmaps/%B
/usr/include/X11/bitmaps/%B

If neither XBMLANGPATH nor XAPPLRESDIR is set, the following path names are searched:   %B
$HOME/%L/bitmaps/%N/%B
$HOME/%l/bitmaps/%N/%B
$HOME/bitmaps/%N/%B
$HOME/%L/bitmaps/%B
$HOME/%l/bitmaps/%B
$HOME/bitmaps/%B
$HOME/%B
/usr/lib/X11/%L/bitmaps/%N/%B
/usr/lib/X11/%l/bitmaps/%N/%B
/usr/lib/X11/bitmaps/%N/%B
/usr/lib/X11/%L/bitmaps/%B
/usr/lib/X11/%l/bitmaps/%B
/usr/lib/X11/bitmaps/%B
/usr/include/X11/bitmaps/%B

The following substitutions are used in these paths:

%BThe image name, from the image_name argument. 

%NThe class_name of the application. 

%LThe value of the LANG environment variable. 

%lThe language component of the LANG environment variable. 

Parameter descriptions are listed below:

screenSpecifies the display screen on which the pixmap is to be drawn.  The depth of the pixmap is the default depth for this screen. 

image_nameSpecifies the name of the image to be used to generate the pixmap

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

backgroundCombines 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(3X), XmInstallImage(3X), and XmUninstallImage(3X).