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

FreeBSD Manual Pages

  
 
  

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

NAME
       XmtRegisterImage(),  XmtRegisterXbmData()  - register pixmap and	bitmap
       data in the Xmt pixmap cache.

SYNOPSIS
       #include	<Xmt/Pixmap.h>

       void XmtRegisterImage(String name, XmtImage *data)

       void XmtRegisterXbmData(String name, char *imagedata, char *maskdata,
		      int width, int height, int hotspot_x, int	hotspot_y)

ARGUMENTS
       INPUTS

	    name   The name under which	the pixmap or bitmap  data  is	to  be
		   registered.

	    data   For XmtRegisterImage(), the parsed XPM data.

	    imagedata
		   XBM data to be registered for name.

	    maskdata
		   An  optional	 bitmask  that defines a non-rectangular shape
		   for imagedata.

	    width, height
		   The size, in	pixels,	of the XBM data.

	    hotspot_x, hotspot_y
		   Optional (x,y) coordinates of a cursor ``hotspot'' for  the
		   XBM data.

DESCRIPTION
       XmtRegisterImage()  registers  an XmtImage structure by name in the Xmt
       image cache. The	XmtImage structure contains a parsed form of XPM  for-
       mat  image  data. An XmtImage structure can be obtained by calling Xmt-
       ParseXpmFile(), or XmtParseXpmData().

       Once an XmtImage	structure is registered, it can	be looked up  by  name
       and converted to	a Pixmap with XmtLookupPixmap()	and related functions.
       If  the	image contains ``transparent'' pixels, a bitmask for the image
       can be looked up	with XmtLookupBitmask().

       XmtRegisterXbmData() registers XBM format image data  and  an  optional
       XBM format image	mask by	name in	the Xmt	image cache. The imagedata and
       maskdata	arguments to this function can be obtained by including	an XBM
       format  file  into your C code, where it	will declare a statically ini-
       tialized	array of characters.

       Once this data is registered, it	can be looked up and  converted	 to  a
       single-plane  Pixmap with XmtLookupBitmap(), or to a multi-plane	Pixmap
       with XmtLookupPixmap(). The mask	data can be looked up and returned  as
       a single-plane Pixmap with XmtLookupBitmask().

SEE ALSO
       Chapter 5, Using	Icons,
       XmtGetBitmap(), XmtGetPixmap(), XmtLookupBitmap(), XmtLookupBitmask(),
       XmtLookupPixmap(), XmtLookupSimplePixmap(), XmtLookupWidgetPixmap(),
       XmtParseXpmData(), XmtParseXpmFile().

Xmt				  Motif	Tools		   XmtRegisterImage(3)

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

home | help