Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XmGetPixmap(3)		   Library Functions Manual		XmGetPixmap(3)

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 *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 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.

       screen	 Specifies the display screen on which the  pixmap  is	to  be
		 drawn.	 The depth of the pixmap is the	default	depth for this
		 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

       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.

       If image_name has a leading slash (/), it specifies  a  full  pathname,
       and  XmGetPixmap	 opens	the  file as specified.	 Otherwise, image_name
       specifies a filename.  In this case, XmGetPixmap	 looks	for  the  file
       along  a	 search	path specified by the XBMLANGPATH environment variable
       or by a default search path, which varies depending on whether  or  not
       the  XAPPLRESDIR	 environment variable is set.  The default search path
       contains	a lot of directories.  Therefore, XmGetPixmap will need	a rel-
       atively	long  time to search through all these directories for pixmaps
       and bitmaps. Applications that use a lot	of pixmaps  and	 bitmaps  will
       probably	 run more quickly if XBMLANGPATH is set	to a short list	of di-
       rectories.  In addition to X bitmap files (XBM),	 Motif	also  supports
       XPM  (X	Pixmap)	file formats and, from version 2.3, JPEG and PNG image
       formats.	 (Note that support of JPEG and	PNG image  format  is  an  op-
       tional  feature of Motif, in order to check if current version supports
       PNG ang JPEG image formats  the	PNG_SUPPORT  and  JPEG_SUPPORT	macros
       should be checked correspondingly.)  The	XBMLANGPATH specifies the path
       for both	XBM, XPM, PNG and JPEG files. Refer to the  XmGetPixmapByDepth
       reference page for further details.

       The XBMLANGPATH environment variable specifies a	search path for	X bit-
       map files.  It can contain the substitution field  %B,  where  the  im-
       age_name	 argument  to  XmGetPixmap is substituted for %B.  It can also
       contain the substitution	fields	accepted  by  XtResolvePathname.   The
       substitution  field  %T	is  always mapped to bitmaps, and %S is	always
       mapped to NULL.

       If XBMLANGPATH is not set but the environment variable  XAPPLRESDIR  is
       set, the	following pathnames are	searched:

	  o  %B

	  o  $XAPPLRESDIR/%L/bitmaps/%N/%B

	  o  $XAPPLRESDIR/%l_%t/bitmaps/%N/%B

	  o  $XAPPLRESDIR/%l/bitmaps/%N/%B

	  o  $XAPPLRESDIR/bitmaps/%N/%B

	  o  $XAPPLRESDIR/%L/bitmaps/%B

	  o  $XAPPLRESDIR/%l_%t/bitmaps/%B

	  o  $XAPPLRESDIR/%l/bitmaps/%B

	  o  $XAPPLRESDIR/bitmaps/%B

	  o  $HOME/bitmaps/%B

	  o  $HOME/%B

	  o  /usr/lib/X11/%L/bitmaps/%N/%B

	  o  /usr/lib/X11/%l_%t/bitmaps/%N/%B

	  o  /usr/lib/X11/%l/bitmaps/%N/%B

	  o  /usr/lib/X11/bitmaps/%N/%B

	  o  /usr/lib/X11/%L/bitmaps/%B

	  o  /usr/lib/X11/%l_%t/bitmaps/%B

	  o  /usr/lib/X11/%l/bitmaps/%B

	  o  /usr/lib/X11/bitmaps/%B

	  o  /usr/include/X11/bitmaps/%B

       If  neither XBMLANGPATH nor XAPPLRESDIR is set, the following pathnames
       are searched:

	  o  %B

	  o  $HOME/%L/bitmaps/%N/%B

	  o  $HOME/%l_%t/bitmaps/%N/%B

	  o  $HOME/%l/bitmaps/%N/%B

	  o  $HOME/bitmaps/%N/%B

	  o  $HOME/%L/bitmaps/%B

	  o  $HOME/%l_%t/bitmaps/%B

	  o  $HOME/%l/bitmaps/%B

	  o  $HOME/bitmaps/%B

	  o  $HOME/%B

	  o  /usr/lib/X11/%L/bitmaps/%N/%B

	  o  /usr/lib/X11/%l_%t/bitmaps/%N/%B

	  o  /usr/lib/X11/%l/bitmaps/%N/%B

	  o  /usr/lib/X11/bitmaps/%N/%B

	  o  /usr/lib/X11/%L/bitmaps/%B

	  o  /usr/lib/X11/%l_%t/bitmaps/%B

	  o  /usr/lib/X11/%l/bitmaps/%B

	  o  /usr/lib/X11/bitmaps/%B

	  o  /usr/include/X11/bitmaps/%B

       These paths are defaults	that vendors may change.  For example, a  ven-
       dor  may	 use  different	 directories  for  /usr/lib/X11	 and  /usr/in-
       clude/X11.

       The following substitutions are used in these paths:

       %B	 The image name, from the image_name argument

       %N	 The class name	of the application

       %L	 The display's language	string.	 This string is	influenced  by
		 XtSetLanguageProc.  The default string	is determined by call-
		 ing setlocale(LC_ALL, NULL).

       %l_%t	 The language and territory component of  the  display's  lan-
		 guage string

       %l	 The language component	of the display's language string

       The  contents  of  the  file  must  conform to the rules	for X11	bitmap
       files. In other words, Motif can	read any X11 conformant	bitmap file.

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

RELATED
       XmDestroyPixmap(3),   XmGetPixmapByDepth(3),   XmInstallImage(3),   and
       XmUninstallImage(3).

								XmGetPixmap(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN | RELATED

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XmGetPixmap&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help