← Back to branch summary

~ubuntu-branches/ubuntu/lucid/libdmx/lucid

« back to all changes in this revision

Viewing changes to man/DMXGetDesktopAttributes.3

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Stone
  • Date: 2005-07-23 00:27:06 UTC
  • Revision ID: james.westby@ubuntu.com-20050723002706-gsdqrcrjekudn09a
Tags: upstream-7.0.0
Import upstream version 7.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/DMXGetDesktopAttributes.3
 
1
.\" $XFree86$
 
2
.\"
 
3
.\" Copyright 2004 Red Hat Inc., Durham, North Carolina.
 
4
.\" All Rights Reserved.
 
5
.\"
 
6
.\" Permission is hereby granted, free of charge, to any person obtaining
 
7
.\" a copy of this software and associated documentation files (the
 
8
.\" "Software"), to deal in the Software without restriction, including
 
9
.\" without limitation on the rights to use, copy, modify, merge,
 
10
.\" publish, distribute, sublicense, and/or sell copies of the Software,
 
11
.\" and to permit persons to whom the Software is furnished to do so,
 
12
.\" subject to the following conditions:
 
13
.\"
 
14
.\" he above copyright notice and this permission notice (including the
 
15
.\" next paragraph) shall be included in all copies or substantial
 
16
.\" portions of the Software.
 
17
.\"
 
18
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 
19
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
20
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 
21
.\" NON-INFRINGEMENT.  IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS
 
22
.\" BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 
23
.\" ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 
24
.\" CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 
25
.\" SOFTWARE.
 
26
.TH DMXDesktopAttributes 3X __vendorversion__
 
27
.SH NAME
 
28
DMXGetDesktopAttributes \- determine global bounding box
 
29
.SH SYNOPSIS
 
30
.B #include <X11/extensions/dmxext.h>
 
31
.sp
 
32
.nf
 
33
.BI "Bool DMXGetDesktopAttributes(Display " *dpy ,
 
34
.BI "                             DMXDesktopAttributes " *attr );
 
35
.fi
 
36
.SH DESCRIPTION
 
37
.B DMXGetDesktopAttributes()
 
38
returns information about the desktop in
 
39
.BR DMXDesktopAttributes :
 
40
.sp
 
41
.nf
 
42
typedef struct {
 
43
    unsigned int width;
 
44
    unsigned int height;
 
45
    int          shiftX;
 
46
    int          shiftY;
 
47
} DMXDesktopAttributes;
 
48
.fi
 
49
.PP
 
50
The size of the global bounding box is given in
 
51
.IR width ", and " height .
 
52
The
 
53
.IR shiftX " and " shiftY
 
54
values will always be 0.  The global bounding box is computed whether or
 
55
not Xinerama is active, but it is only useful when using Xinerama.
 
56
.PP
 
57
The global bounding box used by
 
58
.BR Xdmx (1)
 
59
may be larger than the Xinerama screen size because of information in
 
60
the configuration file.
 
61
.SH "RETURN VALUE"
 
62
.B DMXGetDesktopAttributes()
 
63
returns
 
64
.B True
 
65
unless there is a protocol error.
 
66
.SH "SEE ALSO"
 
67
.BR DMXChangeDesktopAttributes "(3X), " DMX "(3X), " Xdmx (1)