NAME

display - Interactively Display and Edit an Image

SYNOPSIS

XAnnotateEditImage(display,resource_info,windows,image)

status=XBackgroundImage(display,resource_info,windows,image)

status=XChopImage(display,resource_info,windows,image)

XColorEditImage(display,resource_info,windows,image)

status=XCompositeImage(display,resource_info,windows,image)

status=XConfigureImage(display,resource_info,windows,image)

status=XCropImage(display,resource_info,windows,image,mode)

status=XDisplayBackgroundImage(display,resource_info,image)

loaded_image=XDisplayImage(display,resource_info,argv,argc,image,state)

XDrawPanRectangle(display,windows)

loaded_image=XMagickCommand(display,resource_info,windows,command,image)

XMagnifyImage(display,windows,event)

XMagnifyWindowCommand(display,windows,state,key_symbol)

XMakePanImage(display,resource_info,windows,image)

loaded_image=XOpenImage(display,resource_info,windows,command)

XPanImage(display,windows,event)

status=XPasteImage(display,resource_info,windows,image)

status=XPrintImage(display,resource_info,windows,image)

status=XROIImage(display,resource_info,windows,image)

status=XRotateImage(display,resource_info,windows,degrees,image)

status=XSaveImage(display,resource_info,windows,image)

XScreenEvent(display,windows,event)

XSetCropGeometry(display,windows,crop_info,image)

tiled_image=XTileImage(display,resource_info,windows,image,event)

XTranslateImage(display,windows,image,key_symbol)

status=XTrimImage(display,resource_info,windows,image)

loaded_image=XVisualDirectoryImage(display,resource_info,windows)

FUNCTION DESCRIPTIONS

XAnnotateEditImage

Function XAnnotateEditImage annotates the image with text.

The format of the XAnnotateEditImage routine is:

      XAnnotateEditImage(display,resource_info,windows,image)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XBackgroundImage

Function XBackgroundImage displays the image in the background of a window.

The format of the XBackgroundImage routine is:

      status=XBackgroundImage(display,resource_info,windows,image)

A description of each parameter follows:

o status:: Function XBackgroundImage return True if the image is printed. False is returned is there is a memory shortage or if the image fails to print.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XChopImage

Function XChopImage chops the X image.

The format of the XChopImage routine is:

      status=XChopImage(display,resource_info,windows,image)

A description of each parameter follows:

o status:: Function XChopImage return True if the image is cut. False is returned is there is a memory shortage or if the image fails to cut.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XColorEditImage

Function XColorEditImage allows the user to interactively change the color of one pixel for a DirectColor image or one colormap entry for a PseudoClass image.

The format of the XColorEditImage routine is:

      XColorEditImage(display,resource_info,windows,image)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XCompositeImage

Function XCompositeImage requests an image name from the user, reads the image and composites it with the X window image at a location the user chooses with the pointer.

The format of the XCompositeImage routine is:

      status=XCompositeImage(display,resource_info,windows,image)

A description of each parameter follows:

o status:: Function XCompositeImage returns True if the image is composited. False is returned is there is a memory shortage or if the image fails to be composited.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XConfigureImage

Function XConfigureImage creates a new X image. It also notifies the window manager of the new image size and configures the transient widows.

The format of the XConfigureImage routine is:

      status=XConfigureImage(display,resource_info,windows,image)

A description of each parameter follows:

o status:: Function XConfigureImage returns True if the window is resized. False is returned is there is a memory shortage or if the window fails to resize.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XCropImage

Function XCropImage allows the user to select a region of the image and crop, copy, or cut it. For copy or cut, the image can subsequently be composited onto the image with XPasteImage.

The format of the XCropImage routine is:

      status=XCropImage(display,resource_info,windows,image,mode)

A description of each parameter follows:

o status:: Function XCropImage returns True if the image is copyped. False is returned is there is a memory shortage or if the image fails to be copyped.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.
o mode:: This unsigned value specified whether the image should be cropped, copied, or cut.

XDrawImage

Function XDrawEditImage draws a graphic primitive (point, line, rectangle, etc.) on the image.

The format of the XDrawEditImage routine is:

  status=XDrawEditImage(display,resource_info,windows,degrees,image)

A description of each parameter follows:

o status:: Function XDrawEditImage return True if the image is drawn upon. False is returned is there is a memory shortage or if the image cannot be drawn on.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XDrawPanRectangle

