XmeGetPixmapData(3X)

     NAME
          XmeGetPixmapData - Returns details about a cached pixmap

     SYNOPSIS
          #include <Xm/XmP.h>
          Boolean XmeGetPixmapData(
          Screen *screen,
          Pixmap pixmap,
          char **image_name,
          int *depth,
          Pixel *foreground,
          Pixel *background,
          int *hot_x,
          int *hot_y,
          unsigned int *width,
          unsigned int *height);

     VERSION
          This page documents Motif 2.1.

     DESCRIPTION
          Motif maintains a pixmap cache. This cache holds information
          on the pixmaps currently in use. Use XmeGetPixmapData to
          determine if a specified pixmap is currently in the pixmap
          cache. If it is, XmeGetPixmapData returns the value True and
          returns information for all eight of its output arguments.

          If pixmap is not in the pixmap cache,
          XmeGetPixmapDatafetches pixmap from the server, caches
          pixmap, and then returns False.  When XmeGetPixmapData
          returns False, only depth, width, and height are valid.

          XmeGetPixmapData is relatively efficient because it gets the
          data through a table lookup rather than through a server
          request.

          screen    Specifies a pointer to the screen.

          pixmap    Specifies the desired pixmap.

          image_name
                    Returns the image name associated with pixmap.

                    The caller must not modify or free the returned
                    data.

          depth     Returns the depth of the pixmap.

          foreground
                    Returns the foreground color associated with
                    pixmap.
          background
                    Returns the background color associated with
                    pixmap.

          hot_x     Returns the x-coordinate of the hotspot of
                    pixmapif hotspot information was stored with the
                    pixmap.

          hot_y     Returns the y-coordinate of the hotspot of
                    pixmapif hotspot information was stored with the
                    pixmap.

          width     Returns the width of pixmap.

          height    Returns the height of pixmap.

     RETURN
          Returns True if pixmap is in the image cache.  Otherwise, it
          returns False.

     RELATED
          XmGetPixmap(3).