Blame man/DMXGetDesktopAttributes.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 DMXDesktopAttributes __libmansuffix__ __vendorversion__
Packit ec660a
.SH NAME
Packit ec660a
DMXGetDesktopAttributes \- determine global bounding box
Packit ec660a
.SH SYNOPSIS
Packit ec660a
.B #include <X11/extensions/dmxext.h>
Packit ec660a
.sp
Packit ec660a
.nf
Packit ec660a
.BI "Bool DMXGetDesktopAttributes(Display " *dpy ,
Packit ec660a
.BI "                             DMXDesktopAttributes " *attr );
Packit ec660a
.fi
Packit ec660a
.SH DESCRIPTION
Packit ec660a
.B DMXGetDesktopAttributes()
Packit ec660a
returns information about the desktop in
Packit ec660a
.BR DMXDesktopAttributes :
Packit ec660a
.sp
Packit ec660a
.nf
Packit ec660a
typedef struct {
Packit ec660a
    unsigned int width;
Packit ec660a
    unsigned int height;
Packit ec660a
    int          shiftX;
Packit ec660a
    int          shiftY;
Packit ec660a
} DMXDesktopAttributes;
Packit ec660a
.fi
Packit ec660a
.PP
Packit ec660a
The size of the global bounding box is given in
Packit ec660a
.IR width ", and " height .
Packit ec660a
The
Packit ec660a
.IR shiftX " and " shiftY
Packit ec660a
values will always be 0.  The global bounding box is computed whether or
Packit ec660a
not Xinerama is active, but it is only useful when using Xinerama.
Packit ec660a
.PP
Packit ec660a
The global bounding box used by
Packit ec660a
.BR Xdmx (1)
Packit ec660a
may be larger than the Xinerama screen size because of information in
Packit ec660a
the configuration file.
Packit ec660a
.SH "RETURN VALUE"
Packit ec660a
.B DMXGetDesktopAttributes()
Packit ec660a
returns
Packit ec660a
.B True
Packit ec660a
unless there is a protocol error.
Packit ec660a
.SH "SEE ALSO"
Packit ec660a
.BR DMXChangeDesktopAttributes "(__libmansuffix__), " DMX "(__libmansuffix__), " Xdmx (1)