summaryrefslogtreecommitdiff
path: root/man/Xrandr.man
diff options
context:
space:
mode:
Diffstat (limited to 'man/Xrandr.man')
-rw-r--r--man/Xrandr.man51
1 files changed, 41 insertions, 10 deletions
diff --git a/man/Xrandr.man b/man/Xrandr.man
index 71fbdf0..0e84e59 100644
--- a/man/Xrandr.man
+++ b/man/Xrandr.man
@@ -1,8 +1,7 @@
.\"
-.\" $XFree86: xc/lib/Xrandr/Xrandr.man,v 1.3 2002/10/08 13:00:48 keithp Exp $
-.\"
-.\" Copyright © 2002 Hewlett-Packard Company
+.\" $XFree86: xc/lib/Xrandr/Xrandr.man,v 1.7 2003/08/04 10:32:21 eich Exp $
.\"
+.\" Copyright 2002 Hewlett-Packard Company.\"
.\" 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
@@ -54,6 +53,14 @@ Status XRRSetScreenConfig \^(\^Display *\fIdpy\fP,
Rotation \fIrotation\fP,
Time \fItimestamp\fP\^);
.sp
+Status XRRSetScreenConfigAndRate \^(\^Display *\fIdpy\fP,
+ XRRScreenConfiguration *\fIconfig\fP,
+ Drawable \fIdraw\fP,
+ int \fIsize_index\fP,
+ Rotation \fIrotation\fP,
+ short \fIrate\fP,
+ Time \fItimestamp\fP\^);
+.sp
Rotation XRRConfigRotations\^(\^
XRRScreenConfiguration *\fIconfig\fP,
Rotation *\fIcurrent_rotation\fP\^);
@@ -66,10 +73,18 @@ XRRScreenSize *XRRConfigSizes\^(\^
XRRScreenConfiguration *\fIconfig\fP,
int *\fInsizes\fP\^);
.sp
+short *XRRConfigRates \^(\^
+ XRRScreenConfiguration *\fIconfig\fP,
+ int \fIsize_index\fP,
+ int *\fInrates\fP\^);
+.sp
SizeID XRRConfigCurrentConfiguration \^(\^
XRRScreenConfiguration *\fIconfig\fP,
Rotation *\fIrotation\fP\^);
-.sp
+.sp
+short XRRConfigCurrentRate \^(\^
+ XRRScreenConfiguration *\fIconfig\fP\^);
+.sp
int XRRRootToScreen\^(\^
Display *\fIdpy\fP,
Window \fIroot\fP\^);
@@ -100,6 +115,9 @@ Rotation XRRRotations\^(\^
XRRScreenSize *XRRSizes\^(\^Display *\fIdpy\fP,
int \fIscreen\fP, int *\fInsizes\fP\^);
.sp
+short *XRRRates \^(\^Display *\fIdpy\fP, int \fIscreen\fP,
+ int \fIsize_index\fP, int *\fInrates\fP\^);
+.sp
Time XRRTimes \^(\^Display *\fIdpy\fP, int \fIscreen\fP, Time *\fIconfig_timestamp\fP\^);
.fi
.SH ARGUMENTS
@@ -121,6 +139,8 @@ Specifies the timestamp when the screen was last (re)configured.
Specifies the screen configuration being used.
.IP \fIsizes\fP 1i
Specifies the array of sizes supported.
+.IP \fIrate\fP 1i
+Specifies the refresh rate in Hz.
.SH DATATYPES
@@ -187,7 +207,7 @@ This is to help issues when screens may become hot-pluggable in the future.
is a simple library designed to interface the X Resize and Rotate
Extension. This allows clients to change the size and rotation of the
root window of a screen, along with the ability to reflect the screen
-about either axis (if supported by the impementation). Rotation and
+about either axis (if supported by the implementation). Rotation and
reflection may be implemented by software and may result in slower
performance if rotation and reflection are implemented in this fashion
(as are all implementations as of October 2002).
@@ -239,7 +259,7 @@ Generally, toolkits will perform this operation on behalf of applications;
we did not want to change display structure data behind the back of toolkits,
as in multithreaded clients, various race conditions might occur.
Toolkits should provide clients some mechanism for notification of
-screen change, of couse.
+screen change, of course.
.SH FUNCTIONS
There are two classes of interfaces: those which can be safely called
@@ -258,6 +278,10 @@ the specified screen. The first size specified is the default size
of the server. If RandR is not supported, it returns 0 for
the number of sizes.
.PP
+.B XRRRates
+returns a pointer to a the rates supported by the specified size.
+If RandR is not supported, it returns 0 for the number of rates.
+.PP
.B XRRTimes
returns the time last reported by the server along with the
timestamp the last configuration changed.
@@ -277,7 +301,7 @@ values on the screen specified by \fIdraw\fP, or returns a
.B BadValue
error.
\fIsize_index\fP specifies which size configuration is to be used,
-\fIrotation\fP specifies which rotatation or reflection is to
+\fIrotation\fP specifies which rotation or reflection is to
be used (or a
.B BadValue
error is returned).
@@ -287,11 +311,20 @@ to indicate success or failure; a client must refresh its configuration
information if it fails and try the call again (by calling
\fBXRRGetScreenInfo\fP).
.PP
+.B XRRSetScreenConfigAndRate
+like
+.B XRRSetScreenConfig
+but also set the refresh rate. If specified rate is not supported a
+.B BadValue
+error is returned.
+.PP
.B XRRConfigRotations,
.B XRRConfigSizes,
.B XRRConfigCurrentConfiguration,
+.B XRRConfigTimes,
+.B XRRConfigRates,
and
-.B XRRConfigTimes
+.B XRRConfigCurrentRate
are used to get specific configuration information out of a screen
configuration.
.PP
@@ -312,8 +345,6 @@ is cached by the library).
.SH RESTRICTIONS
.B Xrandr
will remain upward compatible after the current 1.0 release.
-.SH "SEE ALSO"
-Xrender(3)
.SH AUTHOR
Jim Gettys, HP, and Keith Packard, member of the XFree86 Project, Inc. and
HP.