Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.

Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation

Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.

Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided "as is" without express or implied warranty.


ImageByteOrder __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
NAME
ImageByteOrder, BitmapBitOrder, BitmapPad, BitmapUnit, DisplayHeight, DisplayHeightMM, DisplayWidth, DisplayWidthMM, XListPixmapFormats, XPixmapFormatValues - image format functions and macros
SYNTAX

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

int ImageByteOrder\^(\^Display *display\^);

int BitmapBitOrder\^(\^Display *display\^);

int BitmapPad\^(\^Display *display\^);

int BitmapUnit\^(\^Display *display\^);

int DisplayHeight\^(\^Display *display\^, \^int screen_number\^);

int DisplayHeightMM\^(\^Display *display\^, \^int screen_number\^);

int DisplayWidth\^(\^Display *display\^, \^int screen_number\^);

int DisplayWidthMM\^(\^Display *display\^, \^int screen_number\^);

ARGUMENTS
display 1i
Specifies the connection to the X server.
count_return 1i
Returns the number of pixmap formats that are supported by the display.
screen_number 1i
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, XListPixmapFormats returns NULL. To free the allocated storage for the XPixmapFormatValues 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: .EX typedef struct { int depth; int bits_per_pixel; int scanline_pad; } XPixmapFormatValues;
"SEE ALSO"
AllPlanes(__libmansuffix__), BlackPixelOfScreen(__libmansuffix__), IsCursorKey(__libmansuffix__), XFree(__libmansuffix__)

\*(xL