ImageByteOrder(XS)       X Version 11 (Release 5)         ImageByteOrder(XS)
                                6 January 1993


 Name

    ImageByteOrder - image format functions and macros

 Syntax


    XPixmapFormatValues *XListPixmapFormats(display, count_return)
          Display *display;
          int *count_return;

    ImageByteOrder(display)

    BitmapBitOrder(display)

    BitmapPad(display)

    BitmapUnit(display)

    DisplayHeight(display, screen_number)

    DisplayHeightMM(display, screen_number)

    DisplayWidth(display, screen_number)

    DisplayWidthMM(display, screen_number)


 Arguments


    display        Specifies the connection to the X server.

    countreturn   Returns the number of pixmap formats that are supported by
                   the display.

    screennumber  Specifies the appropriate screen number on the host
                   server.

 Description

    The XListPixmapFormats function returns an array of XPixmapFormatValues
    structures that describe the types of Z format images supported by the
    specified display.  If insufficient memory is available, XListPixmapFor-
    mats returns NULL.  To free the allocated storage for the XPixmapFormat-
    Values structures, use XFree.

    The ImageByteOrder macro specifies the required byte order for images for
    each scanline unit in XY format (bitmap) or for each pixel value in Z
    format.

    The BitmapBitOrder macro returns ``LSBFirst'' or ``MSBFirst'' to indicate
    whether the leftmost bit in the bitmap as displayed on the screen is the
    least or most significant bit in the unit.

    The BitmapPad macro returns the number of bits that each scanline must be
    padded.

    The BitmapUnit macro returns the size of a bitmap's scanline unit in
    bits.

    The DisplayHeight macro returns the height of the specified screen in
    pixels.

    The DisplayHeightMM macro returns the height of the specified screen in
    millimeters.

    The DisplayWidth macro returns the width of the screen in pixels.

    The DisplayWidthMM macro returns the width of the specified screen in
    millimeters.

 Structures

    The XPixmapFormatValues structure provides an interface to the pixmap
    format information that is returned at the time of a connection setup.
    It contains:

       typedef struct {
            int depth;
            int bits_per_pixel;
            int scanline_pad;
       } XPixmapFormatValues;


 See also

    AllPlanes(XS), BlackPixelOfScreen(XS), IsCursorKey(XS), XFree(XS)
    Xlib - C Language X Interface