<?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='blkpscrnman'>
<!--  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/BlkPScrn.man,v 1.3 2003/04/28 22:17:53 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- 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>BlackPixelOfScreen</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>BlackPixelOfScreen</refname>
<refname>WhitePixelOfScreen</refname>
<refname>CellsOfScreen</refname>
<refname>DefaultColormapOfScreen</refname>
<refname>DefaultDepthOfScreen</refname>
<refname>DefaultGCOfScreen</refname>
<refname>DefaultVisualOfScreen</refname>
<refname>DoesBackingStore</refname>
<refname>DoesSaveUnders</refname>
<refname>DisplayOfScreen</refname>
<refname>XScreenNumberOfScreen</refname>
<refname>EventMaskOfScreen</refname>
<refname>HeightOfScreen</refname>
<refname>HeightMMOfScreen</refname>
<refname>MaxCmapsOfScreen</refname>
<refname>MinCmapsOfScreen</refname>
<refname>PlanesOfScreen</refname>
<refname>RootWindowOfScreen</refname>
<refname>WidthOfScreen</refname>
<refname>WidthMMOfScreen</refname>
<refpurpose>screen information functions and macros</refpurpose>
</refnamediv>
<!-- body begins here -->

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

<para>unsigned long BlackPixelOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>unsigned long WhitePixelOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int CellsOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>Colormap DefaultColormapOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int DefaultDepthOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>GC DefaultGCOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>Visual *DefaultVisualOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int DoesBackingStore&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>Bool DoesSaveUnders&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>Display *DisplayOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int XScreenNumberOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>long EventMaskOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int HeightOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int HeightMMOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int MaxCmapsOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int MinCmapsOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int PlanesOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>Window RootWindowOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int WidthOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>

<para>int WidthMMOfScreen&hairsp;(&hairsp;Screen *<emphasis remap='I'>screen</emphasis>&hairsp;);</para>
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>screen</emphasis></term>
  <listitem>
<para>Specifies the appropriate 
<emphasis remap='I'>&hairsp;Screen&hairsp;</emphasis>
structure.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;BlackPixelOfScreen&hairsp;</emphasis>
macro returns the black pixel value of the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;WhitePixelOfScreen&hairsp;</emphasis>
macro returns the white pixel value of the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;CellsOfScreen&hairsp;</emphasis>
macro returns the number of colormap cells in the default colormap
of the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;DefaultColormapOfScreen&hairsp;</emphasis>
macro returns the default colormap of the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;DefaultDepthOfScreen&hairsp;</emphasis>
macro returns the default depth of the root window of the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;DefaultGCOfScreen&hairsp;</emphasis>
macro returns the default GC of the specified screen,
which has the same depth as the root window of the screen.</para>

<para>The
<emphasis remap='I'>&hairsp;DefaultVisualOfScreen&hairsp;</emphasis>
macro returns the default visual of the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;DoesBackingStore&hairsp;</emphasis>
macro returns 
<emphasis remap='I'>&hairsp;WhenMapped&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;NotUseful&hairsp;</emphasis>,
or
<emphasis remap='I'>&hairsp;Always&hairsp;</emphasis>,
which indicate whether the screen supports backing stores.</para>

<para>The
<emphasis remap='I'>&hairsp;DoesSaveUnders&hairsp;</emphasis>
macro returns a Boolean value indicating whether the
screen supports save unders.</para>

<para>The
<emphasis remap='I'>&hairsp;DisplayOfScreen&hairsp;</emphasis>
macro returns the display of the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;XScreenNumberOfScreen&hairsp;</emphasis>
function returns the screen index number of the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;EventMaskOfScreen&hairsp;</emphasis>
macro returns the root event mask of the root window for the specified screen
at connection setup.</para>

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

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

<para>The
<emphasis remap='I'>&hairsp;MaxCmapsOfScreen&hairsp;</emphasis>
macro returns the maximum number of installed colormaps supported 
by the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;MinCmapsOfScreen&hairsp;</emphasis>
macro returns the minimum number of installed colormaps supported 
by the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;PlanesOfScreen&hairsp;</emphasis>
macro returns the number of planes in the root window of the specified screen.</para>

<para>The
<emphasis remap='I'>&hairsp;RootWindowOfScreen&hairsp;</emphasis>
macro returns the root window of the specified screen.</para>

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

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

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