Function XDrawPanRectangle draws a rectangle in the pan window. The pan window displays a zoomed image and the rectangle shows which portion of the image is displayed in the Image window.

The format of the XDrawPanRectangle routine is:

      XDrawPanRectangle(display,windows)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o windows:: Specifies a pointer to a XWindows structure.

XImageWindowCommand

Function XImageWindowCommand makes a transform to the image or Image window as specified by a user menu button or keyboard command.

The format of the XMagickCommand routine is:

  loaded_image=XImageWindowCommand(display,resource_info,windows,state,

    key_symbol,image)

A description of each parameter follows:

o loaded_image:: Function XImageWindowCommand returns an image when the user chooses 'Open Image' from the command menu. Otherwise a null image is returned.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o state:: key mask.
o key_symbol:: Specifies a command to perform.
o image:: Specifies a pointer to a Image structure; XImageWIndowCommand may transform the image and return a new image pointer.

XMagickCommand

Function XMagickCommand makes a transform to the image or Image window as specified by a user menu button or keyboard command.

The format of the XMagickCommand routine is:

      loaded_image=XMagickCommand(display,resource_info,windows,command,image)

A description of each parameter follows:

o loaded_image:: Function XMagickCommand returns an image when the user chooses 'Load Image' from the command menu. Otherwise a null image is returned.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o command:: Specifies a command to perform.
o image:: Specifies a pointer to a Image structure; XMagickCommand may transform the image and return a new image pointer.

XMagnifyImage

Function XMagnifyImage magnifies portions of the image as indicated by the pointer. The magnified portion is displayed in a separate window.

The format of the XMagnifyImage routine is:

      XMagnifyImage(display,windows,event)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o windows:: Specifies a pointer to a XWindows structure.
o event:: Specifies a pointer to a XEvent structure. If it is NULL, the entire image is refreshed.

XMagnifyWindowCommand

Function XMagnifyWindowCommand moves the image within an Magnify window by one pixel as specified by the key symbol.

The format of the XMagnifyWindowCommand routine is:

      XMagnifyWindowCommand(display,windows,state,key_symbol)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o windows:: Specifies a pointer to a XWindows structure.
o state:: key mask.
o key_symbol:: Specifies a KeySym which indicates which side of the image to trim.

XMakePanImage

Function XMakePanImage creates a thumbnail of the image and displays it in the Pan icon window.

The format of the XMakePanImage routine is:

        XMakePanImage(display,resource_info,windows,image)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XMattaEditImage

Function XMatteEditImage allows the user to interactively change the Matte channel of an image. If the image is PseudoClass it is promoted to DirectClass before the matte information is stored.

The format of the XMatteEditImage routine is:

  XMatteEditImage(display,resource_info,windows,image)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XOpenImage

Function XOpenImage loads an image from a file.

The format of the XOpenImage routine is:

      loaded_image=XOpenImage(display,resource_info,windows,command)

A description of each parameter follows:

o loaded_image:: Function XOpenImage returns an image if can be loaded successfully. Otherwise a null image is returned.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o command:: A value other than zero indicates that the file is selected from the command line argument list.

XPanImage

Function XPanImage pans the image until the mouse button is released.

The format of the XPanImage routine is:

      XPanImage(display,windows,event)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o windows:: Specifies a pointer to a XWindows structure.
o event:: Specifies a pointer to a XEvent structure. If it is NULL, the entire image is refreshed.

XPasteImage

Function XPasteImage pastes an image previously saved with XCropImage in the X window image at a location the user chooses with the pointer.

The format of the XPasteImage routine is:

      status=XPasteImage(display,resource_info,windows,image)

A description of each parameter follows:

o status:: Function XPasteImage returns True if the image is pasted. False is returned is there is a memory shortage or if the image fails to be pasted.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XPrintImage

Function XPrintImage prints an image to a Postscript printer.

The format of the XPrintImage routine is:

      status=XPrintImage(display,resource_info,windows,image)

A description of each parameter follows:

o status:: Function XPrintImage return True if the image is printed. False is returned is there is a memory shortage or if the image fails to print.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XROIImage

Function XROIImage applies an image processing technique to a region of interest.

The format of the XROIImage routine is:

      status=XROIImage(display,resource_info,windows,image)

A description of each parameter follows:

o status:: Function XROIImage returns True if the image is cropped. False is returned is there is a memory shortage or if the image fails to be cropped.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XRotateImage

