REF XImages                                      A. Schoter, August 1991

        COPYRIGHT University of Sussex 1991. All Rights Reserved.

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<<                             >>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<<           X IMAGES          >>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<<                             >>>>>>>>>>>>>>>>>>>>>>
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

The data structures and procedures described in this REF file shadow the
equivalent Xlib C structures  and functions related to image management.



---------------------
1  List of procedures
---------------------

The procedures below are made available by doing:

        uses xlib, XImages;

For details see:

                     Xlib - C Language X Interface,
                       MIT X Consortium Standard,
                         X Version 11, Release 4

        Copyright (C) 1985, 1986, 1987, 1988, 1989 Massachusetts
        Institute of Technology,  Cambridge, Massachusetts,  and
        Digital Equipment Corporation, Maynard, Massachusetts.


XCreateImage(DspPtr,visual,uint1,int1,int2,CharPtr,          [procedure]
                uint2,uint3,int3,int4) -> XImagePtr
XDestroyImage(XImagePtr) -> int                              [procedure]
XPutImage(DspPtr,xid,GCPtr,XImagePtr,int1,int2,int3,int4,    [procedure]
                uint1,uint2)
XSubImage(XImagePtr1,int1,int2,uint1,uint2) -> XImagePtr2    [procedure]
XGetImage(DspPtr,xid,int1,int2,uint1,uint2,ulong,            [procedure]
                int3) -> XImagePtr
XGetSubImage(DspPtr,xid,int1,int2,uint1,uint2,               [procedure]
                ulong,int3,XImagePtr1,int4,int5) -> XImagePtr2
XAddPixel(XImagePtr,ulong) -> int                            [procedure]
XPutPixel(XImagePtr,int1,int2,ulong) -> int3                 [procedure]
XGetPixel(XImagePtr,int1,int2) -> ulong                      [procedure]
        These procedures shadow the equivalent Xlib C functions.


XImage                                                         [typedef]
        This data structure is used by the image manipulation routines.

            typedef struct _XImage {
                int width, height;
                int xoffset;
                int format;
                char *data;
                int byte_order;
                int bitmap_unit;
                int bitmap_bit_order;
                int bitmap_pad;
                int depth;
                int bytes_per_line;
                int bits_per_pixel;
                unsigned long red_mask;
                unsigned long green_mask;
                unsigned long blue_mask;
                char *obdata;
                struct funcs {
                    struct _XImage *(*create_image)();
                    int (*destroy_image)();
                    unsigned long (*get_pixel)();
                    int (*put_pixel)();
                    struct _XImage *(*sub_image)();
                    int (*add_pixel)();
                } f;
            } XImage;

        width and  height are  the size  of the  image; xoffset  is  the
        number of pixels  offset in the  X direction; format  is one  of
        XYBitmap, XYPixmap, or ZPixmap; data  is a pointer to the  image
        data; byte_order is either LSBFirst of MSBFirst; bitmap_unit  is
        the  ???quantity???  of  the  scanline,  either  8,  16  or  32;
        bitmap_bit_order specifies  the order  of  bits in  the  bitmap,
        either LSBFirst  or  MSBFirst; bitmap_pad  8,  16, 32  -  either
        XYPixmap or ZPixmap;  depth is  the colour depth  of the  image;
        bytes_per_line   is   an   accelarator   to   the   next   line;
        bits_per_pixel specifies  for  ZPixmap  the numbr  of  bits  per
        pixel; red_mask, green_mask and blue_mask specify the bits  in a
        z arrangement; obdata is a hook for the object routines to  hang
        on; f provides a structure for specifying the image manipulation
        routines.




--- C.x/x/pop/ref/XImages
--- Copyright University of Sussex 1991. All rights reserved.
