<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='imageordman'>
<!--  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. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/ImageOrd.man,v 1.3 2003/04/28 22:17:53 herrb Exp $ -->

<!-- .na -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- Pn listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>ImageByteOrder</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>ImageByteOrder</refname>
<refname>BitmapBitOrder</refname>
<refname>BitmapPad</refname>
<refname>BitmapUnit</refname>
<refname>DisplayHeight</refname>
<refname>DisplayHeightMM</refname>
<refname>DisplayWidth</refname>
<refname>DisplayWidthMM</refname>
<refname>XListPixmapFormats</refname>
<refname>XPixmapFormatValues</refname>
<refpurpose>image format functions and macros</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>XPixmapFormatValues *XListPixmapFormats&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>, int *<emphasis remap='I'>count_return</emphasis>&hairsp;);</para>

<para>int ImageByteOrder&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;);</para>

<para>int BitmapBitOrder&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;);</para>

<para>int BitmapPad&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;);</para>

<para>int BitmapUnit&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;);</para>

<para>int DisplayHeight&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, &hairsp;int <emphasis remap='I'>screen_number</emphasis>&hairsp;);</para>

<para>int DisplayHeightMM&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, &hairsp;int <emphasis remap='I'>screen_number</emphasis>&hairsp;);</para>

<para>int DisplayWidth&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, &hairsp;int <emphasis remap='I'>screen_number</emphasis>&hairsp;);</para>

<para>int DisplayWidthMM&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, &hairsp;int <emphasis remap='I'>screen_number</emphasis>&hairsp;);</para>
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>count_return</emphasis></term>
  <listitem>
<para>Returns the number of pixmap formats that are supported by the display.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>screen_number</emphasis></term>
  <listitem>
<para>Specifies the appropriate screen number on the host server.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XListPixmapFormats&hairsp;</emphasis>
function returns an array of
<emphasis remap='I'>&hairsp;XPixmapFormatValues&hairsp;</emphasis>
structures that describe the types of Z format images supported
by the specified display.
If insufficient memory is available,
<emphasis remap='I'>&hairsp;XListPixmapFormats&hairsp;</emphasis>
returns NULL.
To free the allocated storage for the
<emphasis remap='I'>&hairsp;XPixmapFormatValues&hairsp;</emphasis>
structures, use
<emphasis remap='I'>&hairsp;XFree&hairsp;</emphasis>.</para>

<para>The
<emphasis remap='I'>&hairsp;ImageByteOrder&hairsp;</emphasis>
macro specifies the required byte order for images for each scanline unit in
XY format (bitmap) or for each pixel value in Z format.</para>

<para>The
<emphasis remap='I'>&hairsp;BitmapBitOrder&hairsp;</emphasis>
macro returns 
<emphasis remap='I'>&hairsp;LSBFirst&hairsp;</emphasis>
or
<emphasis remap='I'>&hairsp;MSBFirst&hairsp;</emphasis>
to indicate whether the leftmost bit in the bitmap as displayed
on the screen is the least or most significant bit in the unit.</para>

<para>The
<emphasis remap='I'>&hairsp;BitmapPad&hairsp;</emphasis>
macro returns the number of bits that each scanline must be padded.</para>

<para>The
<emphasis remap='I'>&hairsp;BitmapUnit&hairsp;</emphasis>
macro returns the size of a bitmap's scanline unit in bits.</para>

<para>The
<emphasis remap='I'>&hairsp;DisplayHeight&hairsp;</emphasis>
macro returns the height of the specified screen in pixels.</para>

<para>The
<emphasis remap='I'>&hairsp;DisplayHeightMM&hairsp;</emphasis>
macro returns the height of the specified screen in millimeters.</para>

<para>The
<emphasis remap='I'>&hairsp;DisplayWidth&hairsp;</emphasis>
macro returns the width of the screen in pixels.</para>

<para>The
<emphasis remap='I'>&hairsp;DisplayWidthMM&hairsp;</emphasis>
macro returns the width of the specified screen in millimeters.</para>
</refsect1>

<refsect1 id='structures'><title>STRUCTURES</title>
<para>The
<emphasis remap='I'>&hairsp;XPixmapFormatValues&hairsp;</emphasis>
structure provides an interface to the pixmap format information
that is returned at the time of a connection setup.
It contains:</para>
<literallayout remap='.nf'>
<!-- .0D  0 -->

<!-- .ps \n(PS -->
<!-- .if \n(VS&gt;=40 .vs \n(VSu -->
<!-- .if \n(VS&lt;=39 .vs \n(VSp -->
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
typedef struct {
	int depth;
	int bits_per_pixel;
	int scanline_pad;
} XPixmapFormatValues;
<!-- .ce 0  IGNORED -->
<!-- .in \n(OIu  IGNORED -->

</literallayout> <!-- .fi -->
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>AllPlanes(3X11),
BlackPixelOfScreen(3X11),
IsCursorKey(3X11),
XFree(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

