xref: /xsrc/external/mit/xcb-proto/dist/src/composite.xml

<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright (C) 2004 Josh Triplett.  All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the names of the authors or their
institutions shall not be used in advertising or otherwise to promote the
sale, use or other dealings in this Software without prior written
authorization from the authors.

Copyright (c) 2006, Oracle and/or its affiliates.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Copyright © 2003 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 Keith Packard not be used in
advertising or publicity pertaining to distribution of the software without
specific, written prior permission.  Keith Packard makes no
representations about the suitability of this software for any purpose.  It
is provided "as is" without express or implied warranty.

KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL KEITH PACKARD 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.

-->
<!-- This file describes version 0.3 of COMPOSITE. -->
<xcb header="composite" extension-xname="Composite" extension-name="Composite"
    major-version="0" minor-version="4">

  <import>xproto</import>
  <import>xfixes</import>

  <enum name="Redirect">
    <item name="Automatic"> <value>0</value> </item>
    <item name="Manual">    <value>1</value> </item>
  </enum>

  <request name="QueryVersion" opcode="0">
    <field type="CARD32" name="client_major_version" />
    <field type="CARD32" name="client_minor_version" />
    <reply>
      <pad bytes="1" />
      <field type="CARD32" name="major_version" />
      <field type="CARD32" name="minor_version" />
      <pad bytes="16" />
      <doc>
	<brief>The negotiated version of Composite</brief>
	<description>
This indicates the version of Composite chosen by the server.  It will always be
less than or equal to the version offered by the client.
	</description>
	<field name="major_version">The major version chosen by the server.</field>
	<field name="minor_version">The minor version chosen by the server.</field>
      </doc>
    </reply>
    <doc>
      <brief>Negotiate the version of Composite</brief>
      <description>
This negotiates the version of the Composite extension.  It must be precede all
other requests using Composite.  Failure to do so will cause a BadRequest error.
      </description>
      <field name="client_major_version">The major version supported by the client.</field>
      <field name="client_minor_version">The minor version supported by the client.</field>
    </doc>
  </request>

  <request name="RedirectWindow" opcode="1">
    <field type="WINDOW" name="window" />
    <field type="CARD8" name="update" enum="Redirect" />
    <pad bytes="3" />
    <doc>
      <brief>Redirect the hierarchy starting at "window" to off-screen storage.</brief>
      <description>
	The hierarchy starting at 'window' is directed to off-screen
	storage.  When all clients enabling redirection terminate,
	the redirection will automatically be disabled.

	The root window may not be redirected. Doing so results in a Match
	error.
      </description>
      <field name="window">The root of the hierarchy to redirect to off-screen storage.</field>
      <field name="update">
	Whether contents are automatically mirrored to the parent window.  If one client
	already specifies an update type of Manual, any attempt by another to specify a
	mode of Manual so will result in an Access error.
      </field>
    </doc>
  </request>

  <request name="RedirectSubwindows" opcode="2">
    <field type="WINDOW" name="window" />
    <field type="CARD8" name="update" enum="Redirect" />
    <pad bytes="3" />
    <doc>
      <brief>Redirect all current and future children of ‘window’</brief>
      <description>
	Hierarchies starting at all current and future children of window
	will be redirected as in RedirectWindow. If update is Manual,
	then painting of the window background during window manipulation
	and ClearArea requests is inhibited.
      </description>
      <field name="window">The root of the hierarchy to redirect to off-screen storage.</field>
      <field name="update">
	Whether contents are automatically mirrored to the parent window.  If one client
	already specifies an update type of Manual, any attempt by another to specify a
	mode of Manual so will result in an Access error.
      </field>
    </doc>
  </request>

  <request name="UnredirectWindow" opcode="3">
    <field type="WINDOW" name="window" />
    <field type="CARD8" name="update" enum="Redirect" />
    <pad bytes="3" />
    <doc>
      <brief>Terminate redirection of the specified window.</brief>
      <description>
	Redirection of the specified window will be terminated.  This cannot be
	used if the window was redirected with RedirectSubwindows.
      </description>
      <field name="window">
	The window to terminate redirection of.  Must be redirected by the
	current client, or a Value error results.
      </field>
      <field name="update">
	The update type passed to RedirectWindows.  If this does not match the
	previously requested update type, a Value error results.
      </field>
    </doc>
  </request>

  <request name="UnredirectSubwindows" opcode="4">
    <field type="WINDOW" name="window" />
    <field type="CARD8" name="update" enum="Redirect" />
    <pad bytes="3" />
    <doc>
      <brief>Terminate redirection of the specified window’s children</brief>
      <description>
	Redirection of all children of window will be terminated.
      </description>
      <field name="window">
	The window to terminate redirection of.  Must have previously been
	selected for sub-redirection by the current client, or a Value error
	results.
      </field>
      <field name="update">
	The update type passed to RedirectSubWindows.  If this does not match
	the previously requested update type, a Value error results.
      </field>
    </doc>
  </request>

  <request name="CreateRegionFromBorderClip" opcode="5">
    <field type="REGION" name="region" />
    <field type="WINDOW" name="window" />
  </request>

  <request name="NameWindowPixmap" opcode="6">
    <field type="WINDOW" name="window" />
    <field type="PIXMAP" name="pixmap" />
  </request>
  
  <!-- new in version 0.3 -->
  
  <request name="GetOverlayWindow" opcode="7">
    <field type="WINDOW" name="window" />
    <reply>
      <pad bytes="1" />
      <field type="WINDOW" name="overlay_win" />
      <pad bytes="20" />
    </reply>
  </request>

  <request name="ReleaseOverlayWindow" opcode="8">
    <field type="WINDOW" name="window" />
  </request>
</xcb>