1<?xml version="1.0" encoding="utf-8"?>
2<!--
3Copyright (C) 2004 Josh Triplett.  All Rights Reserved.
4
5Permission is hereby granted, free of charge, to any person obtaining a copy
6of this software and associated documentation files (the "Software"), to deal
7in the Software without restriction, including without limitation the rights
8to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9copies of the Software, and to permit persons to whom the Software is
10furnished to do so, subject to the following conditions:
11
12The above copyright notice and this permission notice shall be included in all
13copies or substantial portions of the Software.
14
15THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
19ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22Except as contained in this notice, the names of the authors or their
23institutions shall not be used in advertising or otherwise to promote the
24sale, use or other dealings in this Software without prior written
25authorization from the authors.
26
27Copyright (c) 2006, Oracle and/or its affiliates.
28
29Permission is hereby granted, free of charge, to any person obtaining a
30copy of this software and associated documentation files (the "Software"),
31to deal in the Software without restriction, including without limitation
32the rights to use, copy, modify, merge, publish, distribute, sublicense,
33and/or sell copies of the Software, and to permit persons to whom the
34Software is furnished to do so, subject to the following conditions:
35
36The above copyright notice and this permission notice (including the next
37paragraph) shall be included in all copies or substantial portions of the
38Software.
39
40THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
41IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
42FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
43THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
44LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
45FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
46DEALINGS IN THE SOFTWARE.
47
48Copyright © 2003 Keith Packard
49
50Permission to use, copy, modify, distribute, and sell this software and its
51documentation for any purpose is hereby granted without fee, provided that
52the above copyright notice appear in all copies and that both that
53copyright notice and this permission notice appear in supporting
54documentation, and that the name of Keith Packard not be used in
55advertising or publicity pertaining to distribution of the software without
56specific, written prior permission.  Keith Packard makes no
57representations about the suitability of this software for any purpose.  It
58is provided "as is" without express or implied warranty.
59
60KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
61INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
62EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
63CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
64DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
65TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
66PERFORMANCE OF THIS SOFTWARE.
67
68-->
69<!-- This file describes version 0.3 of COMPOSITE. -->
70<xcb header="composite" extension-xname="Composite" extension-name="Composite"
71    major-version="0" minor-version="4">
72
73  <import>xproto</import>
74  <import>xfixes</import>
75
76  <enum name="Redirect">
77    <item name="Automatic"> <value>0</value> </item>
78    <item name="Manual">    <value>1</value> </item>
79  </enum>
80
81  <request name="QueryVersion" opcode="0">
82    <field type="CARD32" name="client_major_version" />
83    <field type="CARD32" name="client_minor_version" />
84    <reply>
85      <pad bytes="1" />
86      <field type="CARD32" name="major_version" />
87      <field type="CARD32" name="minor_version" />
88      <pad bytes="16" />
89      <doc>
90	<brief>The negotiated version of Composite</brief>
91	<description>
92This indicates the version of Composite chosen by the server.  It will always be
93less than or equal to the version offered by the client.
94	</description>
95	<field name="major_version">The major version chosen by the server.</field>
96	<field name="minor_version">The minor version chosen by the server.</field>
97      </doc>
98    </reply>
99    <doc>
100      <brief>Negotiate the version of Composite</brief>
101      <description>
102This negotiates the version of the Composite extension.  It must be precede all
103other requests using Composite.  Failure to do so will cause a BadRequest error.
104      </description>
105      <field name="client_major_version">The major version supported by the client.</field>
106      <field name="client_minor_version">The minor version supported by the client.</field>
107    </doc>
108  </request>
109
110  <request name="RedirectWindow" opcode="1">
111    <field type="WINDOW" name="window" />
112    <field type="CARD8" name="update" enum="Redirect" />
113    <pad bytes="3" />
114    <doc>
115      <brief>Redirect the hierarchy starting at "window" to off-screen storage.</brief>
116      <description>
117	The hierarchy starting at 'window' is directed to off-screen
118	storage.  When all clients enabling redirection terminate,
119	the redirection will automatically be disabled.
120
121	The root window may not be redirected. Doing so results in a Match
122	error.
123      </description>
124      <field name="window">The root of the hierarchy to redirect to off-screen storage.</field>
125      <field name="update">
126	Whether contents are automatically mirrored to the parent window.  If one client
127	already specifies an update type of Manual, any attempt by another to specify a
128	mode of Manual so will result in an Access error.
129      </field>
130    </doc>
131  </request>
132
133  <request name="RedirectSubwindows" opcode="2">
134    <field type="WINDOW" name="window" />
135    <field type="CARD8" name="update" enum="Redirect" />
136    <pad bytes="3" />
137    <doc>
138      <brief>Redirect all current and future children of ‘window’</brief>
139      <description>
140	Hierarchies starting at all current and future children of window
141	will be redirected as in RedirectWindow. If update is Manual,
142	then painting of the window background during window manipulation
143	and ClearArea requests is inhibited.
144      </description>
145      <field name="window">The root of the hierarchy to redirect to off-screen storage.</field>
146      <field name="update">
147	Whether contents are automatically mirrored to the parent window.  If one client
148	already specifies an update type of Manual, any attempt by another to specify a
149	mode of Manual so will result in an Access error.
150      </field>
151    </doc>
152  </request>
153
154  <request name="UnredirectWindow" opcode="3">
155    <field type="WINDOW" name="window" />
156    <field type="CARD8" name="update" enum="Redirect" />
157    <pad bytes="3" />
158    <doc>
159      <brief>Terminate redirection of the specified window.</brief>
160      <description>
161	Redirection of the specified window will be terminated.  This cannot be
162	used if the window was redirected with RedirectSubwindows.
163      </description>
164      <field name="window">
165	The window to terminate redirection of.  Must be redirected by the
166	current client, or a Value error results.
167      </field>
168      <field name="update">
169	The update type passed to RedirectWindows.  If this does not match the
170	previously requested update type, a Value error results.
171      </field>
172    </doc>
173  </request>
174
175  <request name="UnredirectSubwindows" opcode="4">
176    <field type="WINDOW" name="window" />
177    <field type="CARD8" name="update" enum="Redirect" />
178    <pad bytes="3" />
179    <doc>
180      <brief>Terminate redirection of the specified window’s children</brief>
181      <description>
182	Redirection of all children of window will be terminated.
183      </description>
184      <field name="window">
185	The window to terminate redirection of.  Must have previously been
186	selected for sub-redirection by the current client, or a Value error
187	results.
188      </field>
189      <field name="update">
190	The update type passed to RedirectSubWindows.  If this does not match
191	the previously requested update type, a Value error results.
192      </field>
193    </doc>
194  </request>
195
196  <request name="CreateRegionFromBorderClip" opcode="5">
197    <field type="REGION" name="region" />
198    <field type="WINDOW" name="window" />
199  </request>
200
201  <request name="NameWindowPixmap" opcode="6">
202    <field type="WINDOW" name="window" />
203    <field type="PIXMAP" name="pixmap" />
204  </request>
205  
206  <!-- new in version 0.3 -->
207  
208  <request name="GetOverlayWindow" opcode="7">
209    <field type="WINDOW" name="window" />
210    <reply>
211      <pad bytes="1" />
212      <field type="WINDOW" name="overlay_win" />
213      <pad bytes="20" />
214    </reply>
215  </request>
216
217  <request name="ReleaseOverlayWindow" opcode="8">
218    <field type="WINDOW" name="window" />
219  </request>
220</xcb>
221