Blame man/DMXGetScreenCount.man

Packit ec660a
.\" Copyright 2004 Red Hat Inc., Durham, North Carolina.
Packit ec660a
.\" All Rights Reserved.
Packit ec660a
.\"
Packit ec660a
.\" Permission is hereby granted, free of charge, to any person obtaining
Packit ec660a
.\" a copy of this software and associated documentation files (the
Packit ec660a
.\" "Software"), to deal in the Software without restriction, including
Packit ec660a
.\" without limitation on the rights to use, copy, modify, merge,
Packit ec660a
.\" publish, distribute, sublicense, and/or sell copies of the Software,
Packit ec660a
.\" and to permit persons to whom the Software is furnished to do so,
Packit ec660a
.\" subject to the following conditions:
Packit ec660a
.\"
Packit ec660a
.\" he above copyright notice and this permission notice (including the
Packit ec660a
.\" next paragraph) shall be included in all copies or substantial
Packit ec660a
.\" portions of the Software.
Packit ec660a
.\"
Packit ec660a
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Packit ec660a
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Packit ec660a
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Packit ec660a
.\" NON-INFRINGEMENT.  IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS
Packit ec660a
.\" BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
Packit ec660a
.\" ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
Packit ec660a
.\" CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
Packit ec660a
.\" SOFTWARE.
Packit ec660a
.TH DMXGetScreenCount __libmansuffix__ __vendorversion__
Packit ec660a
.SH NAME
Packit ec660a
DMXGetScreenCount \- determine number of back-end screens
Packit ec660a
.SH SYNOPSIS
Packit ec660a
.B #include <X11/extensions/dmxext.h>
Packit ec660a
.sp
Packit ec660a
.nf
Packit ec660a
.BI "Bool DMXGetScreenCount(Display " *dpy ,
Packit ec660a
.BI "                       int " *screen_count );
Packit ec660a
.fi
Packit ec660a
.SH DESCRIPTION
Packit ec660a
.B DMXGetScreenCount()
Packit ec660a
returns the number of back-end screens that a
Packit ec660a
.BR Xdmx (1)
Packit ec660a
server controls.  Since a DMX screen usually fills all of the available
Packit ec660a
area on a back-end server, there is usually a one-to-one correspondence
Packit ec660a
between DMX screens and backend servers.  However, it is also possible
Packit ec660a
for a DMX screen to cover only part of the available area on a back-end
Packit ec660a
server, and for more than one DMX screens to occupy different parts of
Packit ec660a
the visible area on the same back-end server.
Packit ec660a
.PP
Packit ec660a
A DMX screen may be managed as a regular X screen in the
Packit ec660a
.BR Xdmx (1)
Packit ec660a
server or may be joined with other DMX screens using Xinerama.
Packit ec660a
.SH "RETURN VALUE"
Packit ec660a
.B DMXGetScreenCount()
Packit ec660a
sets
Packit ec660a
.I screen_count
Packit ec660a
and returns
Packit ec660a
.B True
Packit ec660a
unless there is a protocol error.
Packit ec660a
.SH NOTES
Packit ec660a
If Xinerama is active, only one logical screen will be available to
Packit ec660a
clients of the
Packit ec660a
.BR Xdmx (1)
Packit ec660a
server.  However, this call will accurately reflect the number of
Packit ec660a
composite back-end screens that the
Packit ec660a
.BR Xdmx (1)
Packit ec660a
server is using.
Packit ec660a
.SH "SEE ALSO"
Packit ec660a
.BR DMXGetScreenAttributes "(__libmansuffix__), "
Packit ec660a
.BR DMXChangeScreensAttributes "(__libmansuffix__), "
Packit ec660a
.BR DMX "(__libmansuffix__), " Xdmx (1)