xenocara/lib/libXpresent/man/Xpresent.man
2018-08-05 12:04:39 +00:00

71 lines
2.2 KiB
Groff

.\"
.\"
.\" Copyright © 2013 Keith Packard
.\"
.\" Permission to use, copy, modify, distribute, and sell this software and its
.\" documentation for any purpose is hereby granted without fee, provided that
.\" the above copyright notice appear in all copies and that both that copyright
.\" notice and this permission notice appear in supporting documentation, and
.\" that the name of the copyright holders not be used in advertising or
.\" publicity pertaining to distribution of the software without specific,
.\" written prior permission. The copyright holders make no representations
.\" about the suitability of this software for any purpose. It is provided "as
.\" is" without express or implied warranty.
.\"
.\" THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\" EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
.\" DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
.\" OF THIS SOFTWARE.
.\"
.de TQ
.br
.ns
.TP \\$1
..
.TH XPRESENT __libmansuffix__ __xorgversion__
.SH NAME
Xpresent \- X Present Extension
.SH SYNTAX
\&#include <X11/extensions/Xpresent.h>
.nf
.sp
Bool XPresentQueryExtension \^(\^Display *\fIdpy\fP,
int *\fIevent_base_return\fP, int *\fIerror_base_return\fP\^);
.sp
Status XPresentQueryVersion \^(\^Display *\fIdpy\fP,
int *\fImajor_version_return\fP,
int *\fIminor_version_return\fP\^);
.sp
void XPresentRegion \^(\^Display *dpy,
Window \fIwindow\fP,
Pixmap \fIpixmap\fP,
uint32_t serial,
XserverRegion valid,
XserverRegion update,
int x_off,
int y_off,
XID idle_fence,
XID target_crtc,
uint64_t target_msc,
uint64_t divisor,
uint64_t remainder);
.fi
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.IP \fIwindow\fP 1i
Specifies which window.
.SH DESCRIPTION
.B Xpresent
is a library designed to interface the X Present
Extension.
.SH RESTRICTIONS
.B Xpresent
will remain upward compatible after the 1.0 release.
.SH AUTHORS
Keith Packard, Intel