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

FreeBSD Manual Pages

  
 
  

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

NAME
       XmtLookupPixmap(),   XmtLookupSimplePixmap(),  XmtLookupWidgetPixmap(),
       XmtLookupBitmap(), XmtLookupBitmask() - get a named  pixmap  or	bitmap
       from the	Xmt image cache.

SYNOPSIS
       #include	<Xmt/Pixmap.h>

       Pixmap XmtLookupPixmap(Widget w,	Visual *visual,	Colormap colormap,
		      unsigned int depth, XmtColorTable	colortable, String
		      name)

       Pixmap XmtLookupSimplePixmap(Widget w, XmtColorTable colortable,	String
		      name)

       Pixmap XmtLookupWidgetPixmap(Widget w, String name)

       Pixmap XmtLookupBitmap(Widget w,	String name)

       Pixmap XmtLookupBitmask(Widget w, String	name)

ARGUMENTS
       INPUTS

	    w	   The	widget	for  which the pixmap or bitmap	should be cre-
		   ated. This widget specifies the screen on which the	pixmap
		   should be created.

	    visual The Visual for which	the pixmap should be created.

	    colormap
		   The	Colormap  which	 should	 be used for the pixels	of the
		   pixmap.

	    depth  The depth of	the created Pixmap.

	    colortable
		   The XmtColorTable that should be used to look  up  symbolic
		   color names in XmtImage structures.

	    name   The name of the image to be looked up.

       RETURNS

	    A  multi-plane  pixmap or single-plane bitmap created as described
	    below, or None if the named	data could not be found	or  converted.
	    When  no  longer  needed, the returned Pixmap should be freed with
	    XmtReleasePixmap().

DESCRIPTION
       XmtLookupPixmap() looks up XBM or XmtImage data registered in the image
       cache with the name name. If no data is found, it returns None.	Other-
       wise,  it looks up and returns a	cached Pixmap containing that data for
       the screen of w and for the specified depth, visual, colormap and color
       table. If no such pixmap	is found, it creates one and adds  it  to  the
       cache.

       XmtLookupSimplePixmap()	is  a simplified version of XmtLookupPixmap().
       It uses the visual, colormap and	depth of the specified widget w.

       XmtLookupWidgetPixmap() is a further simplified version	of  XmtLookup-
       Pixmap(). Besides passing the visual, colormap, and depth of w, it also
       passes the default color	table of the application, specified by the Xmt
       colorTable application resource.

       XmtLookupBitmap()  looks	 up the	XBM data registered in the image cache
       with the	name name. If no data is found,	it returns None. Otherwise, it
       looks up	and returns a single plane Pixmap for the  screen  of  w  that
       contains	the data. If no	such pixmap already exists, it creates one and
       adds it to the cache.

       XmtLookupBitmask()  looks up the	named image in the Xmt image cache. If
       that image is XBM data that was registered with a mask, or if it	is  an
       XmtImage	 with  ``transparent'' pixels, then this function looks	up and
       returns or creates, caches and returns a	single-plane  Pixmap  for  the
       screen of w that	contains the mask data for the named image.

       When  the pixmaps returned by these functions will no longer be needed,
       they can	be released from the cache by calling XmtReleasePixmap(). This
       will decrement their reference count and	remove them from the cache  if
       that reference count reaches zero.

SEE ALSO
       Chapter 5, Using	Icons,
       XmtGetBitmap(), XmtGetPixmap(), XmtRegisterImage(),
       XmtRegisterXbmData(), XmtReleasePixmap().

Xmt				  Motif	Tools		    XmtLookupPixmap(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmtLookupWidgetPixmap&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help