Imported Upstream version 1.1.3
[platform/core/uifw/libdmx.git] / man / DMXGetScreenCount.man
1 .\" Copyright 2004 Red Hat Inc., Durham, North Carolina.
2 .\" All Rights Reserved.
3 .\"
4 .\" Permission is hereby granted, free of charge, to any person obtaining
5 .\" a copy of this software and associated documentation files (the
6 .\" "Software"), to deal in the Software without restriction, including
7 .\" without limitation on the rights to use, copy, modify, merge,
8 .\" publish, distribute, sublicense, and/or sell copies of the Software,
9 .\" and to permit persons to whom the Software is furnished to do so,
10 .\" subject to the following conditions:
11 .\"
12 .\" he above copyright notice and this permission notice (including the
13 .\" next paragraph) shall be included in all copies or substantial
14 .\" portions of the Software.
15 .\"
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 .\" NON-INFRINGEMENT.  IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS
20 .\" BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21 .\" ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 .\" CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 .\" SOFTWARE.
24 .TH DMXGetScreenCount __libmansuffix__ __vendorversion__
25 .SH NAME
26 DMXGetScreenCount \- determine number of back-end screens
27 .SH SYNOPSIS
28 .B #include <X11/extensions/dmxext.h>
29 .sp
30 .nf
31 .BI "Bool DMXGetScreenCount(Display " *dpy ,
32 .BI "                       int " *screen_count );
33 .fi
34 .SH DESCRIPTION
35 .B DMXGetScreenCount()
36 returns the number of back-end screens that a
37 .BR Xdmx (1)
38 server controls.  Since a DMX screen usually fills all of the available
39 area on a back-end server, there is usually a one-to-one correspondence
40 between DMX screens and backend servers.  However, it is also possible
41 for a DMX screen to cover only part of the available area on a back-end
42 server, and for more than one DMX screens to occupy different parts of
43 the visible area on the same back-end server.
44 .PP
45 A DMX screen may be managed as a regular X screen in the
46 .BR Xdmx (1)
47 server or may be joined with other DMX screens using Xinerama.
48 .SH "RETURN VALUE"
49 .B DMXGetScreenCount()
50 sets
51 .I screen_count
52 and returns
53 .B True
54 unless there is a protocol error.
55 .SH NOTES
56 If Xinerama is active, only one logical screen will be available to
57 clients of the
58 .BR Xdmx (1)
59 server.  However, this call will accurately reflect the number of
60 composite back-end screens that the
61 .BR Xdmx (1)
62 server is using.
63 .SH "SEE ALSO"
64 .BR DMXGetScreenAttributes "(__libmansuffix__), "
65 .BR DMXChangeScreensAttributes "(__libmansuffix__), "
66 .BR DMX "(__libmansuffix__), " Xdmx (1)