man/DMXGetDesktopAttributes.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 DMXDesktopAttributes __libmansuffix__ __vendorversion__
  25 .SH NAME
  26 DMXGetDesktopAttributes \- determine global bounding box
  27 .SH SYNOPSIS
  28 .B #include <X11/extensions/dmxext.h>
  29 .sp
  30 .nf
  31 .BI "Bool DMXGetDesktopAttributes(Display " *dpy ,
  32 .BI "                             DMXDesktopAttributes " *attr );
  33 .fi
  34 .SH DESCRIPTION
  35 .B DMXGetDesktopAttributes()
  36 returns information about the desktop in
  37 .BR DMXDesktopAttributes :
  38 .sp
  39 .nf
  40 typedef struct {
  41     unsigned int width;
  42     unsigned int height;
  43     int          shiftX;
  44     int          shiftY;
  45 } DMXDesktopAttributes;
  46 .fi
  47 .PP
  48 The size of the global bounding box is given in
  49 .IR width ", and " height .
  50 The
  51 .IR shiftX " and " shiftY
  52 values will always be 0.  The global bounding box is computed whether or
  53 not Xinerama is active, but it is only useful when using Xinerama.
  54 .PP
  55 The global bounding box used by
  56 .BR Xdmx (1)
  57 may be larger than the Xinerama screen size because of information in
  58 the configuration file.
  59 .SH "RETURN VALUE"
  60 .B DMXGetDesktopAttributes()
  61 returns
  62 .B True
  63 unless there is a protocol error.
  64 .SH "SEE ALSO"
  65 .BR DMXChangeDesktopAttributes "(__libmansuffix__), " DMX "(__libmansuffix__), " Xdmx (1)