149 lines
5.1 KiB
Groff
149 lines
5.1 KiB
Groff
.\" 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.
|
|
.\"
|
|
.\"
|
|
.ds xT X Toolkit Intrinsics \- C Language Interface
|
|
.ds xW Athena X Widgets \- C Language X Toolkit Interface
|
|
.ds xL Xlib \- C Language X Interface
|
|
.ds xC Inter-Client Communication Conventions Manual
|
|
.TH ImageByteOrder __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
|
|
.SH NAME
|
|
ImageByteOrder, BitmapBitOrder, BitmapPad, BitmapUnit, DisplayHeight, DisplayHeightMM, DisplayWidth, DisplayWidthMM, XListPixmapFormats, XPixmapFormatValues \- image format functions and macros
|
|
.SH SYNTAX
|
|
.HP
|
|
XPixmapFormatValues *XListPixmapFormats\^(\^Display *\fIdisplay\fP, int *\fIcount_return\fP\^);
|
|
.HP
|
|
int ImageByteOrder\^(\^Display *\fIdisplay\fP\^);
|
|
.HP
|
|
int BitmapBitOrder\^(\^Display *\fIdisplay\fP\^);
|
|
.HP
|
|
int BitmapPad\^(\^Display *\fIdisplay\fP\^);
|
|
.HP
|
|
int BitmapUnit\^(\^Display *\fIdisplay\fP\^);
|
|
.HP
|
|
int DisplayHeight\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
|
|
.HP
|
|
int DisplayHeightMM\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
|
|
.HP
|
|
int DisplayWidth\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
|
|
.HP
|
|
int DisplayWidthMM\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
|
|
.SH ARGUMENTS
|
|
.IP \fIdisplay\fP 1i
|
|
Specifies the connection to the X server.
|
|
.IP \fIcount_return\fP 1i
|
|
Returns the number of pixmap formats that are supported by the display.
|
|
.IP \fIscreen_number\fP 1i
|
|
Specifies the appropriate screen number on the host server.
|
|
.SH DESCRIPTION
|
|
The
|
|
.B XListPixmapFormats
|
|
function returns an array of
|
|
.B XPixmapFormatValues
|
|
structures that describe the types of Z format images supported
|
|
by the specified display.
|
|
If insufficient memory is available,
|
|
.B XListPixmapFormats
|
|
returns NULL.
|
|
To free the allocated storage for the
|
|
.B XPixmapFormatValues
|
|
structures, use
|
|
.BR XFree .
|
|
.LP
|
|
The
|
|
.B 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.
|
|
.LP
|
|
The
|
|
.B BitmapBitOrder
|
|
macro returns
|
|
.B LSBFirst
|
|
or
|
|
.B 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.
|
|
.LP
|
|
The
|
|
.B BitmapPad
|
|
macro returns the number of bits that each scanline must be padded.
|
|
.LP
|
|
The
|
|
.B BitmapUnit
|
|
macro returns the size of a bitmap's scanline unit in bits.
|
|
.LP
|
|
The
|
|
.B DisplayHeight
|
|
macro returns the height of the specified screen in pixels.
|
|
.LP
|
|
The
|
|
.B DisplayHeightMM
|
|
macro returns the height of the specified screen in millimeters.
|
|
.LP
|
|
The
|
|
.B DisplayWidth
|
|
macro returns the width of the screen in pixels.
|
|
.LP
|
|
The
|
|
.B DisplayWidthMM
|
|
macro returns the width of the specified screen in millimeters.
|
|
.SH STRUCTURES
|
|
The
|
|
.B 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;
|
|
.EE
|
|
.SH "SEE ALSO"
|
|
AllPlanes(__libmansuffix__),
|
|
BlackPixelOfScreen(__libmansuffix__),
|
|
IsCursorKey(__libmansuffix__),
|
|
XFree(__libmansuffix__)
|
|
.br
|
|
\fI\*(xL\fP
|