Function XRotateImage rotates the X image. If the degrees parameter if zero, the rotation angle is computed from the slope of a line drawn by the user.

The format of the XRotateImage routine is:

      status=XRotateImage(display,resource_info,windows,degrees,image)

A description of each parameter follows:

o status:: Function XRotateImage return True if the image is rotated. False is returned is there is a memory shortage or if the image fails to rotate.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o degrees:: Specifies the number of degrees to rotate the image.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XSaveImage

Function XSaveImage saves an image to a file.

The format of the XSaveImage routine is:

      status=XSaveImage(display,resource_info,windows,image)

A description of each parameter follows:

o status:: Function XSaveImage return True if the image is written. False is returned is there is a memory shortage or if the image fails to write.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XScreenEvent

Function XScreenEvent handles global events associated with the Pan and Magnify windows.

The format of the XScreenEvent function is:

        XScreenEvent(display,windows,event)

A description of each parameter follows:

o display:: Specifies a pointer to the Display structure; returned from XOpenDisplay.
o windows:: Specifies a pointer to a XWindows structure.
o event:: Specifies a pointer to a X11 XEvent structure.

XSetCropGeometry

Function XSetCropGeometry accepts a cropping geometry relative to the Image window and translates it to a cropping geometry relative to the image.

The format of the XSetCropGeometry routine is:

      XSetCropGeometry(display,windows,crop_info,image)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o windows:: Specifies a pointer to a XWindows structure.
o crop_info:: A pointer to a RectangleInfo that defines a region of the Image window to crop.
o image:: Specifies a pointer to a Image structure.

XTileImage

Function XTileImage loads or deletes a selected tile from a visual image directory. The load or delete command is choosen from a menu.

The format of the XTileImage routine is:

      tiled_image=XTileImage(display,resource_info,windows,image,event)

A description of each parameter follows:

o tiled_image:: XTileImage reads or deletes the tiled image and returns it. A null image is returned if an error occurs.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.
o event:: Specifies a pointer to a XEvent structure. If it is NULL, the entire image is refreshed.

Function XTranslateImage translates the image within an Image window by one pixel as specified by the key symbol. If the image has a `montage' string the translation is respect to the width and height contained within the string.

The format of the XTranslateImage routine is:

      XTranslateImage(display,windows,image,key_symbol)

A description of each parameter follows:

o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o windows:: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.
o key_symbol:: Specifies a KeySym which indicates which side of the image to trim.

XTrimImage

Function XTrimImage trims the edges from the Image window.

The format of the XTrimImage routine is:

      status=XTrimImage(display,resource_info,windows,image)

A description of each parameter follows:

o status:: Function XTrimImage returns True if the image is cropped. False is returned is there is a memory shortage or if the image fails to be cropped.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure. o windows: Specifies a pointer to a XWindows structure.
o image:: Specifies a pointer to a Image structure.

XVisualDirectoryImage

Function XVisualDirectoryImage creates a Visual Image Directory.

The format of the XVisualDirectoryImage routine is:

      loaded_image=XVisualDirectoryImage(display,resource_info,windows)

A description of each parameter follows:

o loaded_image:: Function XVisualDirectoryImage returns a visual image directory if it can be created successfully. Otherwise a null image is returned.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o windows:: Specifies a pointer to a XWindows structure.

XDisplayBackgroundImage

Function XDisplayBackgroundImage displays an image in the background of a window.

The format of the XDisplayBackgroundImage routine is:

        status=XDisplayBackgroundImage(display,resource_info,image)

A description of each parameter follows:

o status:: Function XDisplayBackgroundImage returns True if the designated window is the root window.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o image:: Specifies a pointer to a Image structure; returned from ReadImage.

XDisplayImage

Function XDisplayImage displays an image via X11. A new image is created and returned if the user interactively transforms the displayed image.

The format of the XDisplayImage routine is:

        loaded_image=XDisplayImage(display,resource_info,argv,argc,image,state)

A description of each parameter follows:

o loaded_image:: Function XDisplayImage returns an image when the user chooses 'Open Image' from the command menu or picks a tile from the image directory. Otherwise a null image is returned.
o display:: Specifies a connection to an X server; returned from XOpenDisplay.
o resource_info:: Specifies a pointer to a X11 XResourceInfo structure.
o argv:: Specifies the application's argument list.
o argc:: Specifies the number of arguments.
o image:: Specifies an address to an address of an Image structure; returned from ReadImage.