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

FreeBSD Manual Pages

  
 
  

home | help
XpmCreateImage(3)		libXpm functions	       XpmCreateImage(3)

NAME
     XpmCreateImage - create an XImage from an XPM

SYNOPSIS
     int XpmCreateImageFromData(Display *display, char **data,
	    XImage **image_return, XImage **shapeimage_return,
	    XpmAttributes *attributes);

     int XpmCreateImageFromBuffer(Display *display, char *buffer,
	    XImage **image_return, XImage **shapeimage_return,
	    XpmAttributes *attributes);

     int XpmCreateImageFromXpmImage(Display *display,  XpmImage *image,
	    XImage *image_return, XImage *shapeimage_return,
	    XpmAttributes *attributes);

ARGUMENTS
     display   Specifies the connection to the X server.

     data      Specifies the location of the data.

     image_return
	       Returns the image which is created.

     shapeimage_return
	       Returns	the  shape mask image which is created if the color None
	       is used.

     attributesSpecifies the location of a structure to get and  store	informa-
	       tion (or NULL).

     shapeimageSpecifies the shape mask image which is created if any.

DESCRIPTION
   XpmCreateImageFromData
     To create an XImage from an XPM data, use XpmCreateImageFromData().

     The  XpmCreateImageFromData() function allows you to include in your C pro-
     gram an XPM file which was written out by functions such  as  XpmWriteFile-
     FromImage(3)  or  XpmWriteFileFromPixmap(3)  without  reading  in the file.
     XpmCreateImageFromData() exactly works as	XpmReadFileToImage(3)  does  and
     returns  the  same way.  It just reads data instead of a file.  Here again,
     it is the calleras responsibility to free the returned images, the  colors,
     and possibly the data returned into the XpmAttributes structure.

   XpmCreateImageFromBuffer
     To  create  an  XImage  from an XPM buffer, use XpmCreateImageFromBuffer().
     The XpmCreateImageFromBuffer() function works the same way as  XpmReadFile-
     ToImage(3),  it  just parses the buffer instead of the file.  Be aware that
     the feature provided on some systems by XpmReadFileToImage(3) to deal  with
     compressed files is not available here.

   XpmCreateImageFromXpmImage
     To  create  an  XImage  from an XpmImage, use XpmCreateImageFromXpmImage().
     From the given XpmImage and  XpmAttributes  if  not  NULL,  XpmCreateImage-
     FromXpmImage()  allocates	colors	and  creates X images following the same
     mechanism as XpmReadFileToImage(3).  When finished the caller must free the
     images using XDestroyImage(3), the colors using XFreeColors(3), and  possi-
     bly the data returned into the XpmAttributes using XpmFreeAttributes(3).

SEE ALSO
     XpmFreeAttributes(3), XpmReadFileToImage(3)

X Version 11			  libXpm 3.5.19 	       XpmCreateImage(3)

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

home | help