This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



ImageByteOrder(3)                              XLIB FUNCTIONS                              ImageByteOrder(3)



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   Specifies the connection to the X server.

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

       screen_number
                 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 struc-tures, structures,
       tures, 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(3X11), BlackPixelOfScreen(3X11), IsCursorKey(3X11), XFree(3X11)
       Xlib - C Language X Interface



X Version 11                                    libX11 1.2.1                               ImageByteOrder(3)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you? Yes It's good, but... Not helpful...