fdo-mirrors/xorg-xorgproto
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/xorg/proto/xorgproto.git synced 2026-05-08 03:08:09 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove trailing white space from randrproto.txt

Browse source
This commit is contained in:
Keith Packard 2009-06-05 20:37:24 -07:00
parent 92789c6c3a
commit d9ee6abdef
1 changed files with 76 additions and 76 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

152
randrproto.txt
View file

@ -1,13 +1,13 @@
The X Resize, Rotate and Reflect Extension
Version 1.3
2006-20-7
Jim Gettys
Jim.Gettys@hp.com
Cambridge Research Laboratory
HP Labs
Hewlett Packard Company
Keith Packard
keith.packard@intel.com
Open Source Technology Center
@ -35,13 +35,13 @@ These events include:
on laptops or desktop systems
► The continued decline of legacy toolkits whose design would have
required depth switching to support migration
► The lack of depth switching implementation experience in the
► The lack of depth switching implementation experience in the
intervening time, due to events beyond our control
Additionally, the requirement to support depth switching might
complicate other re-engineering of the device independent part of the
X server that is currently being contemplated.
Rather than further delaying RandR's widespread deployment for a feature
long wanted by the community (resizing of screens, particularly on laptops),
or the deployment of a protocol design that might be flawed due to lack of
@ -61,7 +61,7 @@ monitors display portions of a common underlying screen. In this environment,
zero or more video outputs are associated with each CRT controller which
defines both a set of video timings and a 'viewport' within the larger
screen. This viewport is independent of the overall size of the screen, and
may be located anywhere within the screen.
may be located anywhere within the screen.
The effect is to decouple the reported size of the screen from the size
presented by each video output, and to permit multiple outputs to present
@ -85,7 +85,7 @@ Additional requests and events are provided for this new functionality.
┃ ┏━━━╋━━━━━━━━━━━━━━━┫ ║ ║ ║ ║
┣━━━╋━━━┛ ┃ ╚════════╝ ╚════════╝
│ ┃ 2 ┃─────────────────┐
│ ┃ ┃ ╔═══════════════════╗
│ ┃ ┃ ╔═══════════════════╗
│ ┃ ┃ ║ ║
│ ┗━━━━━━━━━━━━━━━━━━━┫ ║ C ║
└───────────────────────┘ ║ ║
@ -215,7 +215,7 @@ RRCONFIGSTATUS { Success
A value of type RRCONFIGSTATUS returned when manipulating the output
configuration or querying information from the server that has some
time-dependency.
InvalidConfigTime indicates that the supplied configuration
timestamp does not match the current X server configuration
timestamp. Usually this means that the output configuration has
@ -249,7 +249,7 @@ ROTATION { Rotate_0
RRSELECTMASK { RRScreenChangeNotifyMask
RRCrtcChangeNotifyMask (New in version 1.2)
RROutputChangeNotifyMask (New in version 1.2)
RROutputChangeNotifyMask (New in version 1.2)
RROutputPropertyNotifyMask (New in version 1.2) }
SIZEID { CARD16 }
@ -342,25 +342,25 @@ The name of this extension is "RANDR".
the client connected, to avoid race conditions.
New for version 1.2:
If 'enable' contains RRCrtcChangeMask, RRCrtcChangeNotify events
will be sent when a the configuration for a CRTC associated with the
screen changes, either through this protocol extension or due to
detected external changes. RRCrtcChangeNotify may also be sent when
this request executes if the CRTC configuration has changed since
the client connected, to avoid race conditions.
the client connected, to avoid race conditions.
If 'enable' contains RROutputChangeMask, RROutputChangeNotify events
will be sent when a the configuration for an output associated with
the screen changes, either through this protocol extension or due to
detected external changes. RROutputChangeNotify may also be sent
when this request executes if the output configuration has changed
since the client connected, to avoid race conditions.
since the client connected, to avoid race conditions.
If 'enable' contains RROutputPropertyNotifyMask,
RROutputPropertyNotify events will be sent when properties change on
this output.
┌───
RRSetScreenConfig
window: WINDOW
@ -381,7 +381,7 @@ The name of this extension is "RANDR".
If 'timestamp' is less than the time when the configuration was last
successfully set, the request is ignored and InvalidTime returned in
status.
If 'config-timestamp' is not equal to when the server's screen
configurations last changed, the request is ignored and
InvalidConfigTime returned in status. This could occur if the
@ -396,19 +396,19 @@ The name of this extension is "RANDR".
This request may fail for other indeterminate reasons, in which case
'status' will be set to Failed and no configuration change will be
made.
This request sets the screen to the specified size, rate, rotation
and reflection.
When this request succeeds, 'status' contains Success and the
requested changes to configuration will have been made.
'new-time-stamp' contains the time at which this request was
executed.
'config-timestamp' contains the time when the possible screen
configurations were last changed.
'root' contains the root window for the screen indicated by the
window.
@ -421,7 +421,7 @@ The name of this extension is "RANDR".
┌───
RRGetScreenInfo
window: WINDOW
▶
▶
rotations: SETofROTATION
root: WINDOW
timestamp: TIMESTAMP
@ -442,15 +442,15 @@ The name of this extension is "RANDR".
by the screen.
'root' is the root window of the screen.
'config-timestamp' indicates when the screen configuration
information last changed: requests to set the screen will fail
unless the timestamp indicates that the information the client
is using is up to date, to ensure clients can be well behaved
in the face of race conditions.
in the face of race conditions.
'timestamp' indicates when the configuration was last set.
'size-id' indicates which size is active.
'rate' is the current refresh rate. This is zero when the refresh
@ -533,7 +533,7 @@ dynamic changes in the display environment.
to the screen associated with 'window'.
'timestamp' indicates when the configuration was last set.
'config-timestamp' indicates when the configuration information last
changed. Requests to configure the output will fail unless the
timestamp indicates that the information the client is using is up
@ -545,7 +545,7 @@ dynamic changes in the display environment.
'outputs' contains the list of outputs associated with the screen.
'modes' contains the list of modes associated with the screen
This request explicitly asks the server to ensure that the
configuration data is up-to-date wrt the hardware. If that requires
polling, this is when such polling would take place. If the
@ -560,7 +560,7 @@ dynamic changes in the display environment.
status: RRCONFIGSTATUS
timestamp: TIMESTAMP
crtc: CRTC
name: STRING
connection: CONNECTION
subpixel-order: SUBPIXELORDER
@ -573,15 +573,15 @@ dynamic changes in the display environment.
Errors: Output
RRGetOutputInfo returns information about the current and available
configurations 'output'.
configurations 'output'.
If 'config-timestamp' does not match the current configuration
timestamp (as returned by RRGetScreenResources), 'status' is set to
InvalidConfigTime and the remaining reply data is empty. Otherwise,
'status' is set to Success.
'timestamp' indicates when the configuration was last set.
'crtc' is the current source CRTC for video data, or Disabled if the
output is not connected to any CRTC.
@ -592,7 +592,7 @@ dynamic changes in the display environment.
device connected to this output. If the hardware cannot determine
whether something is connected, it will set this to
UnknownConnection.
'subpixel-order' contains the resulting subpixel order of the
connected device to allow correct subpixel rendering.
@ -648,7 +648,7 @@ dynamic changes in the display environment.
and be automatically copied to the current value on the next
RRSetCrtcConfig request involving the named output. If 'pending' is
FALSE, changes are copied immediately.
If 'range' is TRUE, then the valid-values list will contain
precisely two values indicating the minimum and maximum allowed
values. If 'range' is FALSE, then the valid-values list will contain
@ -658,7 +658,7 @@ dynamic changes in the display environment.
If 'immutable' is TRUE, then the property configuration cannot be
changed by clients. Immutable properties are interpreted by the X
server.
┌───
RRConfigureOutputProperty
output: OUTPUT
@ -687,7 +687,7 @@ dynamic changes in the display environment.
data: LISTofINT8 or LISTofINT16 or LISTofINT32
└───
Errors: Alloc, Atom, Match, Value, Output
This request alters the value of the property for the specified
output. If the property is marked as a 'pending' property, only the
pending value of the property is changed. Otherwise, changes are
@ -702,7 +702,7 @@ dynamic changes in the display environment.
match the existing property value (or a Match error results). If
the property is undefined, it is treated as defined with the correct
type and format with zero-length data.
For Prepend, the data is tacked on to the beginning of the existing
data, and for Append, it is tacked on to the end of the existing data.
@ -713,7 +713,7 @@ dynamic changes in the display environment.
destroyed, or until server reset (see section 10).
The maximum size of a property is server-dependent and may vary
dynamically.
dynamically.
┌───
RRDeleteOutputProperty
@ -721,7 +721,7 @@ dynamic changes in the display environment.
property: ATOM
└───
Errors: Atom, Output
This request deletes the property from the specified window if the
property exists and generates a OutputPropertyNotify event unless
the property does not exist.
@ -745,28 +745,28 @@ dynamic changes in the display environment.
If the specified property does not exist for the specified output,
then the return type is None, the format and bytes-after are zero,
and the value is empty. The delete argument is ignored in this
case.
case.
If the specified property exists but its type does not match the
specified type, then the return type is the actual type of the
property, the format is the actual format of the property (never
zero), the bytes-after is the length of the property in bytes (even
if the format is 16 or 32), and the value is empty. The delete
argument is ignored in this case.
argument is ignored in this case.
If the specified property exists and either AnyPropertyType is
specified or the specified type matches the actual type of the
property, then the return type is the actual type of the property,
the format is the actual format of the property (never zero), and
the bytes-after and value are as follows, given:
N = actual length of the stored property in bytes
N = actual length of the stored property in bytes
(even if the format is 16 or 32)
I = 4 × offset
T = N - I
L = MINIMUM(T, 4 × long-length)
A = N - (I + L)
If 'pending' is true, and if the property holds a pending value,
then the value returned will be the pending value of the property
rather than the current value. The returned value starts at byte
@ -785,14 +785,14 @@ dynamic changes in the display environment.
mode: MODE
└───
Errors: Window, Name, Value
'modeinfo' provides a new mode for outputs on the screen
associated with 'window'. If the name of 'modeinfo' names an
existing mode, a Name error is returned. If some parameter of the
mode is not valid in some other way, a Value error is returned.
The returned 'mode' provides the id for the mode.
┌───
RRDestroyMode
mode: MODE
@ -803,7 +803,7 @@ dynamic changes in the display environment.
defined with RRCreateMode, else an Match error is returned. If
'mode' is in use by some CRTC or Output, then an Access error is
returned.
┌───
RRAddOutputMode
output: OUTPUT
@ -814,10 +814,10 @@ dynamic changes in the display environment.
'output' indicates which output is to be configured.
'mode' specifies which mode to add. If 'mode' is not valid for
'output', then a Match error is generated.
'output', then a Match error is generated.
This request generates OutputChangeNotify events.
┌───
RRDeleteOutputMode
output: OUTPUT
@ -845,7 +845,7 @@ dynamic changes in the display environment.
mode: MODE
rotation: ROTATION
outputs: LISTofOUTPUT
rotations: SETofROTATION
possible-outputs: LISTofOUTPUT
└───
@ -860,23 +860,23 @@ dynamic changes in the display environment.
timestamp (as returned by RRGetScreenResources), 'status' is set to
InvalidConfigTime and the remaining reply data is empty. Otherwise,
'status' is set to Success.
'timestamp' indicates when the configuration was last set.
'x' and 'y' indicate the position of this CRTC within the screen
region. They will be set to 0 when the CRTC is disabled.
'width' and 'height' indicate the size of the area within the screen
presented by this CRTC. This may be different than the size of the
mode due to rotation. They will be set to 0 when the CRTC
is disabled.
is disabled.
'mode' indicates which mode is active, or None indicating that the
CRTC has been disabled and is not displaying the screen contents.
'rotation' indicates the active rotation. It is set to Rotate_0
when the CRTC is disabled.
'outputs' is the list of outputs currently connected to this CRTC
and is empty when the CRTC is disabled.
@ -904,7 +904,7 @@ dynamic changes in the display environment.
If 'timestamp' is less than the time when the configuration was last
successfully set, the request is ignored and InvalidTime returned in
status.
If 'config-timestamp' is not equal to when the monitor's
configuration last changed, the request is ignored and
InvalidConfigTime returned in status. This could occur if the
@ -929,16 +929,16 @@ dynamic changes in the display environment.
'outputs' contains the set of outputs that this CRTC should be
connected to. The set must be among the list of acceptable output
sets for this CRTC or a Match error results.
sets for this CRTC or a Match error results.
If 'mode' is None, then 'outputs' must be empty, else a Match error
results. Conversely, if 'mode' is not None, then 'outputs' must not be
empty, else a Match error results.
This request may fail for other indeterminate reasons, in which case
'status' will be set to Failed and no configuration change will be
made.
This request sets the CRTC to the specified position, mode, rotation
and reflection. The entire area of the CRTC must fit within the
screen size, else a Match error results. As an example, rotating the
@ -955,10 +955,10 @@ dynamic changes in the display environment.
When this request succeeds, 'status' contains Success and the
requested changes to configuration will have been made.
'new-time-stamp' contains the time at which this request was
executed.
┌───
RRGetCrtcGammaSize
crtc: CRTC
@ -976,13 +976,13 @@ dynamic changes in the display environment.
red: LISTofCARD16
green: LISTofCARD16
blue: LISTofCARD16
└───
└───
Errors: Crtc
This request returns the currently set gamma ramps for 'crtc'. All
three lists will be the size returned by the RRGetCrtcGammaSize
request.
┌───
RRSetCrtcGamma
crtc: CRTC
@ -991,7 +991,7 @@ dynamic changes in the display environment.
blue: LISTofCARD16
└───
Errors: Crtc, Match
This request sets the gamma ramps for 'crtc'. All three lists
must be the size returned by RRGetCrtcGammaSize else a Value error
results.
@ -1014,7 +1014,7 @@ dynamic changes in the display environment.
connected to the screen associated with 'window'.
'timestamp' indicates when the configuration was last set.
'config-timestamp' indicates when the configuration information last
changed. Requests to configure the output will fail unless the
timestamp indicates that the information the client is using is up
@ -1026,7 +1026,7 @@ dynamic changes in the display environment.
'outputs' contains the list of outputs associated with the screen.
'modes' contains the list of modes associated with the screen.
Unlike RRGetScreenResources, this merely returns the current
configuration, and does not poll for hardware changes.
@ -1667,7 +1667,7 @@ A.1 Common Types
0x0008 OutputPropertyNotifyMask Added in version 1.2
└───
Event select mask for RRSelectInput
┌───
RRCONFIGSTATUS
0x0 Success
@ -1676,7 +1676,7 @@ A.1 Common Types
0x3 Failed
└───
Return status for requests which depend on time.
┌───
MODEINFO (32) Added in version 1.2
4 CARD32 id
@ -1693,7 +1693,7 @@ A.1 Common Types
2 CARD16 name length
4 SETofMODEFLAG mode flags
└───
An output mode specifies the complete CRTC timings for
a specific mode. The vertical and horizontal synchronization rates
can be computed given the dot clock and the h total/v total
@ -1701,7 +1701,7 @@ A.1 Common Types
parameters and flags are not used, and must be zero as this
indicates that the timings are unknown or otherwise unused.
The name itself will be encoded separately in each usage.
┌───
MODEFLAG
0x00000001 HSyncPositive
@ -1750,7 +1750,7 @@ errors if used in version 1.0.
└───
┌───
RRSetScreenConfig
1 CARD8 major opcode
1 2 RandR opcode
2 6 length
@ -2183,7 +2183,7 @@ A.2.2 Protocol Requests added with version 1.3
p unused, p=pad(n)
4v FIXED filter params
└───
┌───
RRGetCrtcTransform
1 CARD8 major opcode
@ -2211,7 +2211,7 @@ A.2.2 Protocol Requests added with version 1.3
cnp unused, cnp=pad(cn)
4*cf FIXED current filter params
└───
┌───
RRGetPanning
1 CARD8 major opcode
@ -2273,7 +2273,7 @@ A.2.2 Protocol Requests added with version 1.3
4 WINDOW window
4 OUTPUT output
└───
┌───
RRGetOutputPrimary
1 CARD8 major opcode
@ -2367,13 +2367,13 @@ A.4 Protocol Errors
Base + 1 Crtc
Base + 2 Mode
└───
Bibliography
[RANDR] Gettys, Jim and Keith Packard, "The X Resize and Rotate
Extension - RandR", Proceedings of the 2001 USENIX Annual
Technical Conference, Boston, MA
[RENDER]
[RENDER]
Packard, Keith, "The X Rendering Extension", work in progress,
http://cgit.freedesktop.org/xorg/proto/renderproto/tree/renderproto.txt