Blame man/DMXChangeScreensAttributes.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 DMXChangeScreensAttributes __libmansuffix__ __vendorversion__
Packit ec660a
.SH NAME
Packit ec660a
DMXChangeScreensAttributes \- change back-end screen attributes
Packit ec660a
.SH SYNOPSIS
Packit ec660a
.B #include <X11/extensions/dmxext.h>
Packit ec660a
.sp
Packit ec660a
.nf
Packit ec660a
.BI "int DMXChangeScreensAttributes(Display " *dpy ,
Packit ec660a
.BI "                               int " screen_count ,
Packit ec660a
.BI "                               int " *screens ,
Packit ec660a
.BI "                               int " mask_count ,
Packit ec660a
.BI "                               unsigned int " *masks ,
Packit ec660a
.BI "                               DMXScreenAttributes " *attr ,
Packit ec660a
.BI "                               int *" error_screen );
Packit ec660a
.fi
Packit ec660a
.SH DESCRIPTION
Packit ec660a
.B DMXChangeScreensAttributes()
Packit ec660a
changes the geometries and positions of the DMX screen and DMX root
Packit ec660a
windows on the back-end X servers.
Packit ec660a
.I screen_count
Packit ec660a
specifies the number of screens to be changed.  For each screen, the
Packit ec660a
screen number is placed in
Packit ec660a
.IR screens ,
Packit ec660a
an attribute mask is placed in
Packit ec660a
.IR masks ,
Packit ec660a
and a
Packit ec660a
.I DMXScreenAttributes
Packit ec660a
structure is included in
Packit ec660a
.IR attr .
Packit ec660a
.PP
Packit ec660a
An explanation of the
Packit ec660a
.I DMXScreenAttributes
Packit ec660a
structure is given in
Packit ec660a
.BR DMXGetScreenAttributes (__libmansuffix__).
Packit ec660a
.PP
Packit ec660a
The values that are used to compute each value in
Packit ec660a
.I masks
Packit ec660a
are as follows
Packit ec660a
.sp
Packit ec660a
.nf
Packit ec660a
DMXScreenWindowWidth
Packit ec660a
DMXScreenWindowHeight
Packit ec660a
DMXScreenWindowXoffset
Packit ec660a
DMXScreenWindowYoffset
Packit ec660a
DMXRootWindowWidth
Packit ec660a
DMXRootWindowHeight
Packit ec660a
DMXRootWindowXoffset
Packit ec660a
DMXRootWindowYoffset
Packit ec660a
DMXRootWindowXorigin
Packit ec660a
DMXRootWindowYorigin
Packit ec660a
.fi
Packit ec660a
.PP
Packit ec660a
In general,
Packit ec660a
.I mask_count
Packit ec660a
should be equal to
Packit ec660a
.IR screen_count .
Packit ec660a
However, as a convenience,
Packit ec660a
.I mask_count
Packit ec660a
may be less than
Packit ec660a
.IR screen_count ,
Packit ec660a
and the last entry in
Packit ec660a
.I masks
Packit ec660a
will then be used for all of the remaining screens.  For example, this
Packit ec660a
allows identical changes to be made to several screens using only one
Packit ec660a
mask.
Packit ec660a
.SH "RETURN VALUE"
Packit ec660a
On success, 0 is returned.  Otherwise,
Packit ec660a
.I error_screen
Packit ec660a
is set to the value of the first screen in the list that caused the
Packit ec660a
error and a non-zero value is returned.  If
Packit ec660a
.I screen_count
Packit ec660a
or
Packit ec660a
.I mask_count
Packit ec660a
is less than 1, or if any of the attribute values are not within the
Packit ec660a
appropriate bounding boxes,
Packit ec660a
.B DmxBadValue
Packit ec660a
is returned.  If a protocol error occurs,
Packit ec660a
.B DmxBadReply
Packit ec660a
is returned.
Packit ec660a
.PP
Packit ec660a
.B DMXChangeScreensAttributes()
Packit ec660a
can generate
Packit ec660a
.B BadLength
Packit ec660a
(if the data provided does not match the data implicitly required by the
Packit ec660a
.I screen_count
Packit ec660a
and
Packit ec660a
.I mask_count
Packit ec660a
values),
Packit ec660a
.B BadValue
Packit ec660a
(if the values in
Packit ec660a
.I screens
Packit ec660a
are not valid), and
Packit ec660a
.B BadAlloc
Packit ec660a
errors.
Packit ec660a
.SH "SEE ALSO"
Packit ec660a
.BR DMXGetScreenCount "(__libmansuffix__), "
Packit ec660a
.BR DMXGetScreenAttributes "(__libmansuffix__), "
Packit ec660a
.BR DMX "(__libmansuffix__), " Xdmx (1)