{"diffoscope-json-version": 1, "source1": "/srv/reproducible-results/rbuild-debian/r-b-build.TGgUitIc/b1/pywayland_0.4.18-1_amd64.changes", "source2": "/srv/reproducible-results/rbuild-debian/r-b-build.TGgUitIc/b2/pywayland_0.4.18-1_amd64.changes", "unified_diff": null, "details": [{"source1": "Files", "source2": "Files", "unified_diff": "@@ -1,4 +1,4 @@\n \n 2eae7c678b9d2734648c45465ca534b3 47416 debug optional python3-pywayland-dbgsym_0.4.18-1_amd64.deb\n- a6b3ee4e3bc004c987b08cbf0f9776ad 51368 doc optional python3-pywayland-doc_0.4.18-1_all.deb\n- 35a0f8384ddebb3268c9c3cc334a9d66 120232 python optional python3-pywayland_0.4.18-1_amd64.deb\n+ 9fe901e9a499a39416410bbedbc6ba68 51624 doc optional python3-pywayland-doc_0.4.18-1_all.deb\n+ 7630e99045d069a6689f25fd92688b5e 120652 python optional python3-pywayland_0.4.18-1_amd64.deb\n"}, {"source1": "python3-pywayland-doc_0.4.18-1_all.deb", "source2": "python3-pywayland-doc_0.4.18-1_all.deb", "unified_diff": null, "details": [{"source1": "file list", "source2": "file list", "unified_diff": "@@ -1,3 +1,3 @@\n -rw-r--r-- 0 0 0 4 2024-10-11 20:38:19.000000 debian-binary\n -rw-r--r-- 0 0 0 1304 2024-10-11 20:38:19.000000 control.tar.xz\n--rw-r--r-- 0 0 0 49872 2024-10-11 20:38:19.000000 data.tar.xz\n+-rw-r--r-- 0 0 0 50128 2024-10-11 20:38:19.000000 data.tar.xz\n"}, {"source1": "control.tar.xz", "source2": "control.tar.xz", "unified_diff": null, "details": [{"source1": "control.tar", "source2": "control.tar", "unified_diff": null, "details": [{"source1": "./md5sums", "source2": "./md5sums", "unified_diff": null, "details": [{"source1": "./md5sums", "source2": "./md5sums", "comments": ["Files differ"], "unified_diff": null}]}]}]}, {"source1": "data.tar.xz", "source2": "data.tar.xz", "unified_diff": null, "details": [{"source1": "data.tar", "source2": "data.tar", "unified_diff": null, "details": [{"source1": "file list", "source2": "file list", "unified_diff": "@@ -12,15 +12,15 @@\n -rw-r--r-- 0 root (0) root (0) 1092 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/index.txt\n -rw-r--r-- 0 root (0) root (0) 1693 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/install.txt.gz\n drwxr-xr-x 0 root (0) root (0) 0 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/\n -rw-r--r-- 0 root (0) root (0) 2629 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/client.txt.gz\n -rw-r--r-- 0 root (0) root (0) 515 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/index.txt\n drwxr-xr-x 0 root (0) root (0) 0 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/protocol/\n -rw-r--r-- 0 root (0) root (0) 482 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/protocol/index.txt\n--rw-r--r-- 0 root (0) root (0) 29986 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/protocol/wayland.txt.gz\n+-rw-r--r-- 0 root (0) root (0) 30273 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/protocol/wayland.txt.gz\n -rw-r--r-- 0 root (0) root (0) 1839 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/protocol_core.txt.gz\n drwxr-xr-x 0 root (0) root (0) 0 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/scanner/\n -rw-r--r-- 0 root (0) root (0) 1018 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/scanner/argument.txt\n -rw-r--r-- 0 root (0) root (0) 405 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/scanner/entry.txt\n -rw-r--r-- 0 root (0) root (0) 358 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/scanner/enum.txt\n -rw-r--r-- 0 root (0) root (0) 688 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/scanner/event.txt\n -rw-r--r-- 0 root (0) root (0) 296 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/text/module/scanner/index.txt\n"}, {"source1": "./usr/share/doc/python3-pywayland/text/module/protocol/index.txt", "source2": "./usr/share/doc/python3-pywayland/text/module/protocol/index.txt", "comments": ["Ordering differences only"], "unified_diff": "@@ -2,50 +2,50 @@\n ****************\n \n Wayland protocols built against Wayland 1.21.0 and Wayland Protocols\n 1.25.\n \n * wayland Module\n \n- * WlCallback\n+ * WlDataDevice\n \n- * WlDataDeviceManager\n+ * WlTouch\n+\n+ * WlRegistry\n \n * WlSubcompositor\n \n+ * WlShm\n+\n * WlShmPool\n \n * WlSurface\n \n- * WlRegion\n+ * WlOutput\n \n- * WlDataSource\n+ * WlKeyboard\n+\n+ * WlCompositor\n+\n+ * WlSeat\n \n * WlDataOffer\n \n- * WlShellSurface\n+ * WlBuffer\n \n- * WlSubsurface\n+ * WlDataSource\n \n- * WlShm\n+ * WlCallback\n \n- * WlKeyboard\n+ * WlRegion\n \n- * WlTouch\n+ * WlDataDeviceManager\n \n- * WlDataDevice\n+ * WlShellSurface\n \n- * WlPointer\n+ * WlSubsurface\n \n- * WlCompositor\n+ * WlPointer\n \n * WlShell\n \n * WlDisplay\n-\n- * WlOutput\n-\n- * WlBuffer\n-\n- * WlSeat\n-\n- * WlRegistry\n"}, {"source1": "./usr/share/doc/python3-pywayland/text/module/protocol/wayland.txt.gz", "source2": "./usr/share/doc/python3-pywayland/text/module/protocol/wayland.txt.gz", "unified_diff": null, "details": [{"source1": "wayland.txt", "source2": "wayland.txt", "comments": ["Ordering differences only"], "unified_diff": "@@ -1,80 +1,506 @@\n wayland Module\n **************\n \n \n-WlCallback\n-==========\n+WlDataDevice\n+============\n \n-class pywayland.protocol.wayland.WlCallback\n+class pywayland.protocol.wayland.WlDataDevice\n \n- Callback object\n+ Data transfer device\n \n- Clients can handle the 'done' event to get notified when the\n- related request is done.\n+ There is one \"WlDataDevice\" per seat which can be obtained from the\n+ global \"WlDataDeviceManager\" singleton.\n \n- Note, because \"WlCallback\" objects are created from multiple\n- independent factory interfaces, the \"WlCallback\" interface is\n- frozen at version 1.\n+ A \"WlDataDevice\" provides access to inter-client data transfer\n+ mechanisms such as copy-and-paste and drag-and-drop.\n \n- done(callback_data: 'int') -> 'None'\n+ start_drag(source: 'WlDataSource | None', origin: 'WlSurface', icon: 'WlSurface | None', serial: 'int') -> 'None'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Start drag-and-drop operation\n+\n+ This request asks the compositor to start a drag-and-drop\n+ operation on behalf of the client.\n+\n+ The source argument is the data source that provides the data\n+ for the eventual data transfer. If source is NULL, enter, leave\n+ and motion events are sent only to the client that initiated the\n+ drag and the client is expected to handle the data passing\n+ internally. If source is destroyed, the drag-and-drop session\n+ will be cancelled.\n+\n+ The origin surface is the surface where the drag originates and\n+ the client must have an active implicit grab that matches the\n+ serial.\n+\n+ The icon surface is an optional (can be NULL) surface that\n+ provides an icon to be moved around with the cursor. Initially,\n+ the top-left corner of the icon surface is placed at the cursor\n+ hotspot, but subsequent \"WlSurface.offset()\" requests can move\n+ the relative position. Attach requests must be confirmed with\n+ \"WlSurface.commit()\" as usual. The icon surface is given the\n+ role of a drag-and-drop icon. If the icon surface already has\n+ another role, it raises a protocol error.\n+\n+ The input region is ignored for wl_surfaces with the role of a\n+ drag- and-drop icon.\n+\n+ The given source may not be used in any further set_selection or\n+ start_drag requests. Attempting to reuse a previously-used\n+ source may send a used_source error.\n+\n+ Parameters:\n+ * **source** (\"WlDataSource\" or *None*) -- data source for\n+ the eventual transfer\n+\n+ * **origin** (\"WlSurface\") -- surface where the drag\n+ originates\n+\n+ * **icon** (\"WlSurface\" or *None*) -- drag-and-drop icon\n+ surface\n+\n+ * **serial** (*ArgumentType.Uint*) -- serial number of the\n+ implicit grab on the origin\n+\n+ set_selection(source: 'WlDataSource | None', serial: 'int') -> 'None'\n+\n+ -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+\n+ Copy data to the selection\n+\n+ This request asks the compositor to set the selection to the\n+ data from the source on behalf of the client.\n+\n+ To unset the selection, set the source to NULL.\n+\n+ The given source may not be used in any further set_selection or\n+ start_drag requests. Attempting to reuse a previously-used\n+ source may send a used_source error.\n+\n+ Parameters:\n+ * **source** (\"WlDataSource\" or *None*) -- data source for\n+ the selection\n+\n+ * **serial** (*ArgumentType.Uint*) -- serial number of the\n+ event that triggered this request\n+\n+ release() -> 'None'\n+\n+ -[ Request -- opcode 2 (attached to \"Resource\" instance) ]-\n+\n+ Destroy data device\n+\n+ This request destroys the data device.\n+\n+ data_offer(id: 'WlDataOffer') -> 'None'\n \n -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n \n- Done event\n+ Introduce a new \"WlDataOffer\"\n \n- Notify the client when the related request is done.\n+ The data_offer event introduces a new \"WlDataOffer\" object,\n+ which will subsequently be used in either the data_device.enter\n+ event (for drag- and-drop) or the data_device.selection event\n+ (for selections). Immediately following the\n+ data_device.data_offer event, the new data_offer object will\n+ send out data_offer.offer events to describe the mime types it\n+ offers.\n \n Parameters:\n- **callback_data** (*ArgumentType.Uint*) -- request-specific\n- data for the callback\n+ **id** (\"WlDataOffer\") -- the new data_offer object\n \n+ enter(serial: 'int', surface: 'WlSurface', x: 'float', y: 'float', id: 'WlDataOffer | None') -> 'None'\n \n-WlDataDeviceManager\n-===================\n+ -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n \n-class pywayland.protocol.wayland.WlDataDeviceManager\n+ Initiate drag-and-drop session\n \n- Data transfer interface\n+ This event is sent when an active drag-and-drop pointer enters a\n+ surface owned by the client. The position of the pointer at\n+ enter time is provided by the x and y arguments, in surface-\n+ local coordinates.\n \n- The \"WlDataDeviceManager\" is a singleton global object that\n- provides access to inter-client data transfer mechanisms such as\n- copy-and-paste and drag-and-drop. These mechanisms are tied to a\n- \"WlSeat\" and this interface lets a client get a \"WlDataDevice\"\n- corresponding to a \"WlSeat\".\n+ Parameters:\n+ * **serial** (*ArgumentType.Uint*) -- serial number of the\n+ enter event\n \n- Depending on the version bound, the objects created from the bound\n- \"WlDataDeviceManager\" object will have different requirements for\n- functioning properly. See \"WlDataSource.set_actions()\",\n- \"WlDataOffer.accept()\" and \"WlDataOffer.finish()\" for details.\n+ * **surface** (\"WlSurface\") -- client surface entered\n \n- create_data_source() -> 'Proxy[WlDataSource]'\n+ * **x** (*ArgumentType.Fixed*) -- surface-local x coordinate\n+\n+ * **y** (*ArgumentType.Fixed*) -- surface-local y coordinate\n+\n+ * **id** (\"WlDataOffer\" or *None*) -- source data_offer\n+ object\n+\n+ leave() -> 'None'\n+\n+ -[ Event -- opcode 2 (attached to \"Proxy\" instance) ]-\n+\n+ End drag-and-drop session\n+\n+ This event is sent when the drag-and-drop pointer leaves the\n+ surface and the session ends. The client must destroy the\n+ \"WlDataOffer\" introduced at enter time at this point.\n+\n+ motion(time: 'int', x: 'float', y: 'float') -> 'None'\n+\n+ -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n+\n+ Drag-and-drop session motion\n+\n+ This event is sent when the drag-and-drop pointer moves within\n+ the currently focused surface. The new position of the pointer\n+ is provided by the x and y arguments, in surface-local\n+ coordinates.\n+\n+ Parameters:\n+ * **time** (*ArgumentType.Uint*) -- timestamp with\n+ millisecond granularity\n+\n+ * **x** (*ArgumentType.Fixed*) -- surface-local x coordinate\n+\n+ * **y** (*ArgumentType.Fixed*) -- surface-local y coordinate\n+\n+ drop() -> 'None'\n+\n+ -[ Event -- opcode 4 (attached to \"Proxy\" instance) ]-\n+\n+ End drag-and-drop session successfully\n+\n+ The event is sent when a drag-and-drop operation is ended\n+ because the implicit grab is removed.\n+\n+ The drag-and-drop destination is expected to honor the last\n+ action received through \"WlDataOffer.action()\", if the resulting\n+ action is \"copy\" or \"move\", the destination can still perform\n+ \"WlDataOffer.receive()\" requests, and is expected to end all\n+ transfers with a \"WlDataOffer.finish()\" request.\n+\n+ If the resulting action is \"ask\", the action will not be\n+ considered final. The drag-and-drop destination is expected to\n+ perform one last \"WlDataOffer.set_actions()\" request, or\n+ \"WlDataOffer.destroy()\" in order to cancel the operation.\n+\n+ selection(id: 'WlDataOffer | None') -> 'None'\n+\n+ -[ Event -- opcode 5 (attached to \"Proxy\" instance) ]-\n+\n+ Advertise new selection\n+\n+ The selection event is sent out to notify the client of a new\n+ \"WlDataOffer\" for the selection for this device. The\n+ data_device.data_offer and the data_offer.offer events are sent\n+ out immediately before this event to introduce the data offer\n+ object. The selection event is sent to a client immediately\n+ before receiving keyboard focus and when a new selection is set\n+ while the client has keyboard focus. The data_offer is valid\n+ until a new data_offer or NULL is received or until the client\n+ loses keyboard focus. Switching surface with keyboard focus\n+ within the same client doesn't mean a new selection will be\n+ sent. The client must destroy the previous selection\n+ data_offer, if any, upon receiving this event.\n+\n+ Parameters:\n+ **id** (\"WlDataOffer\" or *None*) -- selection data_offer\n+ object\n+\n+\n+WlTouch\n+=======\n+\n+class pywayland.protocol.wayland.WlTouch\n+\n+ Touchscreen input device\n+\n+ The \"WlTouch\" interface represents a touchscreen associated with a\n+ seat.\n+\n+ Touch interactions can consist of one or more contacts. For each\n+ contact, a series of events is generated, starting with a down\n+ event, followed by zero or more motion events, and ending with an\n+ up event. Events relating to the same contact point can be\n+ identified by the ID of the sequence.\n+\n+ release() -> 'None'\n \n -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n \n- Create a new data source\n+ Release the touch object\n \n- Create a new data source.\n+ down(serial: 'int', time: 'int', surface: 'WlSurface', id: 'int', x: 'float', y: 'float') -> 'None'\n \n- Returns:\n- \"WlDataSource\" -- data source to create\n+ -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n \n- get_data_device(seat: 'WlSeat') -> 'Proxy[WlDataDevice]'\n+ Touch down event and beginning of a touch sequence\n \n- -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+ A new touch point has appeared on the surface. This touch point\n+ is assigned a unique ID. Future events from this touch point\n+ reference this ID. The ID ceases to be valid after a touch up\n+ event and may be reused in the future.\n \n- Create a new data device\n+ Parameters:\n+ * **serial** (*ArgumentType.Uint*) -- serial number of the\n+ touch down event\n \n- Create a new data device for a given seat.\n+ * **time** (*ArgumentType.Uint*) -- timestamp with\n+ millisecond granularity\n+\n+ * **surface** (\"WlSurface\") -- surface touched\n+\n+ * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n+ point\n+\n+ * **x** (*ArgumentType.Fixed*) -- surface-local x coordinate\n+\n+ * **y** (*ArgumentType.Fixed*) -- surface-local y coordinate\n+\n+ up(serial: 'int', time: 'int', id: 'int') -> 'None'\n+\n+ -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n+\n+ End of a touch event sequence\n+\n+ The touch point has disappeared. No further events will be sent\n+ for this touch point and the touch point's ID is released and\n+ may be reused in a future touch down event.\n \n Parameters:\n- **seat** (\"WlSeat\") -- seat associated with the data device\n+ * **serial** (*ArgumentType.Uint*) -- serial number of the\n+ touch up event\n+\n+ * **time** (*ArgumentType.Uint*) -- timestamp with\n+ millisecond granularity\n+\n+ * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n+ point\n+\n+ motion(time: 'int', id: 'int', x: 'float', y: 'float') -> 'None'\n+\n+ -[ Event -- opcode 2 (attached to \"Proxy\" instance) ]-\n+\n+ Update of touch point coordinates\n+\n+ A touch point has changed coordinates.\n+\n+ Parameters:\n+ * **time** (*ArgumentType.Uint*) -- timestamp with\n+ millisecond granularity\n+\n+ * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n+ point\n+\n+ * **x** (*ArgumentType.Fixed*) -- surface-local x coordinate\n+\n+ * **y** (*ArgumentType.Fixed*) -- surface-local y coordinate\n+\n+ frame() -> 'None'\n+\n+ -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n+\n+ End of touch frame event\n+\n+ Indicates the end of a set of events that logically belong\n+ together. A client is expected to accumulate the data in all\n+ events within the frame before proceeding.\n+\n+ A \"WlTouch.frame()\" terminates at least one event but otherwise\n+ no guarantee is provided about the set of events within a frame.\n+ A client must assume that any state not updated in a frame is\n+ unchanged from the previously known state.\n+\n+ cancel() -> 'None'\n+\n+ -[ Event -- opcode 4 (attached to \"Proxy\" instance) ]-\n+\n+ Touch session cancelled\n+\n+ Sent if the compositor decides the touch stream is a global\n+ gesture. No further events are sent to the clients from that\n+ particular gesture. Touch cancellation applies to all touch\n+ points currently active on this client's surface. The client is\n+ responsible for finalizing the touch points, future touch points\n+ on this surface may reuse the touch point ID.\n+\n+ No frame event is required after the cancel event.\n+\n+ shape(id: 'int', major: 'float', minor: 'float') -> 'None'\n+\n+ -[ Event -- opcode 5 (attached to \"Proxy\" instance) ]-\n+\n+ Update shape of touch point\n+\n+ Sent when a touchpoint has changed its shape.\n+\n+ This event does not occur on its own. It is sent before a\n+ \"WlTouch.frame()\" event and carries the new shape information\n+ for any previously reported, or new touch points of that frame.\n+\n+ Other events describing the touch point such as\n+ \"WlTouch.down()\", \"WlTouch.motion()\" or \"WlTouch.orientation()\"\n+ may be sent within the same \"WlTouch.frame()\". A client should\n+ treat these events as a single logical touch point update. The\n+ order of \"WlTouch.shape()\", \"WlTouch.orientation()\" and\n+ \"WlTouch.motion()\" is not guaranteed. A \"WlTouch.down()\" event\n+ is guaranteed to occur before the first \"WlTouch.shape()\" event\n+ for this touch ID but both events may occur within the same\n+ \"WlTouch.frame()\".\n+\n+ A touchpoint shape is approximated by an ellipse through the\n+ major and minor axis length. The major axis length describes the\n+ longer diameter of the ellipse, while the minor axis length\n+ describes the shorter diameter. Major and minor are orthogonal\n+ and both are specified in surface-local coordinates. The center\n+ of the ellipse is always at the touchpoint location as reported\n+ by \"WlTouch.down()\" or \"WlTouch.move()\".\n+\n+ This event is only sent by the compositor if the touch device\n+ supports shape reports. The client has to make reasonable\n+ assumptions about the shape if it did not receive this event.\n+\n+ Parameters:\n+ * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n+ point\n+\n+ * **major** (*ArgumentType.Fixed*) -- length of the major\n+ axis in surface-local coordinates\n+\n+ * **minor** (*ArgumentType.Fixed*) -- length of the minor\n+ axis in surface-local coordinates\n+\n+ orientation(id: 'int', orientation: 'float') -> 'None'\n+\n+ -[ Event -- opcode 6 (attached to \"Proxy\" instance) ]-\n+\n+ Update orientation of touch point\n+\n+ Sent when a touchpoint has changed its orientation.\n+\n+ This event does not occur on its own. It is sent before a\n+ \"WlTouch.frame()\" event and carries the new shape information\n+ for any previously reported, or new touch points of that frame.\n+\n+ Other events describing the touch point such as\n+ \"WlTouch.down()\", \"WlTouch.motion()\" or \"WlTouch.shape()\" may be\n+ sent within the same \"WlTouch.frame()\". A client should treat\n+ these events as a single logical touch point update. The order\n+ of \"WlTouch.shape()\", \"WlTouch.orientation()\" and\n+ \"WlTouch.motion()\" is not guaranteed. A \"WlTouch.down()\" event\n+ is guaranteed to occur before the first \"WlTouch.orientation()\"\n+ event for this touch ID but both events may occur within the\n+ same \"WlTouch.frame()\".\n+\n+ The orientation describes the clockwise angle of a touchpoint's\n+ major axis to the positive surface y-axis and is normalized to\n+ the -180 to +180 degree range. The granularity of orientation\n+ depends on the touch device, some devices only support binary\n+ rotation values between 0 and 90 degrees.\n+\n+ This event is only sent by the compositor if the touch device\n+ supports orientation reports.\n+\n+ Parameters:\n+ * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n+ point\n+\n+ * **orientation** (*ArgumentType.Fixed*) -- angle between\n+ major axis and positive surface y-axis in degrees\n+\n+\n+WlRegistry\n+==========\n+\n+class pywayland.protocol.wayland.WlRegistry\n+\n+ Global registry object\n+\n+ The singleton global registry object. The server has a number of\n+ global objects that are available to all clients. These objects\n+ typically represent an actual object in the server (for example, an\n+ input device) or they are singleton objects that provide extension\n+ functionality.\n+\n+ When a client creates a registry object, the registry object will\n+ emit a global event for each global currently in the registry.\n+ Globals come and go as a result of device or monitor hotplugs,\n+ reconfiguration or other events, and the registry will send out\n+ global and global_remove events to keep the client up to date with\n+ the changes. To mark the end of the initial burst of events, the\n+ client can use the \"WlDisplay.sync()\" request immediately after\n+ calling \"WlDisplay.get_registry()\".\n+\n+ A client can bind to a global object by using the bind request.\n+ This creates a client-side handle that lets the object emit events\n+ to the client and lets the client invoke requests on the object.\n+\n+ bind(name: 'int', interface: 'type[T]', version: 'int') -> 'Proxy[T]'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Bind an object to the display\n+\n+ Binds a new, client-created object to the server using the\n+ specified name as the identifier.\n+\n+ Parameters:\n+ * **name** (*ArgumentType.Uint*) -- unique numeric name of\n+ the object\n+\n+ * **interface** (*string*) -- Interface name\n+\n+ * **version** (*int*) -- Interface version\n \n Returns:\n- \"WlDataDevice\" -- data device to create\n+ \"pywayland.client.proxy.Proxy\" of specified Interface --\n+ bounded object\n+\n+ global_(name: 'int', interface: 'str', version: 'int') -> 'None'\n+\n+ -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n+\n+ Announce global object\n+\n+ Notify the client of global objects.\n+\n+ The event notifies the client that a global object with the\n+ given name is now available, and it implements the given version\n+ of the given interface.\n+\n+ Parameters:\n+ * **name** (*ArgumentType.Uint*) -- numeric name of the\n+ global object\n+\n+ * **interface** (*ArgumentType.String*) -- interface\n+ implemented by the object\n+\n+ * **version** (*ArgumentType.Uint*) -- interface version\n+\n+ global_remove(name: 'int') -> 'None'\n+\n+ -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n+\n+ Announce removal of global object\n+\n+ Notify the client of removed global objects.\n+\n+ This event notifies the client that the global identified by\n+ name is no longer available. If the client bound to the global\n+ using the bind request, the client should now destroy that\n+ object.\n+\n+ The object remains valid and requests to the object will be\n+ ignored until the client destroys it, to avoid races between the\n+ global going away and a client sending a request to it.\n+\n+ Parameters:\n+ **name** (*ArgumentType.Uint*) -- numeric name of the global\n+ object\n \n \n WlSubcompositor\n ===============\n \n class pywayland.protocol.wayland.WlSubcompositor\n \n@@ -143,14 +569,75 @@\n \n * **parent** (\"WlSurface\") -- the parent surface\n \n Returns:\n \"WlSubsurface\" -- the new sub- surface object ID\n \n \n+WlShm\n+=====\n+\n+class pywayland.protocol.wayland.WlShm\n+\n+ Shared memory support\n+\n+ A singleton global object that provides support for shared memory.\n+\n+ Clients can create \"WlShmPool\" objects using the create_pool\n+ request.\n+\n+ On binding the \"WlShm\" object one or more format events are emitted\n+ to inform clients about the valid pixel formats that can be used\n+ for buffers.\n+\n+ create_pool(fd: 'int', size: 'int') -> 'Proxy[WlShmPool]'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Create a shm pool\n+\n+ Create a new \"WlShmPool\" object.\n+\n+ The pool can be used to create shared memory based buffer\n+ objects. The server will mmap size bytes of the passed file\n+ descriptor, to use as backing memory for the pool.\n+\n+ Parameters:\n+ * **fd** (*ArgumentType.FileDescriptor*) -- file descriptor\n+ for the pool\n+\n+ * **size** (*ArgumentType.Int*) -- pool size, in bytes\n+\n+ Returns:\n+ \"WlShmPool\" -- pool to create\n+\n+ release() -> 'None'\n+\n+ -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+\n+ Release the shm object\n+\n+ Using this request a client can tell the server that it is not\n+ going to use the shm object anymore.\n+\n+ Objects created via this interface remain unaffected.\n+\n+ format(format: 'int') -> 'None'\n+\n+ -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n+\n+ Pixel format description\n+\n+ Informs the client about a valid pixel format that can be used\n+ for buffers. Known formats include argb8888 and xrgb8888.\n+\n+ Parameters:\n+ **format** (*ArgumentType.Uint*) -- buffer pixel format\n+\n+\n WlShmPool\n =========\n \n class pywayland.protocol.wayland.WlShmPool\n \n A shared memory pool\n \n@@ -789,259 +1276,623 @@\n using \"WlSurface.set_buffer_transform()\" might allow the\n compositor to use the surface buffer more efficiently.\n \n Parameters:\n **transform** (*ArgumentType.Uint*) -- preferred transform\n \n \n-WlRegion\n+WlOutput\n ========\n \n-class pywayland.protocol.wayland.WlRegion\n-\n- Region interface\n+class pywayland.protocol.wayland.WlOutput\n \n- A region object describes an area.\n+ Compositor output region\n \n- Region objects are used to describe the opaque and input regions of\n- a surface.\n+ An output describes part of the compositor geometry. The\n+ compositor works in the 'compositor coordinate system' and an\n+ output corresponds to a rectangular area in that space that is\n+ actually visible. This typically corresponds to a monitor that\n+ displays part of the compositor space. This object is published as\n+ global during start up, or when a monitor is hotplugged.\n \n- destroy() -> 'None'\n+ release() -> 'None'\n \n -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n \n- Destroy region\n+ Release the output object\n \n- Destroy the region. This will invalidate the object ID.\n+ Using this request a client can tell the server that it is not\n+ going to use the output object anymore.\n \n- add(x: 'int', y: 'int', width: 'int', height: 'int') -> 'None'\n+ geometry(x: 'int', y: 'int', physical_width: 'int', physical_height: 'int', subpixel: 'int', make: 'str', model: 'str', transform: 'int') -> 'None'\n \n- -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+ -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n \n- Add rectangle to region\n+ Properties of the output\n \n- Add the specified rectangle to the region.\n+ The geometry event describes geometric properties of the output.\n+ The event is sent when binding to the output object and whenever\n+ any of the properties change.\n+\n+ The physical size can be set to zero if it doesn't make sense\n+ for this output (e.g. for projectors or virtual outputs).\n+\n+ The geometry event will be followed by a done event (starting\n+ from version 2).\n+\n+ Clients should use \"WlSurface.preferred_buffer_transform()\"\n+ instead of the transform advertised by this event to find the\n+ preferred buffer transform to use for a surface.\n+\n+ Note: \"WlOutput\" only advertises partial information about the\n+ output position and identification. Some compositors, for\n+ instance those not implementing a desktop-style output layout or\n+ those exposing virtual outputs, might fake this information.\n+ Instead of using x and y, clients should use\n+ xdg_output.logical_position. Instead of using make and model,\n+ clients should use name and description.\n \n Parameters:\n- * **x** (*ArgumentType.Int*) -- region-local x coordinate\n+ * **x** (*ArgumentType.Int*) -- x position within the global\n+ compositor space\n \n- * **y** (*ArgumentType.Int*) -- region-local y coordinate\n+ * **y** (*ArgumentType.Int*) -- y position within the global\n+ compositor space\n \n- * **width** (*ArgumentType.Int*) -- rectangle width\n+ * **physical_width** (*ArgumentType.Int*) -- width in\n+ millimeters of the output\n \n- * **height** (*ArgumentType.Int*) -- rectangle height\n+ * **physical_height** (*ArgumentType.Int*) -- height in\n+ millimeters of the output\n \n- subtract(x: 'int', y: 'int', width: 'int', height: 'int') -> 'None'\n+ * **subpixel** (*ArgumentType.Int*) -- subpixel orientation\n+ of the output\n \n- -[ Request -- opcode 2 (attached to \"Resource\" instance) ]-\n+ * **make** (*ArgumentType.String*) -- textual description of\n+ the manufacturer\n \n- Subtract rectangle from region\n+ * **model** (*ArgumentType.String*) -- textual description of\n+ the model\n \n- Subtract the specified rectangle from the region.\n+ * **transform** (*ArgumentType.Int*) -- additional\n+ transformation applied to buffer contents during\n+ presentation\n+\n+ mode(flags: 'int', width: 'int', height: 'int', refresh: 'int') -> 'None'\n+\n+ -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n+\n+ Advertise available modes for the output\n+\n+ The mode event describes an available mode for the output.\n+\n+ The event is sent when binding to the output object and there\n+ will always be one mode, the current mode. The event is sent\n+ again if an output changes mode, for the mode that is now\n+ current. In other words, the current mode is always the last\n+ mode that was received with the current flag set.\n+\n+ Non-current modes are deprecated. A compositor can decide to\n+ only advertise the current mode and never send other modes.\n+ Clients should not rely on non-current modes.\n+\n+ The size of a mode is given in physical hardware units of the\n+ output device. This is not necessarily the same as the output\n+ size in the global compositor space. For instance, the output\n+ may be scaled, as described in \"WlOutput.scale()\", or\n+ transformed, as described in \"WlOutput.transform()\". Clients\n+ willing to retrieve the output size in the global compositor\n+ space should use xdg_output.logical_size instead.\n+\n+ The vertical refresh rate can be set to zero if it doesn't make\n+ sense for this output (e.g. for virtual outputs).\n+\n+ The mode event will be followed by a done event (starting from\n+ version 2).\n+\n+ Clients should not use the refresh rate to schedule frames.\n+ Instead, they should use the \"WlSurface.frame()\" event or the\n+ presentation-time protocol.\n+\n+ Note: this information is not always meaningful for all outputs.\n+ Some compositors, such as those exposing virtual outputs, might\n+ fake the refresh rate or the size.\n \n Parameters:\n- * **x** (*ArgumentType.Int*) -- region-local x coordinate\n+ * **flags** (*ArgumentType.Uint*) -- bitfield of mode flags\n \n- * **y** (*ArgumentType.Int*) -- region-local y coordinate\n+ * **width** (*ArgumentType.Int*) -- width of the mode in\n+ hardware units\n \n- * **width** (*ArgumentType.Int*) -- rectangle width\n+ * **height** (*ArgumentType.Int*) -- height of the mode in\n+ hardware units\n \n- * **height** (*ArgumentType.Int*) -- rectangle height\n+ * **refresh** (*ArgumentType.Int*) -- vertical refresh rate\n+ in mHz\n \n+ done() -> 'None'\n \n-WlDataSource\n-============\n+ -[ Event -- opcode 2 (attached to \"Proxy\" instance) ]-\n \n-class pywayland.protocol.wayland.WlDataSource\n+ Sent all information about output\n \n- Offer to transfer data\n+ This event is sent after all other properties have been sent\n+ after binding to the output object and after any other property\n+ changes done after that. This allows changes to the output\n+ properties to be seen as atomic, even if they happen via\n+ multiple events.\n \n- The \"WlDataSource\" object is the source side of a \"WlDataOffer\". It\n- is created by the source client in a data transfer and provides a\n- way to describe the offered data and a way to respond to requests\n- to transfer the data.\n+ scale(factor: 'int') -> 'None'\n \n- offer(mime_type: 'str') -> 'None'\n+ -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n \n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+ Output scaling properties\n \n- Add an offered mime type\n+ This event contains scaling geometry information that is not in\n+ the geometry event. It may be sent after binding the output\n+ object or if the output scale changes later. The compositor will\n+ emit a non-zero, positive value for scale. If it is not sent,\n+ the client should assume a scale of 1.\n \n- This request adds a mime type to the set of mime types\n- advertised to targets. Can be called several times to offer\n- multiple types.\n+ A scale larger than 1 means that the compositor will\n+ automatically scale surface buffers by this amount when\n+ rendering. This is used for very high resolution displays where\n+ applications rendering at the native resolution would be too\n+ small to be legible.\n+\n+ Clients should use \"WlSurface.preferred_buffer_scale()\" instead\n+ of this event to find the preferred buffer scale to use for a\n+ surface.\n+\n+ The scale event will be followed by a done event.\n \n Parameters:\n- **mime_type** (*ArgumentType.String*) -- mime type offered by\n- the data source\n+ **factor** (*ArgumentType.Int*) -- scaling factor of output\n \n- destroy() -> 'None'\n+ name(name: 'str') -> 'None'\n \n- -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+ -[ Event -- opcode 4 (attached to \"Proxy\" instance) ]-\n \n- Destroy the data source\n+ Name of this output\n \n- Destroy the data source.\n+ Many compositors will assign user-friendly names to their\n+ outputs, show them to the user, allow the user to refer to an\n+ output, etc. The client may wish to know this name as well to\n+ offer the user similar behaviors.\n \n- set_actions(dnd_actions: 'int') -> 'None'\n+ The name is a UTF-8 string with no convention defined for its\n+ contents. Each name is unique among all \"WlOutput\" globals. The\n+ name is only guaranteed to be unique for the compositor\n+ instance.\n \n- -[ Request -- opcode 2 (attached to \"Resource\" instance) ]-\n+ The same output name is used for all clients for a given\n+ \"WlOutput\" global. Thus, the name can be shared across processes\n+ to refer to a specific \"WlOutput\" global.\n \n- Set the available drag-and-drop actions\n+ The name is not guaranteed to be persistent across sessions,\n+ thus cannot be used to reliably identify an output in e.g.\n+ configuration files.\n \n- Sets the actions that the source side client supports for this\n- operation. This request may trigger \"WlDataSource.action()\" and\n- \"WlDataOffer.action()\" events if the compositor needs to change\n- the selected action.\n+ Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc.\n+ However, do not assume that the name is a reflection of an\n+ underlying DRM connector, X11 connection, etc.\n \n- The dnd_actions argument must contain only values expressed in\n- the \"WlDataDeviceManager.dnd_actions()\" enum, otherwise it will\n- result in a protocol error.\n+ The name event is sent after binding the output object. This\n+ event is only sent once per output object, and the name does not\n+ change over the lifetime of the \"WlOutput\" global.\n \n- This request must be made once only, and can only be made on\n- sources used in drag-and-drop, so it must be performed before\n- \"WlDataDevice.start_drag()\". Attempting to use the source other\n- than for drag-and-drop will raise a protocol error.\n+ Compositors may re-use the same output name if the \"WlOutput\"\n+ global is destroyed and re-created later. Compositors should\n+ avoid re- using the same name if possible.\n+\n+ The name event will be followed by a done event.\n \n Parameters:\n- **dnd_actions** (*ArgumentType.Uint*) -- actions supported by\n- the data source\n+ **name** (*ArgumentType.String*) -- output name\n \n- target(mime_type: 'str | None') -> 'None'\n+ description(description: 'str') -> 'None'\n+\n+ -[ Event -- opcode 5 (attached to \"Proxy\" instance) ]-\n+\n+ Human-readable description of this output\n+\n+ Many compositors can produce human-readable descriptions of\n+ their outputs. The client may wish to know this description as\n+ well, e.g. for output selection purposes.\n+\n+ The description is a UTF-8 string with no convention defined for\n+ its contents. The description is not guaranteed to be unique\n+ among all \"WlOutput\" globals. Examples might include 'Foocorp\n+ 11\" Display' or 'Virtual X11 output via :1'.\n+\n+ The description event is sent after binding the output object\n+ and whenever the description changes. The description is\n+ optional, and may not be sent at all.\n+\n+ The description event will be followed by a done event.\n+\n+ Parameters:\n+ **description** (*ArgumentType.String*) -- output description\n+\n+\n+WlKeyboard\n+==========\n+\n+class pywayland.protocol.wayland.WlKeyboard\n+\n+ Keyboard input device\n+\n+ The \"WlKeyboard\" interface represents one or more keyboards\n+ associated with a seat.\n+\n+ Each \"WlKeyboard\" has the following logical state:\n+\n+ * an active surface (possibly null),\n+\n+ * the keys currently logically down,\n+\n+ * the active modifiers,\n+\n+ * the active group.\n+\n+ By default, the active surface is null, the keys currently\n+ logically down are empty, the active modifiers and the active group\n+ are 0.\n+\n+ release() -> 'None'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Release the keyboard object\n+\n+ keymap(format: 'int', fd: 'int', size: 'int') -> 'None'\n \n -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n \n- A target accepts an offered mime type\n+ Keyboard mapping\n \n- Sent when a target accepts pointer_focus or motion events. If a\n- target does not accept any of the offered types, type is NULL.\n+ This event provides a file descriptor to the client which can be\n+ memory-mapped in read-only mode to provide a keyboard mapping\n+ description.\n \n- Used for feedback during drag-and-drop.\n+ From version 7 onwards, the fd must be mapped with MAP_PRIVATE\n+ by the recipient, as MAP_SHARED may fail.\n \n Parameters:\n- **mime_type** (*ArgumentType.String* or *None*) -- mime type\n- accepted by the target\n+ * **format** (*ArgumentType.Uint*) -- keymap format\n \n- send(mime_type: 'str', fd: 'int') -> 'None'\n+ * **fd** (*ArgumentType.FileDescriptor*) -- keymap file\n+ descriptor\n+\n+ * **size** (*ArgumentType.Uint*) -- keymap size, in bytes\n+\n+ enter(serial: 'int', surface: 'WlSurface', keys: 'list') -> 'None'\n \n -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n \n- Send the data\n+ Enter event\n \n- Request for data from the client. Send the data as the\n- specified mime type over the passed file descriptor, then close\n- it.\n+ Notification that this seat's keyboard focus is on a certain\n+ surface.\n+\n+ The compositor must send the \"WlKeyboard.modifiers()\" event\n+ after this event.\n+\n+ In the \"WlKeyboard\" logical state, this event sets the active\n+ surface to the surface argument and the keys currently logically\n+ down to the keys in the keys argument. The compositor must not\n+ send this event if the \"WlKeyboard\" already had an active\n+ surface immediately before this event.\n \n Parameters:\n- * **mime_type** (*ArgumentType.String*) -- mime type for the\n- data\n+ * **serial** (*ArgumentType.Uint*) -- serial number of the\n+ enter event\n \n- * **fd** (*ArgumentType.FileDescriptor*) -- file descriptor\n- for the data\n+ * **surface** (\"WlSurface\") -- surface gaining keyboard focus\n \n- cancelled() -> 'None'\n+ * **keys** (*ArgumentType.Array*) -- the keys currently\n+ logically down\n+\n+ leave(serial: 'int', surface: 'WlSurface') -> 'None'\n \n -[ Event -- opcode 2 (attached to \"Proxy\" instance) ]-\n \n- Selection was cancelled\n+ Leave event\n \n- This data source is no longer valid. There are several reasons\n- why this could happen:\n+ Notification that this seat's keyboard focus is no longer on a\n+ certain surface.\n \n- * The data source has been replaced by another data source.\n+ The leave notification is sent before the enter notification for\n+ the new focus.\n \n- * The drag-and-drop operation was performed, but the drop\n- destination did not accept any of the mime types offered\n- through \"WlDataSource.target()\".\n+ In the \"WlKeyboard\" logical state, this event resets all values\n+ to their defaults. The compositor must not send this event if\n+ the active surface of the \"WlKeyboard\" was not equal to the\n+ surface argument immediately before this event.\n \n- * The drag-and-drop operation was performed, but the drop\n- destination did not select any of the actions present in the\n- mask offered through \"WlDataSource.action()\".\n+ Parameters:\n+ * **serial** (*ArgumentType.Uint*) -- serial number of the\n+ leave event\n \n- * The drag-and-drop operation was performed but didn't happen\n- over a surface.\n+ * **surface** (\"WlSurface\") -- surface that lost keyboard\n+ focus\n \n- * The compositor cancelled the drag-and-drop operation (e.g.\n- compositor dependent timeouts to avoid stale drag-and-drop\n- transfers).\n+ key(serial: 'int', time: 'int', key: 'int', state: 'int') -> 'None'\n \n- The client should clean up and destroy this data source.\n+ -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n \n- For objects of version 2 or older, \"WlDataSource.cancelled()\"\n- will only be emitted if the data source was replaced by another\n- data source.\n+ Key event\n \n- dnd_drop_performed() -> 'None'\n+ A key was pressed or released. The time argument is a timestamp\n+ with millisecond granularity, with an undefined base.\n \n- -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n+ The key is a platform-specific key code that can be interpreted\n+ by feeding it to the keyboard mapping (see the keymap event).\n \n- The drag-and-drop operation physically finished\n+ If this event produces a change in modifiers, then the resulting\n+ \"WlKeyboard.modifiers()\" event must be sent after this event.\n \n- The user performed the drop action. This event does not indicate\n- acceptance, \"WlDataSource.cancelled()\" may still be emitted\n- afterwards if the drop destination does not accept any mime\n- type.\n+ In the \"WlKeyboard\" logical state, this event adds the key to\n+ the keys currently logically down (if the state argument is\n+ pressed) or removes the key from the keys currently logically\n+ down (if the state argument is released). The compositor must\n+ not send this event if the \"WlKeyboard\" did not have an active\n+ surface immediately before this event. The compositor must not\n+ send this event if state is pressed (resp. released) and the key\n+ was already logically down (resp. was not logically down)\n+ immediately before this event.\n \n- However, this event might however not be received if the\n- compositor cancelled the drag-and-drop operation before this\n- event could happen.\n+ Parameters:\n+ * **serial** (*ArgumentType.Uint*) -- serial number of the\n+ key event\n \n- Note that the data_source may still be used in the future and\n- should not be destroyed here.\n+ * **time** (*ArgumentType.Uint*) -- timestamp with\n+ millisecond granularity\n \n- dnd_finished() -> 'None'\n+ * **key** (*ArgumentType.Uint*) -- key that produced the\n+ event\n+\n+ * **state** (*ArgumentType.Uint*) -- physical state of the\n+ key\n+\n+ modifiers(serial: 'int', mods_depressed: 'int', mods_latched: 'int', mods_locked: 'int', group: 'int') -> 'None'\n \n -[ Event -- opcode 4 (attached to \"Proxy\" instance) ]-\n \n- The drag-and-drop operation concluded\n+ Modifier and group state\n \n- The drop destination finished interoperating with this data\n- source, so the client is now free to destroy this data source\n- and free all associated data.\n+ Notifies clients that the modifier and/or group state has\n+ changed, and it should update its local state.\n \n- If the action used to perform the operation was \"move\", the\n- source can now delete the transferred data.\n+ The compositor may send this event without a surface of the\n+ client having keyboard focus, for example to tie modifier\n+ information to pointer focus instead. If a modifier event with\n+ pressed modifiers is sent without a prior enter event, the\n+ client can assume the modifier state is valid until it receives\n+ the next \"WlKeyboard.modifiers()\" event. In order to reset the\n+ modifier state again, the compositor can send a\n+ \"WlKeyboard.modifiers()\" event with no pressed modifiers.\n \n- action(dnd_action: 'int') -> 'None'\n+ In the \"WlKeyboard\" logical state, this event updates the\n+ modifiers and group.\n+\n+ Parameters:\n+ * **serial** (*ArgumentType.Uint*) -- serial number of the\n+ modifiers event\n+\n+ * **mods_depressed** (*ArgumentType.Uint*) -- depressed\n+ modifiers\n+\n+ * **mods_latched** (*ArgumentType.Uint*) -- latched modifiers\n+\n+ * **mods_locked** (*ArgumentType.Uint*) -- locked modifiers\n+\n+ * **group** (*ArgumentType.Uint*) -- keyboard layout\n+\n+ repeat_info(rate: 'int', delay: 'int') -> 'None'\n \n -[ Event -- opcode 5 (attached to \"Proxy\" instance) ]-\n \n- Notify the selected action\n+ Repeat rate and delay\n \n- This event indicates the action selected by the compositor after\n- matching the source/destination side actions. Only one action\n- (or none) will be offered here.\n+ Informs the client about the keyboard's repeat rate and delay.\n \n- This event can be emitted multiple times during the drag-and-\n- drop operation, mainly in response to destination side changes\n- through \"WlDataOffer.set_actions()\", and as the data device\n- enters/leaves surfaces.\n+ This event is sent as soon as the \"WlKeyboard\" object has been\n+ created, and is guaranteed to be received by the client before\n+ any key press event.\n \n- It is only possible to receive this event after\n- \"WlDataSource.dnd_drop_performed()\" if the drag-and-drop\n- operation ended in an \"ask\" action, in which case the final\n- \"WlDataSource.action()\" event will happen immediately before\n- \"WlDataSource.dnd_finished()\".\n+ Negative values for either rate or delay are illegal. A rate of\n+ zero will disable any repeating (regardless of the value of\n+ delay).\n \n- Compositors may also change the selected action on the fly,\n- mainly in response to keyboard modifier changes during the drag-\n- and-drop operation.\n+ This event can be sent later on as well with a new value if\n+ necessary, so clients should continue listening for the event\n+ past the creation of \"WlKeyboard\".\n \n- The most recent action received is always the valid one. The\n- chosen action may change alongside negotiation (e.g. an \"ask\"\n- action can turn into a \"move\" operation), so the effects of the\n- final action must always be applied in\n- \"WlDataOffer.dnd_finished()\".\n+ Parameters:\n+ * **rate** (*ArgumentType.Int*) -- the rate of repeating keys\n+ in characters per second\n \n- Clients can trigger cursor surface changes from this point, so\n- they reflect the current action.\n+ * **delay** (*ArgumentType.Int*) -- delay in milliseconds\n+ since key down until repeating starts\n+\n+\n+WlCompositor\n+============\n+\n+class pywayland.protocol.wayland.WlCompositor\n+\n+ The compositor singleton\n+\n+ A compositor. This object is a singleton global. The compositor\n+ is in charge of combining the contents of multiple surfaces into\n+ one displayable output.\n+\n+ create_surface() -> 'Proxy[WlSurface]'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Create new surface\n+\n+ Ask the compositor to create a new surface.\n+\n+ Returns:\n+ \"WlSurface\" -- the new surface\n+\n+ create_region() -> 'Proxy[WlRegion]'\n+\n+ -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+\n+ Create new region\n+\n+ Ask the compositor to create a new region.\n+\n+ Returns:\n+ \"WlRegion\" -- the new region\n+\n+\n+WlSeat\n+======\n+\n+class pywayland.protocol.wayland.WlSeat\n+\n+ Group of input devices\n+\n+ A seat is a group of keyboards, pointer and touch devices. This\n+ object is published as a global during start up, or when such a\n+ device is hot plugged. A seat typically has a pointer and\n+ maintains a keyboard focus and a pointer focus.\n+\n+ get_pointer() -> 'Proxy[WlPointer]'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Return pointer object\n+\n+ The ID provided will be initialized to the \"WlPointer\" interface\n+ for this seat.\n+\n+ This request only takes effect if the seat has the pointer\n+ capability, or has had the pointer capability in the past. It is\n+ a protocol violation to issue this request on a seat that has\n+ never had the pointer capability. The missing_capability error\n+ will be sent in this case.\n+\n+ Returns:\n+ \"WlPointer\" -- seat pointer\n+\n+ get_keyboard() -> 'Proxy[WlKeyboard]'\n+\n+ -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+\n+ Return keyboard object\n+\n+ The ID provided will be initialized to the \"WlKeyboard\"\n+ interface for this seat.\n+\n+ This request only takes effect if the seat has the keyboard\n+ capability, or has had the keyboard capability in the past. It\n+ is a protocol violation to issue this request on a seat that has\n+ never had the keyboard capability. The missing_capability error\n+ will be sent in this case.\n+\n+ Returns:\n+ \"WlKeyboard\" -- seat keyboard\n+\n+ get_touch() -> 'Proxy[WlTouch]'\n+\n+ -[ Request -- opcode 2 (attached to \"Resource\" instance) ]-\n+\n+ Return touch object\n+\n+ The ID provided will be initialized to the \"WlTouch\" interface\n+ for this seat.\n+\n+ This request only takes effect if the seat has the touch\n+ capability, or has had the touch capability in the past. It is a\n+ protocol violation to issue this request on a seat that has\n+ never had the touch capability. The missing_capability error\n+ will be sent in this case.\n+\n+ Returns:\n+ \"WlTouch\" -- seat touch interface\n+\n+ release() -> 'None'\n+\n+ -[ Request -- opcode 3 (attached to \"Resource\" instance) ]-\n+\n+ Release the seat object\n+\n+ Using this request a client can tell the server that it is not\n+ going to use the seat object anymore.\n+\n+ capabilities(capabilities: 'int') -> 'None'\n+\n+ -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n+\n+ Seat capabilities changed\n+\n+ This is emitted whenever a seat gains or loses the pointer,\n+ keyboard or touch capabilities. The argument is a capability\n+ enum containing the complete set of capabilities this seat has.\n+\n+ When the pointer capability is added, a client may create a\n+ \"WlPointer\" object using the \"WlSeat.get_pointer()\" request.\n+ This object will receive pointer events until the capability is\n+ removed in the future.\n+\n+ When the pointer capability is removed, a client should destroy\n+ the \"WlPointer\" objects associated with the seat where the\n+ capability was removed, using the \"WlPointer.release()\" request.\n+ No further pointer events will be received on these objects.\n+\n+ In some compositors, if a seat regains the pointer capability\n+ and a client has a previously obtained \"WlPointer\" object of\n+ version 4 or less, that object may start sending pointer events\n+ again. This behavior is considered a misinterpretation of the\n+ intended behavior and must not be relied upon by the client.\n+ \"WlPointer\" objects of version 5 or later must not send events\n+ if created before the most recent event notifying the client of\n+ an added pointer capability.\n+\n+ The above behavior also applies to \"WlKeyboard\" and \"WlTouch\"\n+ with the keyboard and touch capabilities, respectively.\n \n Parameters:\n- **dnd_action** (*ArgumentType.Uint*) -- action selected by\n- the compositor\n+ **capabilities** (*ArgumentType.Uint*) -- capabilities of the\n+ seat\n+\n+ name(name: 'str') -> 'None'\n+\n+ -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n+\n+ Unique identifier for this seat\n+\n+ In a multi-seat configuration the seat name can be used by\n+ clients to help identify which physical devices the seat\n+ represents.\n+\n+ The seat name is a UTF-8 string with no convention defined for\n+ its contents. Each name is unique among all \"WlSeat\" globals.\n+ The name is only guaranteed to be unique for the current\n+ compositor instance.\n+\n+ The same seat names are used for all clients. Thus, the name can\n+ be shared across processes to refer to a specific \"WlSeat\"\n+ global.\n+\n+ The name event is sent after binding to the seat global. This\n+ event is only sent once per seat object, and the name does not\n+ change over the lifetime of the \"WlSeat\" global.\n+\n+ Compositors may re-use the same seat name if the \"WlSeat\" global\n+ is destroyed and re-created later.\n+\n+ Parameters:\n+ **name** (*ArgumentType.String*) -- seat identifier\n \n \n WlDataOffer\n ===========\n \n class pywayland.protocol.wayland.WlDataOffer\n \n@@ -1260,14 +2111,389 @@\n \"WlDataOffer.finish()\".\n \n Parameters:\n **dnd_action** (*ArgumentType.Uint*) -- action selected by\n the compositor\n \n \n+WlBuffer\n+========\n+\n+class pywayland.protocol.wayland.WlBuffer\n+\n+ Content for a \"WlSurface\"\n+\n+ A buffer provides the content for a \"WlSurface\". Buffers are\n+ created through factory interfaces such as \"WlShm\",\n+ wp_linux_buffer_params (from the linux-dmabuf protocol extension)\n+ or similar. It has a width and a height and can be attached to a\n+ \"WlSurface\", but the mechanism by which a client provides and\n+ updates the contents is defined by the buffer factory interface.\n+\n+ Color channels are assumed to be electrical rather than optical (in\n+ other words, encoded with a transfer function) unless otherwise\n+ specified. If the buffer uses a format that has an alpha channel,\n+ the alpha channel is assumed to be premultiplied into the\n+ electrical color channel values (after transfer function encoding)\n+ unless otherwise specified.\n+\n+ Note, because \"WlBuffer\" objects are created from multiple\n+ independent factory interfaces, the \"WlBuffer\" interface is frozen\n+ at version 1.\n+\n+ destroy() -> 'None'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Destroy a buffer\n+\n+ Destroy a buffer. If and how you need to release the backing\n+ storage is defined by the buffer factory interface.\n+\n+ For possible side-effects to a surface, see\n+ \"WlSurface.attach()\".\n+\n+ release() -> 'None'\n+\n+ -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n+\n+ Compositor releases buffer\n+\n+ Sent when this \"WlBuffer\" is no longer used by the compositor.\n+ The client is now free to reuse or destroy this buffer and its\n+ backing storage.\n+\n+ If a client receives a release event before the frame callback\n+ requested in the same \"WlSurface.commit()\" that attaches this\n+ \"WlBuffer\" to a surface, then the client is immediately free to\n+ reuse the buffer and its backing storage, and does not need a\n+ second buffer for the next surface content update. Typically\n+ this is possible, when the compositor maintains a copy of the\n+ \"WlSurface\" contents, e.g. as a GL texture. This is an important\n+ optimization for GL(ES) compositors with \"WlShm\" clients.\n+\n+\n+WlDataSource\n+============\n+\n+class pywayland.protocol.wayland.WlDataSource\n+\n+ Offer to transfer data\n+\n+ The \"WlDataSource\" object is the source side of a \"WlDataOffer\". It\n+ is created by the source client in a data transfer and provides a\n+ way to describe the offered data and a way to respond to requests\n+ to transfer the data.\n+\n+ offer(mime_type: 'str') -> 'None'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Add an offered mime type\n+\n+ This request adds a mime type to the set of mime types\n+ advertised to targets. Can be called several times to offer\n+ multiple types.\n+\n+ Parameters:\n+ **mime_type** (*ArgumentType.String*) -- mime type offered by\n+ the data source\n+\n+ destroy() -> 'None'\n+\n+ -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+\n+ Destroy the data source\n+\n+ Destroy the data source.\n+\n+ set_actions(dnd_actions: 'int') -> 'None'\n+\n+ -[ Request -- opcode 2 (attached to \"Resource\" instance) ]-\n+\n+ Set the available drag-and-drop actions\n+\n+ Sets the actions that the source side client supports for this\n+ operation. This request may trigger \"WlDataSource.action()\" and\n+ \"WlDataOffer.action()\" events if the compositor needs to change\n+ the selected action.\n+\n+ The dnd_actions argument must contain only values expressed in\n+ the \"WlDataDeviceManager.dnd_actions()\" enum, otherwise it will\n+ result in a protocol error.\n+\n+ This request must be made once only, and can only be made on\n+ sources used in drag-and-drop, so it must be performed before\n+ \"WlDataDevice.start_drag()\". Attempting to use the source other\n+ than for drag-and-drop will raise a protocol error.\n+\n+ Parameters:\n+ **dnd_actions** (*ArgumentType.Uint*) -- actions supported by\n+ the data source\n+\n+ target(mime_type: 'str | None') -> 'None'\n+\n+ -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n+\n+ A target accepts an offered mime type\n+\n+ Sent when a target accepts pointer_focus or motion events. If a\n+ target does not accept any of the offered types, type is NULL.\n+\n+ Used for feedback during drag-and-drop.\n+\n+ Parameters:\n+ **mime_type** (*ArgumentType.String* or *None*) -- mime type\n+ accepted by the target\n+\n+ send(mime_type: 'str', fd: 'int') -> 'None'\n+\n+ -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n+\n+ Send the data\n+\n+ Request for data from the client. Send the data as the\n+ specified mime type over the passed file descriptor, then close\n+ it.\n+\n+ Parameters:\n+ * **mime_type** (*ArgumentType.String*) -- mime type for the\n+ data\n+\n+ * **fd** (*ArgumentType.FileDescriptor*) -- file descriptor\n+ for the data\n+\n+ cancelled() -> 'None'\n+\n+ -[ Event -- opcode 2 (attached to \"Proxy\" instance) ]-\n+\n+ Selection was cancelled\n+\n+ This data source is no longer valid. There are several reasons\n+ why this could happen:\n+\n+ * The data source has been replaced by another data source.\n+\n+ * The drag-and-drop operation was performed, but the drop\n+ destination did not accept any of the mime types offered\n+ through \"WlDataSource.target()\".\n+\n+ * The drag-and-drop operation was performed, but the drop\n+ destination did not select any of the actions present in the\n+ mask offered through \"WlDataSource.action()\".\n+\n+ * The drag-and-drop operation was performed but didn't happen\n+ over a surface.\n+\n+ * The compositor cancelled the drag-and-drop operation (e.g.\n+ compositor dependent timeouts to avoid stale drag-and-drop\n+ transfers).\n+\n+ The client should clean up and destroy this data source.\n+\n+ For objects of version 2 or older, \"WlDataSource.cancelled()\"\n+ will only be emitted if the data source was replaced by another\n+ data source.\n+\n+ dnd_drop_performed() -> 'None'\n+\n+ -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n+\n+ The drag-and-drop operation physically finished\n+\n+ The user performed the drop action. This event does not indicate\n+ acceptance, \"WlDataSource.cancelled()\" may still be emitted\n+ afterwards if the drop destination does not accept any mime\n+ type.\n+\n+ However, this event might however not be received if the\n+ compositor cancelled the drag-and-drop operation before this\n+ event could happen.\n+\n+ Note that the data_source may still be used in the future and\n+ should not be destroyed here.\n+\n+ dnd_finished() -> 'None'\n+\n+ -[ Event -- opcode 4 (attached to \"Proxy\" instance) ]-\n+\n+ The drag-and-drop operation concluded\n+\n+ The drop destination finished interoperating with this data\n+ source, so the client is now free to destroy this data source\n+ and free all associated data.\n+\n+ If the action used to perform the operation was \"move\", the\n+ source can now delete the transferred data.\n+\n+ action(dnd_action: 'int') -> 'None'\n+\n+ -[ Event -- opcode 5 (attached to \"Proxy\" instance) ]-\n+\n+ Notify the selected action\n+\n+ This event indicates the action selected by the compositor after\n+ matching the source/destination side actions. Only one action\n+ (or none) will be offered here.\n+\n+ This event can be emitted multiple times during the drag-and-\n+ drop operation, mainly in response to destination side changes\n+ through \"WlDataOffer.set_actions()\", and as the data device\n+ enters/leaves surfaces.\n+\n+ It is only possible to receive this event after\n+ \"WlDataSource.dnd_drop_performed()\" if the drag-and-drop\n+ operation ended in an \"ask\" action, in which case the final\n+ \"WlDataSource.action()\" event will happen immediately before\n+ \"WlDataSource.dnd_finished()\".\n+\n+ Compositors may also change the selected action on the fly,\n+ mainly in response to keyboard modifier changes during the drag-\n+ and-drop operation.\n+\n+ The most recent action received is always the valid one. The\n+ chosen action may change alongside negotiation (e.g. an \"ask\"\n+ action can turn into a \"move\" operation), so the effects of the\n+ final action must always be applied in\n+ \"WlDataOffer.dnd_finished()\".\n+\n+ Clients can trigger cursor surface changes from this point, so\n+ they reflect the current action.\n+\n+ Parameters:\n+ **dnd_action** (*ArgumentType.Uint*) -- action selected by\n+ the compositor\n+\n+\n+WlCallback\n+==========\n+\n+class pywayland.protocol.wayland.WlCallback\n+\n+ Callback object\n+\n+ Clients can handle the 'done' event to get notified when the\n+ related request is done.\n+\n+ Note, because \"WlCallback\" objects are created from multiple\n+ independent factory interfaces, the \"WlCallback\" interface is\n+ frozen at version 1.\n+\n+ done(callback_data: 'int') -> 'None'\n+\n+ -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n+\n+ Done event\n+\n+ Notify the client when the related request is done.\n+\n+ Parameters:\n+ **callback_data** (*ArgumentType.Uint*) -- request-specific\n+ data for the callback\n+\n+\n+WlRegion\n+========\n+\n+class pywayland.protocol.wayland.WlRegion\n+\n+ Region interface\n+\n+ A region object describes an area.\n+\n+ Region objects are used to describe the opaque and input regions of\n+ a surface.\n+\n+ destroy() -> 'None'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Destroy region\n+\n+ Destroy the region. This will invalidate the object ID.\n+\n+ add(x: 'int', y: 'int', width: 'int', height: 'int') -> 'None'\n+\n+ -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+\n+ Add rectangle to region\n+\n+ Add the specified rectangle to the region.\n+\n+ Parameters:\n+ * **x** (*ArgumentType.Int*) -- region-local x coordinate\n+\n+ * **y** (*ArgumentType.Int*) -- region-local y coordinate\n+\n+ * **width** (*ArgumentType.Int*) -- rectangle width\n+\n+ * **height** (*ArgumentType.Int*) -- rectangle height\n+\n+ subtract(x: 'int', y: 'int', width: 'int', height: 'int') -> 'None'\n+\n+ -[ Request -- opcode 2 (attached to \"Resource\" instance) ]-\n+\n+ Subtract rectangle from region\n+\n+ Subtract the specified rectangle from the region.\n+\n+ Parameters:\n+ * **x** (*ArgumentType.Int*) -- region-local x coordinate\n+\n+ * **y** (*ArgumentType.Int*) -- region-local y coordinate\n+\n+ * **width** (*ArgumentType.Int*) -- rectangle width\n+\n+ * **height** (*ArgumentType.Int*) -- rectangle height\n+\n+\n+WlDataDeviceManager\n+===================\n+\n+class pywayland.protocol.wayland.WlDataDeviceManager\n+\n+ Data transfer interface\n+\n+ The \"WlDataDeviceManager\" is a singleton global object that\n+ provides access to inter-client data transfer mechanisms such as\n+ copy-and-paste and drag-and-drop. These mechanisms are tied to a\n+ \"WlSeat\" and this interface lets a client get a \"WlDataDevice\"\n+ corresponding to a \"WlSeat\".\n+\n+ Depending on the version bound, the objects created from the bound\n+ \"WlDataDeviceManager\" object will have different requirements for\n+ functioning properly. See \"WlDataSource.set_actions()\",\n+ \"WlDataOffer.accept()\" and \"WlDataOffer.finish()\" for details.\n+\n+ create_data_source() -> 'Proxy[WlDataSource]'\n+\n+ -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n+\n+ Create a new data source\n+\n+ Create a new data source.\n+\n+ Returns:\n+ \"WlDataSource\" -- data source to create\n+\n+ get_data_device(seat: 'WlSeat') -> 'Proxy[WlDataDevice]'\n+\n+ -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n+\n+ Create a new data device\n+\n+ Create a new data device for a given seat.\n+\n+ Parameters:\n+ **seat** (\"WlSeat\") -- seat associated with the data device\n+\n+ Returns:\n+ \"WlDataDevice\" -- data device to create\n+\n+\n WlShellSurface\n ==============\n \n class pywayland.protocol.wayland.WlShellSurface\n \n Desktop-style metadata interface\n \n@@ -1760,684 +2986,14 @@\n sub- surface may override it to behave as synchronized. For\n details, see \"WlSubsurface\".\n \n If a surface's parent surface behaves as desynchronized, then\n the cached state is applied on set_desync.\n \n \n-WlShm\n-=====\n-\n-class pywayland.protocol.wayland.WlShm\n-\n- Shared memory support\n-\n- A singleton global object that provides support for shared memory.\n-\n- Clients can create \"WlShmPool\" objects using the create_pool\n- request.\n-\n- On binding the \"WlShm\" object one or more format events are emitted\n- to inform clients about the valid pixel formats that can be used\n- for buffers.\n-\n- create_pool(fd: 'int', size: 'int') -> 'Proxy[WlShmPool]'\n-\n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n-\n- Create a shm pool\n-\n- Create a new \"WlShmPool\" object.\n-\n- The pool can be used to create shared memory based buffer\n- objects. The server will mmap size bytes of the passed file\n- descriptor, to use as backing memory for the pool.\n-\n- Parameters:\n- * **fd** (*ArgumentType.FileDescriptor*) -- file descriptor\n- for the pool\n-\n- * **size** (*ArgumentType.Int*) -- pool size, in bytes\n-\n- Returns:\n- \"WlShmPool\" -- pool to create\n-\n- release() -> 'None'\n-\n- -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n-\n- Release the shm object\n-\n- Using this request a client can tell the server that it is not\n- going to use the shm object anymore.\n-\n- Objects created via this interface remain unaffected.\n-\n- format(format: 'int') -> 'None'\n-\n- -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n-\n- Pixel format description\n-\n- Informs the client about a valid pixel format that can be used\n- for buffers. Known formats include argb8888 and xrgb8888.\n-\n- Parameters:\n- **format** (*ArgumentType.Uint*) -- buffer pixel format\n-\n-\n-WlKeyboard\n-==========\n-\n-class pywayland.protocol.wayland.WlKeyboard\n-\n- Keyboard input device\n-\n- The \"WlKeyboard\" interface represents one or more keyboards\n- associated with a seat.\n-\n- Each \"WlKeyboard\" has the following logical state:\n-\n- * an active surface (possibly null),\n-\n- * the keys currently logically down,\n-\n- * the active modifiers,\n-\n- * the active group.\n-\n- By default, the active surface is null, the keys currently\n- logically down are empty, the active modifiers and the active group\n- are 0.\n-\n- release() -> 'None'\n-\n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n-\n- Release the keyboard object\n-\n- keymap(format: 'int', fd: 'int', size: 'int') -> 'None'\n-\n- -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n-\n- Keyboard mapping\n-\n- This event provides a file descriptor to the client which can be\n- memory-mapped in read-only mode to provide a keyboard mapping\n- description.\n-\n- From version 7 onwards, the fd must be mapped with MAP_PRIVATE\n- by the recipient, as MAP_SHARED may fail.\n-\n- Parameters:\n- * **format** (*ArgumentType.Uint*) -- keymap format\n-\n- * **fd** (*ArgumentType.FileDescriptor*) -- keymap file\n- descriptor\n-\n- * **size** (*ArgumentType.Uint*) -- keymap size, in bytes\n-\n- enter(serial: 'int', surface: 'WlSurface', keys: 'list') -> 'None'\n-\n- -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n-\n- Enter event\n-\n- Notification that this seat's keyboard focus is on a certain\n- surface.\n-\n- The compositor must send the \"WlKeyboard.modifiers()\" event\n- after this event.\n-\n- In the \"WlKeyboard\" logical state, this event sets the active\n- surface to the surface argument and the keys currently logically\n- down to the keys in the keys argument. The compositor must not\n- send this event if the \"WlKeyboard\" already had an active\n- surface immediately before this event.\n-\n- Parameters:\n- * **serial** (*ArgumentType.Uint*) -- serial number of the\n- enter event\n-\n- * **surface** (\"WlSurface\") -- surface gaining keyboard focus\n-\n- * **keys** (*ArgumentType.Array*) -- the keys currently\n- logically down\n-\n- leave(serial: 'int', surface: 'WlSurface') -> 'None'\n-\n- -[ Event -- opcode 2 (attached to \"Proxy\" instance) ]-\n-\n- Leave event\n-\n- Notification that this seat's keyboard focus is no longer on a\n- certain surface.\n-\n- The leave notification is sent before the enter notification for\n- the new focus.\n-\n- In the \"WlKeyboard\" logical state, this event resets all values\n- to their defaults. The compositor must not send this event if\n- the active surface of the \"WlKeyboard\" was not equal to the\n- surface argument immediately before this event.\n-\n- Parameters:\n- * **serial** (*ArgumentType.Uint*) -- serial number of the\n- leave event\n-\n- * **surface** (\"WlSurface\") -- surface that lost keyboard\n- focus\n-\n- key(serial: 'int', time: 'int', key: 'int', state: 'int') -> 'None'\n-\n- -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n-\n- Key event\n-\n- A key was pressed or released. The time argument is a timestamp\n- with millisecond granularity, with an undefined base.\n-\n- The key is a platform-specific key code that can be interpreted\n- by feeding it to the keyboard mapping (see the keymap event).\n-\n- If this event produces a change in modifiers, then the resulting\n- \"WlKeyboard.modifiers()\" event must be sent after this event.\n-\n- In the \"WlKeyboard\" logical state, this event adds the key to\n- the keys currently logically down (if the state argument is\n- pressed) or removes the key from the keys currently logically\n- down (if the state argument is released). The compositor must\n- not send this event if the \"WlKeyboard\" did not have an active\n- surface immediately before this event. The compositor must not\n- send this event if state is pressed (resp. released) and the key\n- was already logically down (resp. was not logically down)\n- immediately before this event.\n-\n- Parameters:\n- * **serial** (*ArgumentType.Uint*) -- serial number of the\n- key event\n-\n- * **time** (*ArgumentType.Uint*) -- timestamp with\n- millisecond granularity\n-\n- * **key** (*ArgumentType.Uint*) -- key that produced the\n- event\n-\n- * **state** (*ArgumentType.Uint*) -- physical state of the\n- key\n-\n- modifiers(serial: 'int', mods_depressed: 'int', mods_latched: 'int', mods_locked: 'int', group: 'int') -> 'None'\n-\n- -[ Event -- opcode 4 (attached to \"Proxy\" instance) ]-\n-\n- Modifier and group state\n-\n- Notifies clients that the modifier and/or group state has\n- changed, and it should update its local state.\n-\n- The compositor may send this event without a surface of the\n- client having keyboard focus, for example to tie modifier\n- information to pointer focus instead. If a modifier event with\n- pressed modifiers is sent without a prior enter event, the\n- client can assume the modifier state is valid until it receives\n- the next \"WlKeyboard.modifiers()\" event. In order to reset the\n- modifier state again, the compositor can send a\n- \"WlKeyboard.modifiers()\" event with no pressed modifiers.\n-\n- In the \"WlKeyboard\" logical state, this event updates the\n- modifiers and group.\n-\n- Parameters:\n- * **serial** (*ArgumentType.Uint*) -- serial number of the\n- modifiers event\n-\n- * **mods_depressed** (*ArgumentType.Uint*) -- depressed\n- modifiers\n-\n- * **mods_latched** (*ArgumentType.Uint*) -- latched modifiers\n-\n- * **mods_locked** (*ArgumentType.Uint*) -- locked modifiers\n-\n- * **group** (*ArgumentType.Uint*) -- keyboard layout\n-\n- repeat_info(rate: 'int', delay: 'int') -> 'None'\n-\n- -[ Event -- opcode 5 (attached to \"Proxy\" instance) ]-\n-\n- Repeat rate and delay\n-\n- Informs the client about the keyboard's repeat rate and delay.\n-\n- This event is sent as soon as the \"WlKeyboard\" object has been\n- created, and is guaranteed to be received by the client before\n- any key press event.\n-\n- Negative values for either rate or delay are illegal. A rate of\n- zero will disable any repeating (regardless of the value of\n- delay).\n-\n- This event can be sent later on as well with a new value if\n- necessary, so clients should continue listening for the event\n- past the creation of \"WlKeyboard\".\n-\n- Parameters:\n- * **rate** (*ArgumentType.Int*) -- the rate of repeating keys\n- in characters per second\n-\n- * **delay** (*ArgumentType.Int*) -- delay in milliseconds\n- since key down until repeating starts\n-\n-\n-WlTouch\n-=======\n-\n-class pywayland.protocol.wayland.WlTouch\n-\n- Touchscreen input device\n-\n- The \"WlTouch\" interface represents a touchscreen associated with a\n- seat.\n-\n- Touch interactions can consist of one or more contacts. For each\n- contact, a series of events is generated, starting with a down\n- event, followed by zero or more motion events, and ending with an\n- up event. Events relating to the same contact point can be\n- identified by the ID of the sequence.\n-\n- release() -> 'None'\n-\n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n-\n- Release the touch object\n-\n- down(serial: 'int', time: 'int', surface: 'WlSurface', id: 'int', x: 'float', y: 'float') -> 'None'\n-\n- -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n-\n- Touch down event and beginning of a touch sequence\n-\n- A new touch point has appeared on the surface. This touch point\n- is assigned a unique ID. Future events from this touch point\n- reference this ID. The ID ceases to be valid after a touch up\n- event and may be reused in the future.\n-\n- Parameters:\n- * **serial** (*ArgumentType.Uint*) -- serial number of the\n- touch down event\n-\n- * **time** (*ArgumentType.Uint*) -- timestamp with\n- millisecond granularity\n-\n- * **surface** (\"WlSurface\") -- surface touched\n-\n- * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n- point\n-\n- * **x** (*ArgumentType.Fixed*) -- surface-local x coordinate\n-\n- * **y** (*ArgumentType.Fixed*) -- surface-local y coordinate\n-\n- up(serial: 'int', time: 'int', id: 'int') -> 'None'\n-\n- -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n-\n- End of a touch event sequence\n-\n- The touch point has disappeared. No further events will be sent\n- for this touch point and the touch point's ID is released and\n- may be reused in a future touch down event.\n-\n- Parameters:\n- * **serial** (*ArgumentType.Uint*) -- serial number of the\n- touch up event\n-\n- * **time** (*ArgumentType.Uint*) -- timestamp with\n- millisecond granularity\n-\n- * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n- point\n-\n- motion(time: 'int', id: 'int', x: 'float', y: 'float') -> 'None'\n-\n- -[ Event -- opcode 2 (attached to \"Proxy\" instance) ]-\n-\n- Update of touch point coordinates\n-\n- A touch point has changed coordinates.\n-\n- Parameters:\n- * **time** (*ArgumentType.Uint*) -- timestamp with\n- millisecond granularity\n-\n- * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n- point\n-\n- * **x** (*ArgumentType.Fixed*) -- surface-local x coordinate\n-\n- * **y** (*ArgumentType.Fixed*) -- surface-local y coordinate\n-\n- frame() -> 'None'\n-\n- -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n-\n- End of touch frame event\n-\n- Indicates the end of a set of events that logically belong\n- together. A client is expected to accumulate the data in all\n- events within the frame before proceeding.\n-\n- A \"WlTouch.frame()\" terminates at least one event but otherwise\n- no guarantee is provided about the set of events within a frame.\n- A client must assume that any state not updated in a frame is\n- unchanged from the previously known state.\n-\n- cancel() -> 'None'\n-\n- -[ Event -- opcode 4 (attached to \"Proxy\" instance) ]-\n-\n- Touch session cancelled\n-\n- Sent if the compositor decides the touch stream is a global\n- gesture. No further events are sent to the clients from that\n- particular gesture. Touch cancellation applies to all touch\n- points currently active on this client's surface. The client is\n- responsible for finalizing the touch points, future touch points\n- on this surface may reuse the touch point ID.\n-\n- No frame event is required after the cancel event.\n-\n- shape(id: 'int', major: 'float', minor: 'float') -> 'None'\n-\n- -[ Event -- opcode 5 (attached to \"Proxy\" instance) ]-\n-\n- Update shape of touch point\n-\n- Sent when a touchpoint has changed its shape.\n-\n- This event does not occur on its own. It is sent before a\n- \"WlTouch.frame()\" event and carries the new shape information\n- for any previously reported, or new touch points of that frame.\n-\n- Other events describing the touch point such as\n- \"WlTouch.down()\", \"WlTouch.motion()\" or \"WlTouch.orientation()\"\n- may be sent within the same \"WlTouch.frame()\". A client should\n- treat these events as a single logical touch point update. The\n- order of \"WlTouch.shape()\", \"WlTouch.orientation()\" and\n- \"WlTouch.motion()\" is not guaranteed. A \"WlTouch.down()\" event\n- is guaranteed to occur before the first \"WlTouch.shape()\" event\n- for this touch ID but both events may occur within the same\n- \"WlTouch.frame()\".\n-\n- A touchpoint shape is approximated by an ellipse through the\n- major and minor axis length. The major axis length describes the\n- longer diameter of the ellipse, while the minor axis length\n- describes the shorter diameter. Major and minor are orthogonal\n- and both are specified in surface-local coordinates. The center\n- of the ellipse is always at the touchpoint location as reported\n- by \"WlTouch.down()\" or \"WlTouch.move()\".\n-\n- This event is only sent by the compositor if the touch device\n- supports shape reports. The client has to make reasonable\n- assumptions about the shape if it did not receive this event.\n-\n- Parameters:\n- * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n- point\n-\n- * **major** (*ArgumentType.Fixed*) -- length of the major\n- axis in surface-local coordinates\n-\n- * **minor** (*ArgumentType.Fixed*) -- length of the minor\n- axis in surface-local coordinates\n-\n- orientation(id: 'int', orientation: 'float') -> 'None'\n-\n- -[ Event -- opcode 6 (attached to \"Proxy\" instance) ]-\n-\n- Update orientation of touch point\n-\n- Sent when a touchpoint has changed its orientation.\n-\n- This event does not occur on its own. It is sent before a\n- \"WlTouch.frame()\" event and carries the new shape information\n- for any previously reported, or new touch points of that frame.\n-\n- Other events describing the touch point such as\n- \"WlTouch.down()\", \"WlTouch.motion()\" or \"WlTouch.shape()\" may be\n- sent within the same \"WlTouch.frame()\". A client should treat\n- these events as a single logical touch point update. The order\n- of \"WlTouch.shape()\", \"WlTouch.orientation()\" and\n- \"WlTouch.motion()\" is not guaranteed. A \"WlTouch.down()\" event\n- is guaranteed to occur before the first \"WlTouch.orientation()\"\n- event for this touch ID but both events may occur within the\n- same \"WlTouch.frame()\".\n-\n- The orientation describes the clockwise angle of a touchpoint's\n- major axis to the positive surface y-axis and is normalized to\n- the -180 to +180 degree range. The granularity of orientation\n- depends on the touch device, some devices only support binary\n- rotation values between 0 and 90 degrees.\n-\n- This event is only sent by the compositor if the touch device\n- supports orientation reports.\n-\n- Parameters:\n- * **id** (*ArgumentType.Int*) -- the unique ID of this touch\n- point\n-\n- * **orientation** (*ArgumentType.Fixed*) -- angle between\n- major axis and positive surface y-axis in degrees\n-\n-\n-WlDataDevice\n-============\n-\n-class pywayland.protocol.wayland.WlDataDevice\n-\n- Data transfer device\n-\n- There is one \"WlDataDevice\" per seat which can be obtained from the\n- global \"WlDataDeviceManager\" singleton.\n-\n- A \"WlDataDevice\" provides access to inter-client data transfer\n- mechanisms such as copy-and-paste and drag-and-drop.\n-\n- start_drag(source: 'WlDataSource | None', origin: 'WlSurface', icon: 'WlSurface | None', serial: 'int') -> 'None'\n-\n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n-\n- Start drag-and-drop operation\n-\n- This request asks the compositor to start a drag-and-drop\n- operation on behalf of the client.\n-\n- The source argument is the data source that provides the data\n- for the eventual data transfer. If source is NULL, enter, leave\n- and motion events are sent only to the client that initiated the\n- drag and the client is expected to handle the data passing\n- internally. If source is destroyed, the drag-and-drop session\n- will be cancelled.\n-\n- The origin surface is the surface where the drag originates and\n- the client must have an active implicit grab that matches the\n- serial.\n-\n- The icon surface is an optional (can be NULL) surface that\n- provides an icon to be moved around with the cursor. Initially,\n- the top-left corner of the icon surface is placed at the cursor\n- hotspot, but subsequent \"WlSurface.offset()\" requests can move\n- the relative position. Attach requests must be confirmed with\n- \"WlSurface.commit()\" as usual. The icon surface is given the\n- role of a drag-and-drop icon. If the icon surface already has\n- another role, it raises a protocol error.\n-\n- The input region is ignored for wl_surfaces with the role of a\n- drag- and-drop icon.\n-\n- The given source may not be used in any further set_selection or\n- start_drag requests. Attempting to reuse a previously-used\n- source may send a used_source error.\n-\n- Parameters:\n- * **source** (\"WlDataSource\" or *None*) -- data source for\n- the eventual transfer\n-\n- * **origin** (\"WlSurface\") -- surface where the drag\n- originates\n-\n- * **icon** (\"WlSurface\" or *None*) -- drag-and-drop icon\n- surface\n-\n- * **serial** (*ArgumentType.Uint*) -- serial number of the\n- implicit grab on the origin\n-\n- set_selection(source: 'WlDataSource | None', serial: 'int') -> 'None'\n-\n- -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n-\n- Copy data to the selection\n-\n- This request asks the compositor to set the selection to the\n- data from the source on behalf of the client.\n-\n- To unset the selection, set the source to NULL.\n-\n- The given source may not be used in any further set_selection or\n- start_drag requests. Attempting to reuse a previously-used\n- source may send a used_source error.\n-\n- Parameters:\n- * **source** (\"WlDataSource\" or *None*) -- data source for\n- the selection\n-\n- * **serial** (*ArgumentType.Uint*) -- serial number of the\n- event that triggered this request\n-\n- release() -> 'None'\n-\n- -[ Request -- opcode 2 (attached to \"Resource\" instance) ]-\n-\n- Destroy data device\n-\n- This request destroys the data device.\n-\n- data_offer(id: 'WlDataOffer') -> 'None'\n-\n- -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n-\n- Introduce a new \"WlDataOffer\"\n-\n- The data_offer event introduces a new \"WlDataOffer\" object,\n- which will subsequently be used in either the data_device.enter\n- event (for drag- and-drop) or the data_device.selection event\n- (for selections). Immediately following the\n- data_device.data_offer event, the new data_offer object will\n- send out data_offer.offer events to describe the mime types it\n- offers.\n-\n- Parameters:\n- **id** (\"WlDataOffer\") -- the new data_offer object\n-\n- enter(serial: 'int', surface: 'WlSurface', x: 'float', y: 'float', id: 'WlDataOffer | None') -> 'None'\n-\n- -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n-\n- Initiate drag-and-drop session\n-\n- This event is sent when an active drag-and-drop pointer enters a\n- surface owned by the client. The position of the pointer at\n- enter time is provided by the x and y arguments, in surface-\n- local coordinates.\n-\n- Parameters:\n- * **serial** (*ArgumentType.Uint*) -- serial number of the\n- enter event\n-\n- * **surface** (\"WlSurface\") -- client surface entered\n-\n- * **x** (*ArgumentType.Fixed*) -- surface-local x coordinate\n-\n- * **y** (*ArgumentType.Fixed*) -- surface-local y coordinate\n-\n- * **id** (\"WlDataOffer\" or *None*) -- source data_offer\n- object\n-\n- leave() -> 'None'\n-\n- -[ Event -- opcode 2 (attached to \"Proxy\" instance) ]-\n-\n- End drag-and-drop session\n-\n- This event is sent when the drag-and-drop pointer leaves the\n- surface and the session ends. The client must destroy the\n- \"WlDataOffer\" introduced at enter time at this point.\n-\n- motion(time: 'int', x: 'float', y: 'float') -> 'None'\n-\n- -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n-\n- Drag-and-drop session motion\n-\n- This event is sent when the drag-and-drop pointer moves within\n- the currently focused surface. The new position of the pointer\n- is provided by the x and y arguments, in surface-local\n- coordinates.\n-\n- Parameters:\n- * **time** (*ArgumentType.Uint*) -- timestamp with\n- millisecond granularity\n-\n- * **x** (*ArgumentType.Fixed*) -- surface-local x coordinate\n-\n- * **y** (*ArgumentType.Fixed*) -- surface-local y coordinate\n-\n- drop() -> 'None'\n-\n- -[ Event -- opcode 4 (attached to \"Proxy\" instance) ]-\n-\n- End drag-and-drop session successfully\n-\n- The event is sent when a drag-and-drop operation is ended\n- because the implicit grab is removed.\n-\n- The drag-and-drop destination is expected to honor the last\n- action received through \"WlDataOffer.action()\", if the resulting\n- action is \"copy\" or \"move\", the destination can still perform\n- \"WlDataOffer.receive()\" requests, and is expected to end all\n- transfers with a \"WlDataOffer.finish()\" request.\n-\n- If the resulting action is \"ask\", the action will not be\n- considered final. The drag-and-drop destination is expected to\n- perform one last \"WlDataOffer.set_actions()\" request, or\n- \"WlDataOffer.destroy()\" in order to cancel the operation.\n-\n- selection(id: 'WlDataOffer | None') -> 'None'\n-\n- -[ Event -- opcode 5 (attached to \"Proxy\" instance) ]-\n-\n- Advertise new selection\n-\n- The selection event is sent out to notify the client of a new\n- \"WlDataOffer\" for the selection for this device. The\n- data_device.data_offer and the data_offer.offer events are sent\n- out immediately before this event to introduce the data offer\n- object. The selection event is sent to a client immediately\n- before receiving keyboard focus and when a new selection is set\n- while the client has keyboard focus. The data_offer is valid\n- until a new data_offer or NULL is received or until the client\n- loses keyboard focus. Switching surface with keyboard focus\n- within the same client doesn't mean a new selection will be\n- sent. The client must destroy the previous selection\n- data_offer, if any, upon receiving this event.\n-\n- Parameters:\n- **id** (\"WlDataOffer\" or *None*) -- selection data_offer\n- object\n-\n-\n WlPointer\n =========\n \n class pywayland.protocol.wayland.WlPointer\n \n Pointer input device\n \n@@ -2871,48 +3427,14 @@\n Parameters:\n * **axis** (*ArgumentType.Uint*) -- axis type\n \n * **direction** (*ArgumentType.Uint*) -- physical direction\n relative to axis motion\n \n \n-WlCompositor\n-============\n-\n-class pywayland.protocol.wayland.WlCompositor\n-\n- The compositor singleton\n-\n- A compositor. This object is a singleton global. The compositor\n- is in charge of combining the contents of multiple surfaces into\n- one displayable output.\n-\n- create_surface() -> 'Proxy[WlSurface]'\n-\n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n-\n- Create new surface\n-\n- Ask the compositor to create a new surface.\n-\n- Returns:\n- \"WlSurface\" -- the new surface\n-\n- create_region() -> 'Proxy[WlRegion]'\n-\n- -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n-\n- Create new region\n-\n- Ask the compositor to create a new region.\n-\n- Returns:\n- \"WlRegion\" -- the new region\n-\n-\n WlShell\n =======\n \n class pywayland.protocol.wayland.WlShell\n \n Create desktop-style surfaces\n \n@@ -3028,529 +3550,7 @@\n When a client deletes an object that it had created, the server\n will send this event to acknowledge that it has seen the delete\n request. When the client receives this event, it will know that\n it can safely reuse the object ID.\n \n Parameters:\n **id** (*ArgumentType.Uint*) -- deleted object ID\n-\n-\n-WlOutput\n-========\n-\n-class pywayland.protocol.wayland.WlOutput\n-\n- Compositor output region\n-\n- An output describes part of the compositor geometry. The\n- compositor works in the 'compositor coordinate system' and an\n- output corresponds to a rectangular area in that space that is\n- actually visible. This typically corresponds to a monitor that\n- displays part of the compositor space. This object is published as\n- global during start up, or when a monitor is hotplugged.\n-\n- release() -> 'None'\n-\n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n-\n- Release the output object\n-\n- Using this request a client can tell the server that it is not\n- going to use the output object anymore.\n-\n- geometry(x: 'int', y: 'int', physical_width: 'int', physical_height: 'int', subpixel: 'int', make: 'str', model: 'str', transform: 'int') -> 'None'\n-\n- -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n-\n- Properties of the output\n-\n- The geometry event describes geometric properties of the output.\n- The event is sent when binding to the output object and whenever\n- any of the properties change.\n-\n- The physical size can be set to zero if it doesn't make sense\n- for this output (e.g. for projectors or virtual outputs).\n-\n- The geometry event will be followed by a done event (starting\n- from version 2).\n-\n- Clients should use \"WlSurface.preferred_buffer_transform()\"\n- instead of the transform advertised by this event to find the\n- preferred buffer transform to use for a surface.\n-\n- Note: \"WlOutput\" only advertises partial information about the\n- output position and identification. Some compositors, for\n- instance those not implementing a desktop-style output layout or\n- those exposing virtual outputs, might fake this information.\n- Instead of using x and y, clients should use\n- xdg_output.logical_position. Instead of using make and model,\n- clients should use name and description.\n-\n- Parameters:\n- * **x** (*ArgumentType.Int*) -- x position within the global\n- compositor space\n-\n- * **y** (*ArgumentType.Int*) -- y position within the global\n- compositor space\n-\n- * **physical_width** (*ArgumentType.Int*) -- width in\n- millimeters of the output\n-\n- * **physical_height** (*ArgumentType.Int*) -- height in\n- millimeters of the output\n-\n- * **subpixel** (*ArgumentType.Int*) -- subpixel orientation\n- of the output\n-\n- * **make** (*ArgumentType.String*) -- textual description of\n- the manufacturer\n-\n- * **model** (*ArgumentType.String*) -- textual description of\n- the model\n-\n- * **transform** (*ArgumentType.Int*) -- additional\n- transformation applied to buffer contents during\n- presentation\n-\n- mode(flags: 'int', width: 'int', height: 'int', refresh: 'int') -> 'None'\n-\n- -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n-\n- Advertise available modes for the output\n-\n- The mode event describes an available mode for the output.\n-\n- The event is sent when binding to the output object and there\n- will always be one mode, the current mode. The event is sent\n- again if an output changes mode, for the mode that is now\n- current. In other words, the current mode is always the last\n- mode that was received with the current flag set.\n-\n- Non-current modes are deprecated. A compositor can decide to\n- only advertise the current mode and never send other modes.\n- Clients should not rely on non-current modes.\n-\n- The size of a mode is given in physical hardware units of the\n- output device. This is not necessarily the same as the output\n- size in the global compositor space. For instance, the output\n- may be scaled, as described in \"WlOutput.scale()\", or\n- transformed, as described in \"WlOutput.transform()\". Clients\n- willing to retrieve the output size in the global compositor\n- space should use xdg_output.logical_size instead.\n-\n- The vertical refresh rate can be set to zero if it doesn't make\n- sense for this output (e.g. for virtual outputs).\n-\n- The mode event will be followed by a done event (starting from\n- version 2).\n-\n- Clients should not use the refresh rate to schedule frames.\n- Instead, they should use the \"WlSurface.frame()\" event or the\n- presentation-time protocol.\n-\n- Note: this information is not always meaningful for all outputs.\n- Some compositors, such as those exposing virtual outputs, might\n- fake the refresh rate or the size.\n-\n- Parameters:\n- * **flags** (*ArgumentType.Uint*) -- bitfield of mode flags\n-\n- * **width** (*ArgumentType.Int*) -- width of the mode in\n- hardware units\n-\n- * **height** (*ArgumentType.Int*) -- height of the mode in\n- hardware units\n-\n- * **refresh** (*ArgumentType.Int*) -- vertical refresh rate\n- in mHz\n-\n- done() -> 'None'\n-\n- -[ Event -- opcode 2 (attached to \"Proxy\" instance) ]-\n-\n- Sent all information about output\n-\n- This event is sent after all other properties have been sent\n- after binding to the output object and after any other property\n- changes done after that. This allows changes to the output\n- properties to be seen as atomic, even if they happen via\n- multiple events.\n-\n- scale(factor: 'int') -> 'None'\n-\n- -[ Event -- opcode 3 (attached to \"Proxy\" instance) ]-\n-\n- Output scaling properties\n-\n- This event contains scaling geometry information that is not in\n- the geometry event. It may be sent after binding the output\n- object or if the output scale changes later. The compositor will\n- emit a non-zero, positive value for scale. If it is not sent,\n- the client should assume a scale of 1.\n-\n- A scale larger than 1 means that the compositor will\n- automatically scale surface buffers by this amount when\n- rendering. This is used for very high resolution displays where\n- applications rendering at the native resolution would be too\n- small to be legible.\n-\n- Clients should use \"WlSurface.preferred_buffer_scale()\" instead\n- of this event to find the preferred buffer scale to use for a\n- surface.\n-\n- The scale event will be followed by a done event.\n-\n- Parameters:\n- **factor** (*ArgumentType.Int*) -- scaling factor of output\n-\n- name(name: 'str') -> 'None'\n-\n- -[ Event -- opcode 4 (attached to \"Proxy\" instance) ]-\n-\n- Name of this output\n-\n- Many compositors will assign user-friendly names to their\n- outputs, show them to the user, allow the user to refer to an\n- output, etc. The client may wish to know this name as well to\n- offer the user similar behaviors.\n-\n- The name is a UTF-8 string with no convention defined for its\n- contents. Each name is unique among all \"WlOutput\" globals. The\n- name is only guaranteed to be unique for the compositor\n- instance.\n-\n- The same output name is used for all clients for a given\n- \"WlOutput\" global. Thus, the name can be shared across processes\n- to refer to a specific \"WlOutput\" global.\n-\n- The name is not guaranteed to be persistent across sessions,\n- thus cannot be used to reliably identify an output in e.g.\n- configuration files.\n-\n- Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc.\n- However, do not assume that the name is a reflection of an\n- underlying DRM connector, X11 connection, etc.\n-\n- The name event is sent after binding the output object. This\n- event is only sent once per output object, and the name does not\n- change over the lifetime of the \"WlOutput\" global.\n-\n- Compositors may re-use the same output name if the \"WlOutput\"\n- global is destroyed and re-created later. Compositors should\n- avoid re- using the same name if possible.\n-\n- The name event will be followed by a done event.\n-\n- Parameters:\n- **name** (*ArgumentType.String*) -- output name\n-\n- description(description: 'str') -> 'None'\n-\n- -[ Event -- opcode 5 (attached to \"Proxy\" instance) ]-\n-\n- Human-readable description of this output\n-\n- Many compositors can produce human-readable descriptions of\n- their outputs. The client may wish to know this description as\n- well, e.g. for output selection purposes.\n-\n- The description is a UTF-8 string with no convention defined for\n- its contents. The description is not guaranteed to be unique\n- among all \"WlOutput\" globals. Examples might include 'Foocorp\n- 11\" Display' or 'Virtual X11 output via :1'.\n-\n- The description event is sent after binding the output object\n- and whenever the description changes. The description is\n- optional, and may not be sent at all.\n-\n- The description event will be followed by a done event.\n-\n- Parameters:\n- **description** (*ArgumentType.String*) -- output description\n-\n-\n-WlBuffer\n-========\n-\n-class pywayland.protocol.wayland.WlBuffer\n-\n- Content for a \"WlSurface\"\n-\n- A buffer provides the content for a \"WlSurface\". Buffers are\n- created through factory interfaces such as \"WlShm\",\n- wp_linux_buffer_params (from the linux-dmabuf protocol extension)\n- or similar. It has a width and a height and can be attached to a\n- \"WlSurface\", but the mechanism by which a client provides and\n- updates the contents is defined by the buffer factory interface.\n-\n- Color channels are assumed to be electrical rather than optical (in\n- other words, encoded with a transfer function) unless otherwise\n- specified. If the buffer uses a format that has an alpha channel,\n- the alpha channel is assumed to be premultiplied into the\n- electrical color channel values (after transfer function encoding)\n- unless otherwise specified.\n-\n- Note, because \"WlBuffer\" objects are created from multiple\n- independent factory interfaces, the \"WlBuffer\" interface is frozen\n- at version 1.\n-\n- destroy() -> 'None'\n-\n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n-\n- Destroy a buffer\n-\n- Destroy a buffer. If and how you need to release the backing\n- storage is defined by the buffer factory interface.\n-\n- For possible side-effects to a surface, see\n- \"WlSurface.attach()\".\n-\n- release() -> 'None'\n-\n- -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n-\n- Compositor releases buffer\n-\n- Sent when this \"WlBuffer\" is no longer used by the compositor.\n- The client is now free to reuse or destroy this buffer and its\n- backing storage.\n-\n- If a client receives a release event before the frame callback\n- requested in the same \"WlSurface.commit()\" that attaches this\n- \"WlBuffer\" to a surface, then the client is immediately free to\n- reuse the buffer and its backing storage, and does not need a\n- second buffer for the next surface content update. Typically\n- this is possible, when the compositor maintains a copy of the\n- \"WlSurface\" contents, e.g. as a GL texture. This is an important\n- optimization for GL(ES) compositors with \"WlShm\" clients.\n-\n-\n-WlSeat\n-======\n-\n-class pywayland.protocol.wayland.WlSeat\n-\n- Group of input devices\n-\n- A seat is a group of keyboards, pointer and touch devices. This\n- object is published as a global during start up, or when such a\n- device is hot plugged. A seat typically has a pointer and\n- maintains a keyboard focus and a pointer focus.\n-\n- get_pointer() -> 'Proxy[WlPointer]'\n-\n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n-\n- Return pointer object\n-\n- The ID provided will be initialized to the \"WlPointer\" interface\n- for this seat.\n-\n- This request only takes effect if the seat has the pointer\n- capability, or has had the pointer capability in the past. It is\n- a protocol violation to issue this request on a seat that has\n- never had the pointer capability. The missing_capability error\n- will be sent in this case.\n-\n- Returns:\n- \"WlPointer\" -- seat pointer\n-\n- get_keyboard() -> 'Proxy[WlKeyboard]'\n-\n- -[ Request -- opcode 1 (attached to \"Resource\" instance) ]-\n-\n- Return keyboard object\n-\n- The ID provided will be initialized to the \"WlKeyboard\"\n- interface for this seat.\n-\n- This request only takes effect if the seat has the keyboard\n- capability, or has had the keyboard capability in the past. It\n- is a protocol violation to issue this request on a seat that has\n- never had the keyboard capability. The missing_capability error\n- will be sent in this case.\n-\n- Returns:\n- \"WlKeyboard\" -- seat keyboard\n-\n- get_touch() -> 'Proxy[WlTouch]'\n-\n- -[ Request -- opcode 2 (attached to \"Resource\" instance) ]-\n-\n- Return touch object\n-\n- The ID provided will be initialized to the \"WlTouch\" interface\n- for this seat.\n-\n- This request only takes effect if the seat has the touch\n- capability, or has had the touch capability in the past. It is a\n- protocol violation to issue this request on a seat that has\n- never had the touch capability. The missing_capability error\n- will be sent in this case.\n-\n- Returns:\n- \"WlTouch\" -- seat touch interface\n-\n- release() -> 'None'\n-\n- -[ Request -- opcode 3 (attached to \"Resource\" instance) ]-\n-\n- Release the seat object\n-\n- Using this request a client can tell the server that it is not\n- going to use the seat object anymore.\n-\n- capabilities(capabilities: 'int') -> 'None'\n-\n- -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n-\n- Seat capabilities changed\n-\n- This is emitted whenever a seat gains or loses the pointer,\n- keyboard or touch capabilities. The argument is a capability\n- enum containing the complete set of capabilities this seat has.\n-\n- When the pointer capability is added, a client may create a\n- \"WlPointer\" object using the \"WlSeat.get_pointer()\" request.\n- This object will receive pointer events until the capability is\n- removed in the future.\n-\n- When the pointer capability is removed, a client should destroy\n- the \"WlPointer\" objects associated with the seat where the\n- capability was removed, using the \"WlPointer.release()\" request.\n- No further pointer events will be received on these objects.\n-\n- In some compositors, if a seat regains the pointer capability\n- and a client has a previously obtained \"WlPointer\" object of\n- version 4 or less, that object may start sending pointer events\n- again. This behavior is considered a misinterpretation of the\n- intended behavior and must not be relied upon by the client.\n- \"WlPointer\" objects of version 5 or later must not send events\n- if created before the most recent event notifying the client of\n- an added pointer capability.\n-\n- The above behavior also applies to \"WlKeyboard\" and \"WlTouch\"\n- with the keyboard and touch capabilities, respectively.\n-\n- Parameters:\n- **capabilities** (*ArgumentType.Uint*) -- capabilities of the\n- seat\n-\n- name(name: 'str') -> 'None'\n-\n- -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n-\n- Unique identifier for this seat\n-\n- In a multi-seat configuration the seat name can be used by\n- clients to help identify which physical devices the seat\n- represents.\n-\n- The seat name is a UTF-8 string with no convention defined for\n- its contents. Each name is unique among all \"WlSeat\" globals.\n- The name is only guaranteed to be unique for the current\n- compositor instance.\n-\n- The same seat names are used for all clients. Thus, the name can\n- be shared across processes to refer to a specific \"WlSeat\"\n- global.\n-\n- The name event is sent after binding to the seat global. This\n- event is only sent once per seat object, and the name does not\n- change over the lifetime of the \"WlSeat\" global.\n-\n- Compositors may re-use the same seat name if the \"WlSeat\" global\n- is destroyed and re-created later.\n-\n- Parameters:\n- **name** (*ArgumentType.String*) -- seat identifier\n-\n-\n-WlRegistry\n-==========\n-\n-class pywayland.protocol.wayland.WlRegistry\n-\n- Global registry object\n-\n- The singleton global registry object. The server has a number of\n- global objects that are available to all clients. These objects\n- typically represent an actual object in the server (for example, an\n- input device) or they are singleton objects that provide extension\n- functionality.\n-\n- When a client creates a registry object, the registry object will\n- emit a global event for each global currently in the registry.\n- Globals come and go as a result of device or monitor hotplugs,\n- reconfiguration or other events, and the registry will send out\n- global and global_remove events to keep the client up to date with\n- the changes. To mark the end of the initial burst of events, the\n- client can use the \"WlDisplay.sync()\" request immediately after\n- calling \"WlDisplay.get_registry()\".\n-\n- A client can bind to a global object by using the bind request.\n- This creates a client-side handle that lets the object emit events\n- to the client and lets the client invoke requests on the object.\n-\n- bind(name: 'int', interface: 'type[T]', version: 'int') -> 'Proxy[T]'\n-\n- -[ Request -- opcode 0 (attached to \"Resource\" instance) ]-\n-\n- Bind an object to the display\n-\n- Binds a new, client-created object to the server using the\n- specified name as the identifier.\n-\n- Parameters:\n- * **name** (*ArgumentType.Uint*) -- unique numeric name of\n- the object\n-\n- * **interface** (*string*) -- Interface name\n-\n- * **version** (*int*) -- Interface version\n-\n- Returns:\n- \"pywayland.client.proxy.Proxy\" of specified Interface --\n- bounded object\n-\n- global_(name: 'int', interface: 'str', version: 'int') -> 'None'\n-\n- -[ Event -- opcode 0 (attached to \"Proxy\" instance) ]-\n-\n- Announce global object\n-\n- Notify the client of global objects.\n-\n- The event notifies the client that a global object with the\n- given name is now available, and it implements the given version\n- of the given interface.\n-\n- Parameters:\n- * **name** (*ArgumentType.Uint*) -- numeric name of the\n- global object\n-\n- * **interface** (*ArgumentType.String*) -- interface\n- implemented by the object\n-\n- * **version** (*ArgumentType.Uint*) -- interface version\n-\n- global_remove(name: 'int') -> 'None'\n-\n- -[ Event -- opcode 1 (attached to \"Proxy\" instance) ]-\n-\n- Announce removal of global object\n-\n- Notify the client of removed global objects.\n-\n- This event notifies the client that the global identified by\n- name is no longer available. If the client bound to the global\n- using the bind request, the client should now destroy that\n- object.\n-\n- The object remains valid and requests to the object will be\n- ignored until the client destroys it, to avoid races between the\n- global going away and a client sending a request to it.\n-\n- Parameters:\n- **name** (*ArgumentType.Uint*) -- numeric name of the global\n- object\n"}]}]}]}]}, {"source1": "python3-pywayland_0.4.18-1_amd64.deb", "source2": "python3-pywayland_0.4.18-1_amd64.deb", "unified_diff": null, "details": [{"source1": "file list", "source2": "file list", "unified_diff": "@@ -1,3 +1,3 @@\n -rw-r--r-- 0 0 0 4 2024-10-11 20:38:19.000000 debian-binary\n -rw-r--r-- 0 0 0 2920 2024-10-11 20:38:19.000000 control.tar.xz\n--rw-r--r-- 0 0 0 117120 2024-10-11 20:38:19.000000 data.tar.xz\n+-rw-r--r-- 0 0 0 117540 2024-10-11 20:38:19.000000 data.tar.xz\n"}, {"source1": "control.tar.xz", "source2": "control.tar.xz", "unified_diff": null, "details": [{"source1": "control.tar", "source2": "control.tar", "unified_diff": null, "details": [{"source1": "./control", "source2": "./control", "unified_diff": "@@ -1,13 +1,13 @@\n Package: python3-pywayland\n Source: pywayland\n Version: 0.4.18-1\n Architecture: amd64\n Maintainer: Daniel Echeverri \n-Installed-Size: 545\n+Installed-Size: 546\n Depends: python3 (>= 3~), python3:any, libc6 (>= 2.28), libwayland-client0 (>= 1.5.91), libwayland-server0 (>= 1.14.91)\n Suggests: python3-pywayland-doc\n Section: python\n Priority: optional\n Homepage: https://github.com/flacjacket/pywayland\n Description: Provides Python bindings to the Wayland library\n PyWayland provides a wrapper to the libwayland library using\n"}, {"source1": "./md5sums", "source2": "./md5sums", "unified_diff": null, "details": [{"source1": "./md5sums", "source2": "./md5sums", "comments": ["Files differ"], "unified_diff": null}]}]}]}, {"source1": "data.tar.xz", "source2": "data.tar.xz", "unified_diff": null, "details": [{"source1": "data.tar", "source2": "data.tar", "unified_diff": null, "details": [{"source1": "file list", "source2": "file list", "unified_diff": "@@ -88,8 +88,8 @@\n -rw-r--r-- 0 root (0) root (0) 170 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/changelog.Debian.gz\n -rw-r--r-- 0 root (0) root (0) 4446 2024-10-11 20:38:19.000000 ./usr/share/doc/python3-pywayland/copyright\n drwxr-xr-x 0 root (0) root (0) 0 2024-10-11 20:38:19.000000 ./usr/share/lintian/\n drwxr-xr-x 0 root (0) root (0) 0 2024-10-11 20:38:19.000000 ./usr/share/lintian/overrides/\n -rw-r--r-- 0 root (0) root (0) 170 2024-10-11 20:38:19.000000 ./usr/share/lintian/overrides/python3-pywayland\n drwxr-xr-x 0 root (0) root (0) 0 2024-10-11 20:38:19.000000 ./usr/share/man/\n drwxr-xr-x 0 root (0) root (0) 0 2024-10-11 20:38:19.000000 ./usr/share/man/man1/\n--rw-r--r-- 0 root (0) root (0) 40628 2024-10-11 20:38:19.000000 ./usr/share/man/man1/pywayland-scanner.1.gz\n+-rw-r--r-- 0 root (0) root (0) 41017 2024-10-11 20:38:19.000000 ./usr/share/man/man1/pywayland-scanner.1.gz\n"}, {"source1": "./usr/share/man/man1/pywayland-scanner.1.gz", "source2": "./usr/share/man/man1/pywayland-scanner.1.gz", "unified_diff": null, "details": [{"source1": "pywayland-scanner.1", "source2": "pywayland-scanner.1", "comments": ["Ordering differences only"], "unified_diff": "@@ -1095,93 +1095,569 @@\n .TP\n .B class pywayland.protocol_core.argument.ArgumentType(value, names=, *values, module=None, qualname=None, type=None, start=1, boundary=None)\n .UNINDENT\n .SS Protocol Modules\n .sp\n Wayland protocols built against Wayland 1.21.0 and Wayland Protocols 1.25.\n .SS wayland Module\n-.SS WlCallback\n+.SS WlDataDevice\n .INDENT 0.0\n .TP\n-.B class pywayland.protocol.wayland.WlCallback\n-Callback object\n+.B class pywayland.protocol.wayland.WlDataDevice\n+Data transfer device\n .sp\n-Clients can handle the \\(aqdone\\(aq event to get notified when the related\n-request is done.\n+There is one \\fI\\%WlDataDevice\\fP per seat which can be obtained from the\n+global \\fI\\%WlDataDeviceManager\\fP singleton.\n .sp\n-Note, because \\fI\\%WlCallback\\fP objects are created from multiple\n-independent factory interfaces, the \\fI\\%WlCallback\\fP interface is frozen\n-at version 1.\n+A \\fI\\%WlDataDevice\\fP provides access to inter\\-client data transfer\n+mechanisms such as copy\\-and\\-paste and drag\\-and\\-drop.\n .INDENT 7.0\n .TP\n-.B done(callback_data: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.B start_drag(source: \\(aqWlDataSource | None\\(aq, origin: \\(aqWlSurface\\(aq, icon: \\(aqWlSurface | None\\(aq, serial: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n+.sp\n+Start drag\\-and\\-drop operation\n+.sp\n+This request asks the compositor to start a drag\\-and\\-drop operation on\n+behalf of the client.\n+.sp\n+The source argument is the data source that provides the data for the\n+eventual data transfer. If source is NULL, enter, leave and motion\n+events are sent only to the client that initiated the drag and the\n+client is expected to handle the data passing internally. If source is\n+destroyed, the drag\\-and\\-drop session will be cancelled.\n+.sp\n+The origin surface is the surface where the drag originates and the\n+client must have an active implicit grab that matches the serial.\n+.sp\n+The icon surface is an optional (can be NULL) surface that provides an\n+icon to be moved around with the cursor. Initially, the top\\-left\n+corner of the icon surface is placed at the cursor hotspot, but\n+subsequent \\fI\\%WlSurface.offset()\\fP requests can move the\n+relative position. Attach requests must be confirmed with\n+\\fI\\%WlSurface.commit()\\fP as usual. The icon\n+surface is given the role of a drag\\-and\\-drop icon. If the icon surface\n+already has another role, it raises a protocol error.\n+.sp\n+The input region is ignored for wl_surfaces with the role of a drag\\-\n+and\\-drop icon.\n+.sp\n+The given source may not be used in any further set_selection or\n+start_drag requests. Attempting to reuse a previously\\-used source may\n+send a used_source error.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBsource\\fP (\\fI\\%WlDataSource\\fP or \\fINone\\fP) \\-\\- data source for the eventual transfer\n+.IP \\(bu 2\n+\\fBorigin\\fP (\\fI\\%WlSurface\\fP) \\-\\- surface where the drag originates\n+.IP \\(bu 2\n+\\fBicon\\fP (\\fI\\%WlSurface\\fP or \\fINone\\fP) \\-\\- drag\\-and\\-drop icon surface\n+.IP \\(bu 2\n+\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the implicit grab on the origin\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B set_selection(source: \\(aqWlDataSource | None\\(aq, serial: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n+.sp\n+Copy data to the selection\n+.sp\n+This request asks the compositor to set the selection to the data from\n+the source on behalf of the client.\n+.sp\n+To unset the selection, set the source to NULL.\n+.sp\n+The given source may not be used in any further set_selection or\n+start_drag requests. Attempting to reuse a previously\\-used source may\n+send a used_source error.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBsource\\fP (\\fI\\%WlDataSource\\fP or \\fINone\\fP) \\-\\- data source for the selection\n+.IP \\(bu 2\n+\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the event that triggered this request\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B release() -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 2 (attached to \\fBResource\\fP instance)\n+.sp\n+Destroy data device\n+.sp\n+This request destroys the data device.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B data_offer(id: \\(aqWlDataOffer\\(aq) -> \\(aqNone\\(aq\n .sp\n Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n .sp\n-Done event\n+Introduce a new \\fI\\%WlDataOffer\\fP\n .sp\n-Notify the client when the related request is done.\n+The data_offer event introduces a new\n+\\fI\\%WlDataOffer\\fP object, which will\n+subsequently be used in either the data_device.enter event (for drag\\-\n+and\\-drop) or the data_device.selection event (for selections).\n+Immediately following the data_device.data_offer event, the new\n+data_offer object will send out data_offer.offer events to describe the\n+mime types it offers.\n .INDENT 7.0\n .TP\n .B Parameters\n-\\fBcallback_data\\fP (\\fIArgumentType.Uint\\fP) \\-\\- request\\-specific data for the callback\n+\\fBid\\fP (\\fI\\%WlDataOffer\\fP) \\-\\- the new data_offer object\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B enter(serial: \\(aqint\\(aq, surface: \\(aqWlSurface\\(aq, x: \\(aqfloat\\(aq, y: \\(aqfloat\\(aq, id: \\(aqWlDataOffer | None\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n+.sp\n+Initiate drag\\-and\\-drop session\n+.sp\n+This event is sent when an active drag\\-and\\-drop pointer enters a\n+surface owned by the client. The position of the pointer at enter time\n+is provided by the x and y arguments, in surface\\-local coordinates.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the enter event\n+.IP \\(bu 2\n+\\fBsurface\\fP (\\fI\\%WlSurface\\fP) \\-\\- client surface entered\n+.IP \\(bu 2\n+\\fBx\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local x coordinate\n+.IP \\(bu 2\n+\\fBy\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local y coordinate\n+.IP \\(bu 2\n+\\fBid\\fP (\\fI\\%WlDataOffer\\fP or \\fINone\\fP) \\-\\- source data_offer object\n .UNINDENT\n .UNINDENT\n .UNINDENT\n-.SS WlDataDeviceManager\n+.INDENT 7.0\n+.TP\n+.B leave() -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 2 (attached to \\fBProxy\\fP instance)\n+.sp\n+End drag\\-and\\-drop session\n+.sp\n+This event is sent when the drag\\-and\\-drop pointer leaves the surface\n+and the session ends. The client must destroy the\n+\\fI\\%WlDataOffer\\fP introduced at enter\n+time at this point.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B motion(time: \\(aqint\\(aq, x: \\(aqfloat\\(aq, y: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n+.sp\n+Drag\\-and\\-drop session motion\n+.sp\n+This event is sent when the drag\\-and\\-drop pointer moves within the\n+currently focused surface. The new position of the pointer is provided\n+by the x and y arguments, in surface\\-local coordinates.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n+.IP \\(bu 2\n+\\fBx\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local x coordinate\n+.IP \\(bu 2\n+\\fBy\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local y coordinate\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B drop() -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n+.sp\n+End drag\\-and\\-drop session successfully\n+.sp\n+The event is sent when a drag\\-and\\-drop operation is ended because the\n+implicit grab is removed.\n+.sp\n+The drag\\-and\\-drop destination is expected to honor the last action\n+received through \\fI\\%WlDataOffer.action()\\fP, if the resulting\n+action is \\(dqcopy\\(dq or \\(dqmove\\(dq, the destination can still perform\n+\\fI\\%WlDataOffer.receive()\\fP requests, and is\n+expected to end all transfers with a \\fI\\%WlDataOffer.finish()\\fP request.\n+.sp\n+If the resulting action is \\(dqask\\(dq, the action will not be considered\n+final. The drag\\-and\\-drop destination is expected to perform one last\n+\\fI\\%WlDataOffer.set_actions()\\fP request, or\n+\\fI\\%WlDataOffer.destroy()\\fP in order to cancel\n+the operation.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B selection(id: \\(aqWlDataOffer | None\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n+.sp\n+Advertise new selection\n+.sp\n+The selection event is sent out to notify the client of a new\n+\\fI\\%WlDataOffer\\fP for the selection for\n+this device. The data_device.data_offer and the data_offer.offer\n+events are sent out immediately before this event to introduce the data\n+offer object. The selection event is sent to a client immediately\n+before receiving keyboard focus and when a new selection is set while\n+the client has keyboard focus. The data_offer is valid until a new\n+data_offer or NULL is received or until the client loses keyboard\n+focus. Switching surface with keyboard focus within the same client\n+doesn\\(aqt mean a new selection will be sent. The client must destroy the\n+previous selection data_offer, if any, upon receiving this event.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBid\\fP (\\fI\\%WlDataOffer\\fP or \\fINone\\fP) \\-\\- selection data_offer object\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.SS WlTouch\n .INDENT 0.0\n .TP\n-.B class pywayland.protocol.wayland.WlDataDeviceManager\n-Data transfer interface\n+.B class pywayland.protocol.wayland.WlTouch\n+Touchscreen input device\n .sp\n-The \\fI\\%WlDataDeviceManager\\fP is a singleton global object that provides\n-access to inter\\-client data transfer mechanisms such as copy\\-and\\-paste and\n-drag\\-and\\-drop. These mechanisms are tied to a\n-\\fI\\%WlSeat\\fP and this interface lets a\n-client get a \\fI\\%WlDataDevice\\fP\n-corresponding to a \\fI\\%WlSeat\\fP\\&.\n+The \\fI\\%WlTouch\\fP interface represents a touchscreen associated with a\n+seat.\n .sp\n-Depending on the version bound, the objects created from the bound\n-\\fI\\%WlDataDeviceManager\\fP object will have different requirements for\n-functioning properly. See \\fI\\%WlDataSource.set_actions()\\fP,\n-\\fI\\%WlDataOffer.accept()\\fP and\n-\\fI\\%WlDataOffer.finish()\\fP for details.\n+Touch interactions can consist of one or more contacts. For each contact, a\n+series of events is generated, starting with a down event, followed by zero\n+or more motion events, and ending with an up event. Events relating to the\n+same contact point can be identified by the ID of the sequence.\n .INDENT 7.0\n .TP\n-.B create_data_source() -> \\(aqProxy[WlDataSource]\\(aq\n+.B release() -> \\(aqNone\\(aq\n .sp\n Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n .sp\n-Create a new data source\n+Release the touch object\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B down(serial: \\(aqint\\(aq, time: \\(aqint\\(aq, surface: \\(aqWlSurface\\(aq, id: \\(aqint\\(aq, x: \\(aqfloat\\(aq, y: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n .sp\n-Create a new data source.\n+Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n+.sp\n+Touch down event and beginning of a touch sequence\n+.sp\n+A new touch point has appeared on the surface. This touch point is\n+assigned a unique ID. Future events from this touch point reference\n+this ID. The ID ceases to be valid after a touch up event and may be\n+reused in the future.\n .INDENT 7.0\n .TP\n-.B Returns\n-\\fI\\%WlDataSource\\fP \\-\\- data source to\n-create\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the touch down event\n+.IP \\(bu 2\n+\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n+.IP \\(bu 2\n+\\fBsurface\\fP (\\fI\\%WlSurface\\fP) \\-\\- surface touched\n+.IP \\(bu 2\n+\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n+.IP \\(bu 2\n+\\fBx\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local x coordinate\n+.IP \\(bu 2\n+\\fBy\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local y coordinate\n+.UNINDENT\n .UNINDENT\n .UNINDENT\n .INDENT 7.0\n .TP\n-.B get_data_device(seat: \\(aqWlSeat\\(aq) -> \\(aqProxy[WlDataDevice]\\(aq\n+.B up(serial: \\(aqint\\(aq, time: \\(aqint\\(aq, id: \\(aqint\\(aq) -> \\(aqNone\\(aq\n .sp\n-Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n+Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n .sp\n-Create a new data device\n+End of a touch event sequence\n .sp\n-Create a new data device for a given seat.\n+The touch point has disappeared. No further events will be sent for\n+this touch point and the touch point\\(aqs ID is released and may be reused\n+in a future touch down event.\n .INDENT 7.0\n .TP\n .B Parameters\n-\\fBseat\\fP (\\fI\\%WlSeat\\fP) \\-\\- seat associated with the data device\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the touch up event\n+.IP \\(bu 2\n+\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n+.IP \\(bu 2\n+\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B motion(time: \\(aqint\\(aq, id: \\(aqint\\(aq, x: \\(aqfloat\\(aq, y: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 2 (attached to \\fBProxy\\fP instance)\n+.sp\n+Update of touch point coordinates\n+.sp\n+A touch point has changed coordinates.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n+.IP \\(bu 2\n+\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n+.IP \\(bu 2\n+\\fBx\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local x coordinate\n+.IP \\(bu 2\n+\\fBy\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local y coordinate\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B frame() -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n+.sp\n+End of touch frame event\n+.sp\n+Indicates the end of a set of events that logically belong together. A\n+client is expected to accumulate the data in all events within the\n+frame before proceeding.\n+.sp\n+A \\fI\\%WlTouch.frame()\\fP terminates at least one event but otherwise\n+no guarantee is provided about the set of events within a frame. A\n+client must assume that any state not updated in a frame is unchanged\n+from the previously known state.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B cancel() -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n+.sp\n+Touch session cancelled\n+.sp\n+Sent if the compositor decides the touch stream is a global gesture. No\n+further events are sent to the clients from that particular gesture.\n+Touch cancellation applies to all touch points currently active on this\n+client\\(aqs surface. The client is responsible for finalizing the touch\n+points, future touch points on this surface may reuse the touch point\n+ID.\n+.sp\n+No frame event is required after the cancel event.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B shape(id: \\(aqint\\(aq, major: \\(aqfloat\\(aq, minor: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n+.sp\n+Update shape of touch point\n+.sp\n+Sent when a touchpoint has changed its shape.\n+.sp\n+This event does not occur on its own. It is sent before a\n+\\fI\\%WlTouch.frame()\\fP event and carries the new shape information for\n+any previously reported, or new touch points of that frame.\n+.sp\n+Other events describing the touch point such as \\fI\\%WlTouch.down()\\fP,\n+\\fI\\%WlTouch.motion()\\fP or \\fI\\%WlTouch.orientation()\\fP may be sent\n+within the same \\fI\\%WlTouch.frame()\\fP\\&. A client should treat these\n+events as a single logical touch point update. The order of\n+\\fI\\%WlTouch.shape()\\fP, \\fI\\%WlTouch.orientation()\\fP and\n+\\fI\\%WlTouch.motion()\\fP is not guaranteed. A \\fI\\%WlTouch.down()\\fP\n+event is guaranteed to occur before the first \\fI\\%WlTouch.shape()\\fP\n+event for this touch ID but both events may occur within the same\n+\\fI\\%WlTouch.frame()\\fP\\&.\n+.sp\n+A touchpoint shape is approximated by an ellipse through the major and\n+minor axis length. The major axis length describes the longer diameter\n+of the ellipse, while the minor axis length describes the shorter\n+diameter. Major and minor are orthogonal and both are specified in\n+surface\\-local coordinates. The center of the ellipse is always at the\n+touchpoint location as reported by \\fI\\%WlTouch.down()\\fP or\n+\\fBWlTouch.move()\\fP\\&.\n+.sp\n+This event is only sent by the compositor if the touch device supports\n+shape reports. The client has to make reasonable assumptions about the\n+shape if it did not receive this event.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n+.IP \\(bu 2\n+\\fBmajor\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- length of the major axis in surface\\-local coordinates\n+.IP \\(bu 2\n+\\fBminor\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- length of the minor axis in surface\\-local coordinates\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B orientation(id: \\(aqint\\(aq, orientation: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 6 (attached to \\fBProxy\\fP instance)\n+.sp\n+Update orientation of touch point\n+.sp\n+Sent when a touchpoint has changed its orientation.\n+.sp\n+This event does not occur on its own. It is sent before a\n+\\fI\\%WlTouch.frame()\\fP event and carries the new shape information for\n+any previously reported, or new touch points of that frame.\n+.sp\n+Other events describing the touch point such as \\fI\\%WlTouch.down()\\fP,\n+\\fI\\%WlTouch.motion()\\fP or \\fI\\%WlTouch.shape()\\fP may be sent within\n+the same \\fI\\%WlTouch.frame()\\fP\\&. A client should treat these events as\n+a single logical touch point update. The order of\n+\\fI\\%WlTouch.shape()\\fP, \\fI\\%WlTouch.orientation()\\fP and\n+\\fI\\%WlTouch.motion()\\fP is not guaranteed. A \\fI\\%WlTouch.down()\\fP\n+event is guaranteed to occur before the first\n+\\fI\\%WlTouch.orientation()\\fP event for this touch ID but both events\n+may occur within the same \\fI\\%WlTouch.frame()\\fP\\&.\n+.sp\n+The orientation describes the clockwise angle of a touchpoint\\(aqs major\n+axis to the positive surface y\\-axis and is normalized to the \\-180 to\n++180 degree range. The granularity of orientation depends on the touch\n+device, some devices only support binary rotation values between 0 and\n+90 degrees.\n+.sp\n+This event is only sent by the compositor if the touch device supports\n+orientation reports.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n+.IP \\(bu 2\n+\\fBorientation\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- angle between major axis and positive surface y\\-axis in degrees\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.SS WlRegistry\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlRegistry\n+Global registry object\n+.sp\n+The singleton global registry object. The server has a number of global\n+objects that are available to all clients. These objects typically\n+represent an actual object in the server (for example, an input device) or\n+they are singleton objects that provide extension functionality.\n+.sp\n+When a client creates a registry object, the registry object will emit a\n+global event for each global currently in the registry. Globals come and\n+go as a result of device or monitor hotplugs, reconfiguration or other\n+events, and the registry will send out global and global_remove events to\n+keep the client up to date with the changes. To mark the end of the\n+initial burst of events, the client can use the \\fI\\%WlDisplay.sync()\\fP request immediately after\n+calling \\fI\\%WlDisplay.get_registry()\\fP\\&.\n+.sp\n+A client can bind to a global object by using the bind request. This\n+creates a client\\-side handle that lets the object emit events to the client\n+and lets the client invoke requests on the object.\n+.INDENT 7.0\n+.TP\n+.B bind(name: \\(aqint\\(aq, interface: \\(aqtype[T]\\(aq, version: \\(aqint\\(aq) -> \\(aqProxy[T]\\(aq\n+.sp\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n+.sp\n+Bind an object to the display\n+.sp\n+Binds a new, client\\-created object to the server using the specified\n+name as the identifier.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBname\\fP (\\fIArgumentType.Uint\\fP) \\-\\- unique numeric name of the object\n+.IP \\(bu 2\n+\\fBinterface\\fP (\\fIstring\\fP) \\-\\- Interface name\n+.IP \\(bu 2\n+\\fBversion\\fP (\\fIint\\fP) \\-\\- Interface version\n+.UNINDENT\n .TP\n .B Returns\n-\\fI\\%WlDataDevice\\fP \\-\\- data device to\n-create\n+\\fBpywayland.client.proxy.Proxy\\fP of specified Interface \\-\\-\n+bounded object\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B global_(name: \\(aqint\\(aq, interface: \\(aqstr\\(aq, version: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n+.sp\n+Announce global object\n+.sp\n+Notify the client of global objects.\n+.sp\n+The event notifies the client that a global object with the given name\n+is now available, and it implements the given version of the given\n+interface.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBname\\fP (\\fIArgumentType.Uint\\fP) \\-\\- numeric name of the global object\n+.IP \\(bu 2\n+\\fBinterface\\fP (\\fIArgumentType.String\\fP) \\-\\- interface implemented by the object\n+.IP \\(bu 2\n+\\fBversion\\fP (\\fIArgumentType.Uint\\fP) \\-\\- interface version\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B global_remove(name: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n+.sp\n+Announce removal of global object\n+.sp\n+Notify the client of removed global objects.\n+.sp\n+This event notifies the client that the global identified by name is no\n+longer available. If the client bound to the global using the bind\n+request, the client should now destroy that object.\n+.sp\n+The object remains valid and requests to the object will be ignored\n+until the client destroys it, to avoid races between the global going\n+away and a client sending a request to it.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBname\\fP (\\fIArgumentType.Uint\\fP) \\-\\- numeric name of the global object\n .UNINDENT\n .UNINDENT\n .UNINDENT\n .SS WlSubcompositor\n .INDENT 0.0\n .TP\n .B class pywayland.protocol.wayland.WlSubcompositor\n@@ -1259,14 +1735,85 @@\n .TP\n .B Returns\n \\fI\\%WlSubsurface\\fP \\-\\- the new sub\\-\n surface object ID\n .UNINDENT\n .UNINDENT\n .UNINDENT\n+.SS WlShm\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlShm\n+Shared memory support\n+.sp\n+A singleton global object that provides support for shared memory.\n+.sp\n+Clients can create \\fI\\%WlShmPool\\fP objects\n+using the create_pool request.\n+.sp\n+On binding the \\fI\\%WlShm\\fP object one or more format events are emitted\n+to inform clients about the valid pixel formats that can be used for\n+buffers.\n+.INDENT 7.0\n+.TP\n+.B create_pool(fd: \\(aqint\\(aq, size: \\(aqint\\(aq) -> \\(aqProxy[WlShmPool]\\(aq\n+.sp\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n+.sp\n+Create a shm pool\n+.sp\n+Create a new \\fI\\%WlShmPool\\fP object.\n+.sp\n+The pool can be used to create shared memory based buffer objects. The\n+server will mmap size bytes of the passed file descriptor, to use as\n+backing memory for the pool.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBfd\\fP (\\fIArgumentType.FileDescriptor\\fP) \\-\\- file descriptor for the pool\n+.IP \\(bu 2\n+\\fBsize\\fP (\\fIArgumentType.Int\\fP) \\-\\- pool size, in bytes\n+.UNINDENT\n+.TP\n+.B Returns\n+\\fI\\%WlShmPool\\fP \\-\\- pool to create\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B release() -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n+.sp\n+Release the shm object\n+.sp\n+Using this request a client can tell the server that it is not going to\n+use the shm object anymore.\n+.sp\n+Objects created via this interface remain unaffected.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B format(format: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n+.sp\n+Pixel format description\n+.sp\n+Informs the client about a valid pixel format that can be used for\n+buffers. Known formats include argb8888 and xrgb8888.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBformat\\fP (\\fIArgumentType.Uint\\fP) \\-\\- buffer pixel format\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n .SS WlShmPool\n .INDENT 0.0\n .TP\n .B class pywayland.protocol.wayland.WlShmPool\n A shared memory pool\n .sp\n The \\fI\\%WlShmPool\\fP object encapsulates a piece of memory shared between\n@@ -1969,292 +2516,688 @@\n .INDENT 7.0\n .TP\n .B Parameters\n \\fBtransform\\fP (\\fIArgumentType.Uint\\fP) \\-\\- preferred transform\n .UNINDENT\n .UNINDENT\n .UNINDENT\n-.SS WlRegion\n+.SS WlOutput\n .INDENT 0.0\n .TP\n-.B class pywayland.protocol.wayland.WlRegion\n-Region interface\n-.sp\n-A region object describes an area.\n+.B class pywayland.protocol.wayland.WlOutput\n+Compositor output region\n .sp\n-Region objects are used to describe the opaque and input regions of a\n-surface.\n+An output describes part of the compositor geometry. The compositor works\n+in the \\(aqcompositor coordinate system\\(aq and an output corresponds to a\n+rectangular area in that space that is actually visible. This typically\n+corresponds to a monitor that displays part of the compositor space. This\n+object is published as global during start up, or when a monitor is\n+hotplugged.\n .INDENT 7.0\n .TP\n-.B destroy() -> \\(aqNone\\(aq\n+.B release() -> \\(aqNone\\(aq\n .sp\n Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n .sp\n-Destroy region\n+Release the output object\n .sp\n-Destroy the region. This will invalidate the object ID.\n+Using this request a client can tell the server that it is not going to\n+use the output object anymore.\n .UNINDENT\n .INDENT 7.0\n .TP\n-.B add(x: \\(aqint\\(aq, y: \\(aqint\\(aq, width: \\(aqint\\(aq, height: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.B geometry(x: \\(aqint\\(aq, y: \\(aqint\\(aq, physical_width: \\(aqint\\(aq, physical_height: \\(aqint\\(aq, subpixel: \\(aqint\\(aq, make: \\(aqstr\\(aq, model: \\(aqstr\\(aq, transform: \\(aqint\\(aq) -> \\(aqNone\\(aq\n .sp\n-Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n+Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n .sp\n-Add rectangle to region\n+Properties of the output\n .sp\n-Add the specified rectangle to the region.\n+The geometry event describes geometric properties of the output. The\n+event is sent when binding to the output object and whenever any of the\n+properties change.\n+.sp\n+The physical size can be set to zero if it doesn\\(aqt make sense for this\n+output (e.g. for projectors or virtual outputs).\n+.sp\n+The geometry event will be followed by a done event (starting from\n+version 2).\n+.sp\n+Clients should use \\fI\\%WlSurface.preferred_buffer_transform()\\fP\n+instead of the transform advertised by this event to find the preferred\n+buffer transform to use for a surface.\n+.sp\n+Note: \\fI\\%WlOutput\\fP only advertises partial information about the\n+output position and identification. Some compositors, for instance\n+those not implementing a desktop\\-style output layout or those exposing\n+virtual outputs, might fake this information. Instead of using x and y,\n+clients should use xdg_output.logical_position. Instead of using make\n+and model, clients should use name and description.\n .INDENT 7.0\n .TP\n .B Parameters\n .INDENT 7.0\n .IP \\(bu 2\n-\\fBx\\fP (\\fIArgumentType.Int\\fP) \\-\\- region\\-local x coordinate\n+\\fBx\\fP (\\fIArgumentType.Int\\fP) \\-\\- x position within the global compositor space\n .IP \\(bu 2\n-\\fBy\\fP (\\fIArgumentType.Int\\fP) \\-\\- region\\-local y coordinate\n+\\fBy\\fP (\\fIArgumentType.Int\\fP) \\-\\- y position within the global compositor space\n .IP \\(bu 2\n-\\fBwidth\\fP (\\fIArgumentType.Int\\fP) \\-\\- rectangle width\n+\\fBphysical_width\\fP (\\fIArgumentType.Int\\fP) \\-\\- width in millimeters of the output\n .IP \\(bu 2\n-\\fBheight\\fP (\\fIArgumentType.Int\\fP) \\-\\- rectangle height\n+\\fBphysical_height\\fP (\\fIArgumentType.Int\\fP) \\-\\- height in millimeters of the output\n+.IP \\(bu 2\n+\\fBsubpixel\\fP (\\fIArgumentType.Int\\fP) \\-\\- subpixel orientation of the output\n+.IP \\(bu 2\n+\\fBmake\\fP (\\fIArgumentType.String\\fP) \\-\\- textual description of the manufacturer\n+.IP \\(bu 2\n+\\fBmodel\\fP (\\fIArgumentType.String\\fP) \\-\\- textual description of the model\n+.IP \\(bu 2\n+\\fBtransform\\fP (\\fIArgumentType.Int\\fP) \\-\\- additional transformation applied to buffer contents during\n+presentation\n .UNINDENT\n .UNINDENT\n .UNINDENT\n .INDENT 7.0\n .TP\n-.B subtract(x: \\(aqint\\(aq, y: \\(aqint\\(aq, width: \\(aqint\\(aq, height: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.B mode(flags: \\(aqint\\(aq, width: \\(aqint\\(aq, height: \\(aqint\\(aq, refresh: \\(aqint\\(aq) -> \\(aqNone\\(aq\n .sp\n-Request \\-\\- opcode 2 (attached to \\fBResource\\fP instance)\n+Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n .sp\n-Subtract rectangle from region\n+Advertise available modes for the output\n .sp\n-Subtract the specified rectangle from the region.\n+The mode event describes an available mode for the output.\n+.sp\n+The event is sent when binding to the output object and there will\n+always be one mode, the current mode. The event is sent again if an\n+output changes mode, for the mode that is now current. In other words,\n+the current mode is always the last mode that was received with the\n+current flag set.\n+.sp\n+Non\\-current modes are deprecated. A compositor can decide to only\n+advertise the current mode and never send other modes. Clients should\n+not rely on non\\-current modes.\n+.sp\n+The size of a mode is given in physical hardware units of the output\n+device. This is not necessarily the same as the output size in the\n+global compositor space. For instance, the output may be scaled, as\n+described in \\fI\\%WlOutput.scale()\\fP, or transformed, as described in\n+\\fBWlOutput.transform()\\fP\\&. Clients willing to retrieve the output\n+size in the global compositor space should use xdg_output.logical_size\n+instead.\n+.sp\n+The vertical refresh rate can be set to zero if it doesn\\(aqt make sense\n+for this output (e.g. for virtual outputs).\n+.sp\n+The mode event will be followed by a done event (starting from version\n+2).\n+.sp\n+Clients should not use the refresh rate to schedule frames. Instead,\n+they should use the \\fI\\%WlSurface.frame()\\fP event or the\n+presentation\\-time protocol.\n+.sp\n+Note: this information is not always meaningful for all outputs. Some\n+compositors, such as those exposing virtual outputs, might fake the\n+refresh rate or the size.\n .INDENT 7.0\n .TP\n .B Parameters\n .INDENT 7.0\n .IP \\(bu 2\n-\\fBx\\fP (\\fIArgumentType.Int\\fP) \\-\\- region\\-local x coordinate\n+\\fBflags\\fP (\\fIArgumentType.Uint\\fP) \\-\\- bitfield of mode flags\n .IP \\(bu 2\n-\\fBy\\fP (\\fIArgumentType.Int\\fP) \\-\\- region\\-local y coordinate\n+\\fBwidth\\fP (\\fIArgumentType.Int\\fP) \\-\\- width of the mode in hardware units\n .IP \\(bu 2\n-\\fBwidth\\fP (\\fIArgumentType.Int\\fP) \\-\\- rectangle width\n+\\fBheight\\fP (\\fIArgumentType.Int\\fP) \\-\\- height of the mode in hardware units\n .IP \\(bu 2\n-\\fBheight\\fP (\\fIArgumentType.Int\\fP) \\-\\- rectangle height\n-.UNINDENT\n+\\fBrefresh\\fP (\\fIArgumentType.Int\\fP) \\-\\- vertical refresh rate in mHz\n .UNINDENT\n .UNINDENT\n .UNINDENT\n-.SS WlDataSource\n-.INDENT 0.0\n+.INDENT 7.0\n .TP\n-.B class pywayland.protocol.wayland.WlDataSource\n-Offer to transfer data\n+.B done() -> \\(aqNone\\(aq\n .sp\n-The \\fI\\%WlDataSource\\fP object is the source side of a\n-\\fI\\%WlDataOffer\\fP\\&. It is created by the\n-source client in a data transfer and provides a way to describe the offered\n-data and a way to respond to requests to transfer the data.\n+Event \\-\\- opcode 2 (attached to \\fBProxy\\fP instance)\n+.sp\n+Sent all information about output\n+.sp\n+This event is sent after all other properties have been sent after\n+binding to the output object and after any other property changes done\n+after that. This allows changes to the output properties to be seen as\n+atomic, even if they happen via multiple events.\n+.UNINDENT\n .INDENT 7.0\n .TP\n-.B offer(mime_type: \\(aqstr\\(aq) -> \\(aqNone\\(aq\n+.B scale(factor: \\(aqint\\(aq) -> \\(aqNone\\(aq\n .sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n+Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n .sp\n-Add an offered mime type\n+Output scaling properties\n .sp\n-This request adds a mime type to the set of mime types advertised to\n-targets. Can be called several times to offer multiple types.\n+This event contains scaling geometry information that is not in the\n+geometry event. It may be sent after binding the output object or if\n+the output scale changes later. The compositor will emit a non\\-zero,\n+positive value for scale. If it is not sent, the client should assume a\n+scale of 1.\n+.sp\n+A scale larger than 1 means that the compositor will automatically\n+scale surface buffers by this amount when rendering. This is used for\n+very high resolution displays where applications rendering at the\n+native resolution would be too small to be legible.\n+.sp\n+Clients should use \\fI\\%WlSurface.preferred_buffer_scale()\\fP instead\n+of this event to find the preferred buffer scale to use for a surface.\n+.sp\n+The scale event will be followed by a done event.\n .INDENT 7.0\n .TP\n .B Parameters\n-\\fBmime_type\\fP (\\fIArgumentType.String\\fP) \\-\\- mime type offered by the data source\n+\\fBfactor\\fP (\\fIArgumentType.Int\\fP) \\-\\- scaling factor of output\n .UNINDENT\n .UNINDENT\n .INDENT 7.0\n .TP\n-.B destroy() -> \\(aqNone\\(aq\n+.B name(name: \\(aqstr\\(aq) -> \\(aqNone\\(aq\n .sp\n-Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n+Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n .sp\n-Destroy the data source\n+Name of this output\n .sp\n-Destroy the data source.\n+Many compositors will assign user\\-friendly names to their outputs, show\n+them to the user, allow the user to refer to an output, etc. The client\n+may wish to know this name as well to offer the user similar behaviors.\n+.sp\n+The name is a UTF\\-8 string with no convention defined for its contents.\n+Each name is unique among all \\fI\\%WlOutput\\fP globals. The name is\n+only guaranteed to be unique for the compositor instance.\n+.sp\n+The same output name is used for all clients for a given\n+\\fI\\%WlOutput\\fP global. Thus, the name can be shared across processes\n+to refer to a specific \\fI\\%WlOutput\\fP global.\n+.sp\n+The name is not guaranteed to be persistent across sessions, thus\n+cannot be used to reliably identify an output in e.g. configuration\n+files.\n+.sp\n+Examples of names include \\(aqHDMI\\-A\\-1\\(aq, \\(aqWL\\-1\\(aq, \\(aqX11\\-1\\(aq, etc. However, do\n+not assume that the name is a reflection of an underlying DRM\n+connector, X11 connection, etc.\n+.sp\n+The name event is sent after binding the output object. This event is\n+only sent once per output object, and the name does not change over the\n+lifetime of the \\fI\\%WlOutput\\fP global.\n+.sp\n+Compositors may re\\-use the same output name if the \\fI\\%WlOutput\\fP\n+global is destroyed and re\\-created later. Compositors should avoid re\\-\n+using the same name if possible.\n+.sp\n+The name event will be followed by a done event.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBname\\fP (\\fIArgumentType.String\\fP) \\-\\- output name\n+.UNINDENT\n .UNINDENT\n .INDENT 7.0\n .TP\n-.B set_actions(dnd_actions: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.B description(description: \\(aqstr\\(aq) -> \\(aqNone\\(aq\n .sp\n-Request \\-\\- opcode 2 (attached to \\fBResource\\fP instance)\n+Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n .sp\n-Set the available drag\\-and\\-drop actions\n+Human\\-readable description of this output\n .sp\n-Sets the actions that the source side client supports for this\n-operation. This request may trigger \\fI\\%WlDataSource.action()\\fP and\n-\\fI\\%WlDataOffer.action()\\fP events if the\n-compositor needs to change the selected action.\n+Many compositors can produce human\\-readable descriptions of their\n+outputs. The client may wish to know this description as well, e.g. for\n+output selection purposes.\n .sp\n-The dnd_actions argument must contain only values expressed in the\n-\\fBWlDataDeviceManager.dnd_actions()\\fP enum,\n-otherwise it will result in a protocol error.\n+The description is a UTF\\-8 string with no convention defined for its\n+contents. The description is not guaranteed to be unique among all\n+\\fI\\%WlOutput\\fP globals. Examples might include \\(aqFoocorp 11\\(dq Display\\(aq\n+or \\(aqVirtual X11 output via :1\\(aq.\n .sp\n-This request must be made once only, and can only be made on sources\n-used in drag\\-and\\-drop, so it must be performed before\n-\\fI\\%WlDataDevice.start_drag()\\fP\\&. Attempting to\n-use the source other than for drag\\-and\\-drop will raise a protocol\n-error.\n+The description event is sent after binding the output object and\n+whenever the description changes. The description is optional, and may\n+not be sent at all.\n+.sp\n+The description event will be followed by a done event.\n .INDENT 7.0\n .TP\n .B Parameters\n-\\fBdnd_actions\\fP (\\fIArgumentType.Uint\\fP) \\-\\- actions supported by the data source\n+\\fBdescription\\fP (\\fIArgumentType.String\\fP) \\-\\- output description\n .UNINDENT\n .UNINDENT\n+.UNINDENT\n+.SS WlKeyboard\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlKeyboard\n+Keyboard input device\n+.sp\n+The \\fI\\%WlKeyboard\\fP interface represents one or more keyboards\n+associated with a seat.\n+.sp\n+Each \\fI\\%WlKeyboard\\fP has the following logical state:\n+.INDENT 7.0\n+.IP \\(bu 2\n+an active surface (possibly null),\n+.IP \\(bu 2\n+the keys currently logically down,\n+.IP \\(bu 2\n+the active modifiers,\n+.IP \\(bu 2\n+the active group.\n+.UNINDENT\n+.sp\n+By default, the active surface is null, the keys currently logically down\n+are empty, the active modifiers and the active group are 0.\n .INDENT 7.0\n .TP\n-.B target(mime_type: \\(aqstr | None\\(aq) -> \\(aqNone\\(aq\n+.B release() -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n+.sp\n+Release the keyboard object\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B keymap(format: \\(aqint\\(aq, fd: \\(aqint\\(aq, size: \\(aqint\\(aq) -> \\(aqNone\\(aq\n .sp\n Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n .sp\n-A target accepts an offered mime type\n+Keyboard mapping\n .sp\n-Sent when a target accepts pointer_focus or motion events. If a target\n-does not accept any of the offered types, type is NULL.\n+This event provides a file descriptor to the client which can be\n+memory\\-mapped in read\\-only mode to provide a keyboard mapping\n+description.\n .sp\n-Used for feedback during drag\\-and\\-drop.\n+From version 7 onwards, the fd must be mapped with MAP_PRIVATE by the\n+recipient, as MAP_SHARED may fail.\n .INDENT 7.0\n .TP\n .B Parameters\n-\\fBmime_type\\fP (\\fIArgumentType.String\\fP or \\fINone\\fP) \\-\\- mime type accepted by the target\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBformat\\fP (\\fIArgumentType.Uint\\fP) \\-\\- keymap format\n+.IP \\(bu 2\n+\\fBfd\\fP (\\fIArgumentType.FileDescriptor\\fP) \\-\\- keymap file descriptor\n+.IP \\(bu 2\n+\\fBsize\\fP (\\fIArgumentType.Uint\\fP) \\-\\- keymap size, in bytes\n+.UNINDENT\n .UNINDENT\n .UNINDENT\n .INDENT 7.0\n .TP\n-.B send(mime_type: \\(aqstr\\(aq, fd: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.B enter(serial: \\(aqint\\(aq, surface: \\(aqWlSurface\\(aq, keys: \\(aqlist\\(aq) -> \\(aqNone\\(aq\n .sp\n Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n .sp\n-Send the data\n+Enter event\n .sp\n-Request for data from the client. Send the data as the specified mime\n-type over the passed file descriptor, then close it.\n+Notification that this seat\\(aqs keyboard focus is on a certain surface.\n+.sp\n+The compositor must send the \\fI\\%WlKeyboard.modifiers()\\fP event after\n+this event.\n+.sp\n+In the \\fI\\%WlKeyboard\\fP logical state, this event sets the active\n+surface to the surface argument and the keys currently logically down\n+to the keys in the keys argument. The compositor must not send this\n+event if the \\fI\\%WlKeyboard\\fP already had an active surface\n+immediately before this event.\n .INDENT 7.0\n .TP\n .B Parameters\n .INDENT 7.0\n .IP \\(bu 2\n-\\fBmime_type\\fP (\\fIArgumentType.String\\fP) \\-\\- mime type for the data\n+\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the enter event\n .IP \\(bu 2\n-\\fBfd\\fP (\\fIArgumentType.FileDescriptor\\fP) \\-\\- file descriptor for the data\n+\\fBsurface\\fP (\\fI\\%WlSurface\\fP) \\-\\- surface gaining keyboard focus\n+.IP \\(bu 2\n+\\fBkeys\\fP (\\fIArgumentType.Array\\fP) \\-\\- the keys currently logically down\n .UNINDENT\n .UNINDENT\n .UNINDENT\n .INDENT 7.0\n .TP\n-.B cancelled() -> \\(aqNone\\(aq\n+.B leave(serial: \\(aqint\\(aq, surface: \\(aqWlSurface\\(aq) -> \\(aqNone\\(aq\n .sp\n Event \\-\\- opcode 2 (attached to \\fBProxy\\fP instance)\n .sp\n-Selection was cancelled\n+Leave event\n .sp\n-This data source is no longer valid. There are several reasons why this\n-could happen:\n+Notification that this seat\\(aqs keyboard focus is no longer on a certain\n+surface.\n+.sp\n+The leave notification is sent before the enter notification for the\n+new focus.\n+.sp\n+In the \\fI\\%WlKeyboard\\fP logical state, this event resets all values\n+to their defaults. The compositor must not send this event if the\n+active surface of the \\fI\\%WlKeyboard\\fP was not equal to the surface\n+argument immediately before this event.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n .INDENT 7.0\n .IP \\(bu 2\n-The data source has been replaced by another data source.\n+\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the leave event\n .IP \\(bu 2\n-The drag\\-and\\-drop operation was performed, but the drop destination\n-did not accept any of the mime types offered through\n-\\fI\\%WlDataSource.target()\\fP\\&.\n+\\fBsurface\\fP (\\fI\\%WlSurface\\fP) \\-\\- surface that lost keyboard focus\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B key(serial: \\(aqint\\(aq, time: \\(aqint\\(aq, key: \\(aqint\\(aq, state: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n+.sp\n+Key event\n+.sp\n+A key was pressed or released. The time argument is a timestamp with\n+millisecond granularity, with an undefined base.\n+.sp\n+The key is a platform\\-specific key code that can be interpreted by\n+feeding it to the keyboard mapping (see the keymap event).\n+.sp\n+If this event produces a change in modifiers, then the resulting\n+\\fI\\%WlKeyboard.modifiers()\\fP event must be sent after this event.\n+.sp\n+In the \\fI\\%WlKeyboard\\fP logical state, this event adds the key to\n+the keys currently logically down (if the state argument is pressed) or\n+removes the key from the keys currently logically down (if the state\n+argument is released). The compositor must not send this event if the\n+\\fI\\%WlKeyboard\\fP did not have an active surface immediately before\n+this event. The compositor must not send this event if state is pressed\n+(resp. released) and the key was already logically down (resp. was not\n+logically down) immediately before this event.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n .IP \\(bu 2\n-The drag\\-and\\-drop operation was performed, but the drop destination\n-did not select any of the actions present in the mask offered through\n-\\fI\\%WlDataSource.action()\\fP\\&.\n+\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the key event\n .IP \\(bu 2\n-The drag\\-and\\-drop operation was performed but didn\\(aqt happen over a\n-surface.\n+\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n .IP \\(bu 2\n-The compositor cancelled the drag\\-and\\-drop operation (e.g. compositor\n-dependent timeouts to avoid stale drag\\-and\\-drop transfers).\n+\\fBkey\\fP (\\fIArgumentType.Uint\\fP) \\-\\- key that produced the event\n+.IP \\(bu 2\n+\\fBstate\\fP (\\fIArgumentType.Uint\\fP) \\-\\- physical state of the key\n .UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B modifiers(serial: \\(aqint\\(aq, mods_depressed: \\(aqint\\(aq, mods_latched: \\(aqint\\(aq, mods_locked: \\(aqint\\(aq, group: \\(aqint\\(aq) -> \\(aqNone\\(aq\n .sp\n-The client should clean up and destroy this data source.\n+Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n .sp\n-For objects of version 2 or older, \\fI\\%WlDataSource.cancelled()\\fP\n-will only be emitted if the data source was replaced by another data\n-source.\n+Modifier and group state\n+.sp\n+Notifies clients that the modifier and/or group state has changed, and\n+it should update its local state.\n+.sp\n+The compositor may send this event without a surface of the client\n+having keyboard focus, for example to tie modifier information to\n+pointer focus instead. If a modifier event with pressed modifiers is\n+sent without a prior enter event, the client can assume the modifier\n+state is valid until it receives the next\n+\\fI\\%WlKeyboard.modifiers()\\fP event. In order to reset the modifier\n+state again, the compositor can send a \\fI\\%WlKeyboard.modifiers()\\fP\n+event with no pressed modifiers.\n+.sp\n+In the \\fI\\%WlKeyboard\\fP logical state, this event updates the\n+modifiers and group.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the modifiers event\n+.IP \\(bu 2\n+\\fBmods_depressed\\fP (\\fIArgumentType.Uint\\fP) \\-\\- depressed modifiers\n+.IP \\(bu 2\n+\\fBmods_latched\\fP (\\fIArgumentType.Uint\\fP) \\-\\- latched modifiers\n+.IP \\(bu 2\n+\\fBmods_locked\\fP (\\fIArgumentType.Uint\\fP) \\-\\- locked modifiers\n+.IP \\(bu 2\n+\\fBgroup\\fP (\\fIArgumentType.Uint\\fP) \\-\\- keyboard layout\n+.UNINDENT\n+.UNINDENT\n .UNINDENT\n .INDENT 7.0\n .TP\n-.B dnd_drop_performed() -> \\(aqNone\\(aq\n+.B repeat_info(rate: \\(aqint\\(aq, delay: \\(aqint\\(aq) -> \\(aqNone\\(aq\n .sp\n-Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n+Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n .sp\n-The drag\\-and\\-drop operation physically finished\n+Repeat rate and delay\n .sp\n-The user performed the drop action. This event does not indicate\n-acceptance, \\fI\\%WlDataSource.cancelled()\\fP may still be emitted\n-afterwards if the drop destination does not accept any mime type.\n+Informs the client about the keyboard\\(aqs repeat rate and delay.\n .sp\n-However, this event might however not be received if the compositor\n-cancelled the drag\\-and\\-drop operation before this event could happen.\n+This event is sent as soon as the \\fI\\%WlKeyboard\\fP object has been\n+created, and is guaranteed to be received by the client before any key\n+press event.\n .sp\n-Note that the data_source may still be used in the future and should\n-not be destroyed here.\n+Negative values for either rate or delay are illegal. A rate of zero\n+will disable any repeating (regardless of the value of delay).\n+.sp\n+This event can be sent later on as well with a new value if necessary,\n+so clients should continue listening for the event past the creation of\n+\\fI\\%WlKeyboard\\fP\\&.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBrate\\fP (\\fIArgumentType.Int\\fP) \\-\\- the rate of repeating keys in characters per second\n+.IP \\(bu 2\n+\\fBdelay\\fP (\\fIArgumentType.Int\\fP) \\-\\- delay in milliseconds since key down until repeating starts\n+.UNINDENT\n+.UNINDENT\n .UNINDENT\n+.UNINDENT\n+.SS WlCompositor\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlCompositor\n+The compositor singleton\n+.sp\n+A compositor. This object is a singleton global. The compositor is in\n+charge of combining the contents of multiple surfaces into one displayable\n+output.\n .INDENT 7.0\n .TP\n-.B dnd_finished() -> \\(aqNone\\(aq\n+.B create_surface() -> \\(aqProxy[WlSurface]\\(aq\n .sp\n-Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n .sp\n-The drag\\-and\\-drop operation concluded\n+Create new surface\n .sp\n-The drop destination finished interoperating with this data source, so\n-the client is now free to destroy this data source and free all\n-associated data.\n+Ask the compositor to create a new surface.\n+.INDENT 7.0\n+.TP\n+.B Returns\n+\\fI\\%WlSurface\\fP \\-\\- the new surface\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B create_region() -> \\(aqProxy[WlRegion]\\(aq\n .sp\n-If the action used to perform the operation was \\(dqmove\\(dq, the source can\n-now delete the transferred data.\n+Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n+.sp\n+Create new region\n+.sp\n+Ask the compositor to create a new region.\n+.INDENT 7.0\n+.TP\n+.B Returns\n+\\fI\\%WlRegion\\fP \\-\\- the new region\n+.UNINDENT\n+.UNINDENT\n .UNINDENT\n+.SS WlSeat\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlSeat\n+Group of input devices\n+.sp\n+A seat is a group of keyboards, pointer and touch devices. This object is\n+published as a global during start up, or when such a device is hot\n+plugged. A seat typically has a pointer and maintains a keyboard focus and\n+a pointer focus.\n .INDENT 7.0\n .TP\n-.B action(dnd_action: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.B get_pointer() -> \\(aqProxy[WlPointer]\\(aq\n .sp\n-Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n .sp\n-Notify the selected action\n+Return pointer object\n .sp\n-This event indicates the action selected by the compositor after\n-matching the source/destination side actions. Only one action (or none)\n-will be offered here.\n+The ID provided will be initialized to the\n+\\fI\\%WlPointer\\fP interface for this seat.\n .sp\n-This event can be emitted multiple times during the drag\\-and\\-drop\n-operation, mainly in response to destination side changes through\n-\\fI\\%WlDataOffer.set_actions()\\fP, and as the data\n-device enters/leaves surfaces.\n+This request only takes effect if the seat has the pointer capability,\n+or has had the pointer capability in the past. It is a protocol\n+violation to issue this request on a seat that has never had the\n+pointer capability. The missing_capability error will be sent in this\n+case.\n+.INDENT 7.0\n+.TP\n+.B Returns\n+\\fI\\%WlPointer\\fP \\-\\- seat pointer\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B get_keyboard() -> \\(aqProxy[WlKeyboard]\\(aq\n .sp\n-It is only possible to receive this event after\n-\\fI\\%WlDataSource.dnd_drop_performed()\\fP if the drag\\-and\\-drop\n-operation ended in an \\(dqask\\(dq action, in which case the final\n-\\fI\\%WlDataSource.action()\\fP event will happen immediately before\n-\\fI\\%WlDataSource.dnd_finished()\\fP\\&.\n+Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n .sp\n-Compositors may also change the selected action on the fly, mainly in\n-response to keyboard modifier changes during the drag\\-and\\-drop\n-operation.\n+Return keyboard object\n .sp\n-The most recent action received is always the valid one. The chosen\n-action may change alongside negotiation (e.g. an \\(dqask\\(dq action can turn\n-into a \\(dqmove\\(dq operation), so the effects of the final action must\n-always be applied in \\fBWlDataOffer.dnd_finished()\\fP\\&.\n+The ID provided will be initialized to the\n+\\fI\\%WlKeyboard\\fP interface for this\n+seat.\n .sp\n-Clients can trigger cursor surface changes from this point, so they\n-reflect the current action.\n+This request only takes effect if the seat has the keyboard capability,\n+or has had the keyboard capability in the past. It is a protocol\n+violation to issue this request on a seat that has never had the\n+keyboard capability. The missing_capability error will be sent in this\n+case.\n+.INDENT 7.0\n+.TP\n+.B Returns\n+\\fI\\%WlKeyboard\\fP \\-\\- seat keyboard\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B get_touch() -> \\(aqProxy[WlTouch]\\(aq\n+.sp\n+Request \\-\\- opcode 2 (attached to \\fBResource\\fP instance)\n+.sp\n+Return touch object\n+.sp\n+The ID provided will be initialized to the\n+\\fI\\%WlTouch\\fP interface for this seat.\n+.sp\n+This request only takes effect if the seat has the touch capability, or\n+has had the touch capability in the past. It is a protocol violation to\n+issue this request on a seat that has never had the touch capability.\n+The missing_capability error will be sent in this case.\n+.INDENT 7.0\n+.TP\n+.B Returns\n+\\fI\\%WlTouch\\fP \\-\\- seat touch\n+interface\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B release() -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 3 (attached to \\fBResource\\fP instance)\n+.sp\n+Release the seat object\n+.sp\n+Using this request a client can tell the server that it is not going to\n+use the seat object anymore.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B capabilities(capabilities: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n+.sp\n+Seat capabilities changed\n+.sp\n+This is emitted whenever a seat gains or loses the pointer, keyboard or\n+touch capabilities. The argument is a capability enum containing the\n+complete set of capabilities this seat has.\n+.sp\n+When the pointer capability is added, a client may create a\n+\\fI\\%WlPointer\\fP object using the\n+\\fI\\%WlSeat.get_pointer()\\fP request. This object will receive pointer\n+events until the capability is removed in the future.\n+.sp\n+When the pointer capability is removed, a client should destroy the\n+\\fI\\%WlPointer\\fP objects associated with\n+the seat where the capability was removed, using the\n+\\fI\\%WlPointer.release()\\fP request. No further\n+pointer events will be received on these objects.\n+.sp\n+In some compositors, if a seat regains the pointer capability and a\n+client has a previously obtained\n+\\fI\\%WlPointer\\fP object of version 4 or\n+less, that object may start sending pointer events again. This behavior\n+is considered a misinterpretation of the intended behavior and must not\n+be relied upon by the client.\n+\\fI\\%WlPointer\\fP objects of version 5 or\n+later must not send events if created before the most recent event\n+notifying the client of an added pointer capability.\n+.sp\n+The above behavior also applies to\n+\\fI\\%WlKeyboard\\fP and\n+\\fI\\%WlTouch\\fP with the keyboard and\n+touch capabilities, respectively.\n .INDENT 7.0\n .TP\n .B Parameters\n-\\fBdnd_action\\fP (\\fIArgumentType.Uint\\fP) \\-\\- action selected by the compositor\n+\\fBcapabilities\\fP (\\fIArgumentType.Uint\\fP) \\-\\- capabilities of the seat\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B name(name: \\(aqstr\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n+.sp\n+Unique identifier for this seat\n+.sp\n+In a multi\\-seat configuration the seat name can be used by clients to\n+help identify which physical devices the seat represents.\n+.sp\n+The seat name is a UTF\\-8 string with no convention defined for its\n+contents. Each name is unique among all \\fI\\%WlSeat\\fP globals. The\n+name is only guaranteed to be unique for the current compositor\n+instance.\n+.sp\n+The same seat names are used for all clients. Thus, the name can be\n+shared across processes to refer to a specific \\fI\\%WlSeat\\fP global.\n+.sp\n+The name event is sent after binding to the seat global. This event is\n+only sent once per seat object, and the name does not change over the\n+lifetime of the \\fI\\%WlSeat\\fP global.\n+.sp\n+Compositors may re\\-use the same seat name if the \\fI\\%WlSeat\\fP global\n+is destroyed and re\\-created later.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBname\\fP (\\fIArgumentType.String\\fP) \\-\\- seat identifier\n .UNINDENT\n .UNINDENT\n .UNINDENT\n .SS WlDataOffer\n .INDENT 0.0\n .TP\n .B class pywayland.protocol.wayland.WlDataOffer\n@@ -2496,14 +3439,437 @@\n .INDENT 7.0\n .TP\n .B Parameters\n \\fBdnd_action\\fP (\\fIArgumentType.Uint\\fP) \\-\\- action selected by the compositor\n .UNINDENT\n .UNINDENT\n .UNINDENT\n+.SS WlBuffer\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlBuffer\n+Content for a \\fI\\%WlSurface\\fP\n+.sp\n+A buffer provides the content for a\n+\\fI\\%WlSurface\\fP\\&. Buffers are created through\n+factory interfaces such as \\fI\\%WlShm\\fP,\n+wp_linux_buffer_params (from the linux\\-dmabuf protocol extension) or\n+similar. It has a width and a height and can be attached to a\n+\\fI\\%WlSurface\\fP, but the mechanism by which\n+a client provides and updates the contents is defined by the buffer factory\n+interface.\n+.sp\n+Color channels are assumed to be electrical rather than optical (in other\n+words, encoded with a transfer function) unless otherwise specified. If the\n+buffer uses a format that has an alpha channel, the alpha channel is\n+assumed to be premultiplied into the electrical color channel values (after\n+transfer function encoding) unless otherwise specified.\n+.sp\n+Note, because \\fI\\%WlBuffer\\fP objects are created from multiple\n+independent factory interfaces, the \\fI\\%WlBuffer\\fP interface is frozen\n+at version 1.\n+.INDENT 7.0\n+.TP\n+.B destroy() -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n+.sp\n+Destroy a buffer\n+.sp\n+Destroy a buffer. If and how you need to release the backing storage is\n+defined by the buffer factory interface.\n+.sp\n+For possible side\\-effects to a surface, see \\fI\\%WlSurface.attach()\\fP\\&.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B release() -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n+.sp\n+Compositor releases buffer\n+.sp\n+Sent when this \\fI\\%WlBuffer\\fP is no longer used by the compositor.\n+The client is now free to reuse or destroy this buffer and its backing\n+storage.\n+.sp\n+If a client receives a release event before the frame callback\n+requested in the same \\fI\\%WlSurface.commit()\\fP that attaches this\n+\\fI\\%WlBuffer\\fP to a surface, then the client is immediately free to\n+reuse the buffer and its backing storage, and does not need a second\n+buffer for the next surface content update. Typically this is possible,\n+when the compositor maintains a copy of the\n+\\fI\\%WlSurface\\fP contents, e.g. as a GL\n+texture. This is an important optimization for GL(ES) compositors with\n+\\fI\\%WlShm\\fP clients.\n+.UNINDENT\n+.UNINDENT\n+.SS WlDataSource\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlDataSource\n+Offer to transfer data\n+.sp\n+The \\fI\\%WlDataSource\\fP object is the source side of a\n+\\fI\\%WlDataOffer\\fP\\&. It is created by the\n+source client in a data transfer and provides a way to describe the offered\n+data and a way to respond to requests to transfer the data.\n+.INDENT 7.0\n+.TP\n+.B offer(mime_type: \\(aqstr\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n+.sp\n+Add an offered mime type\n+.sp\n+This request adds a mime type to the set of mime types advertised to\n+targets. Can be called several times to offer multiple types.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBmime_type\\fP (\\fIArgumentType.String\\fP) \\-\\- mime type offered by the data source\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B destroy() -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n+.sp\n+Destroy the data source\n+.sp\n+Destroy the data source.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B set_actions(dnd_actions: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 2 (attached to \\fBResource\\fP instance)\n+.sp\n+Set the available drag\\-and\\-drop actions\n+.sp\n+Sets the actions that the source side client supports for this\n+operation. This request may trigger \\fI\\%WlDataSource.action()\\fP and\n+\\fI\\%WlDataOffer.action()\\fP events if the\n+compositor needs to change the selected action.\n+.sp\n+The dnd_actions argument must contain only values expressed in the\n+\\fBWlDataDeviceManager.dnd_actions()\\fP enum,\n+otherwise it will result in a protocol error.\n+.sp\n+This request must be made once only, and can only be made on sources\n+used in drag\\-and\\-drop, so it must be performed before\n+\\fI\\%WlDataDevice.start_drag()\\fP\\&. Attempting to\n+use the source other than for drag\\-and\\-drop will raise a protocol\n+error.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBdnd_actions\\fP (\\fIArgumentType.Uint\\fP) \\-\\- actions supported by the data source\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B target(mime_type: \\(aqstr | None\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n+.sp\n+A target accepts an offered mime type\n+.sp\n+Sent when a target accepts pointer_focus or motion events. If a target\n+does not accept any of the offered types, type is NULL.\n+.sp\n+Used for feedback during drag\\-and\\-drop.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBmime_type\\fP (\\fIArgumentType.String\\fP or \\fINone\\fP) \\-\\- mime type accepted by the target\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B send(mime_type: \\(aqstr\\(aq, fd: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n+.sp\n+Send the data\n+.sp\n+Request for data from the client. Send the data as the specified mime\n+type over the passed file descriptor, then close it.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBmime_type\\fP (\\fIArgumentType.String\\fP) \\-\\- mime type for the data\n+.IP \\(bu 2\n+\\fBfd\\fP (\\fIArgumentType.FileDescriptor\\fP) \\-\\- file descriptor for the data\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B cancelled() -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 2 (attached to \\fBProxy\\fP instance)\n+.sp\n+Selection was cancelled\n+.sp\n+This data source is no longer valid. There are several reasons why this\n+could happen:\n+.INDENT 7.0\n+.IP \\(bu 2\n+The data source has been replaced by another data source.\n+.IP \\(bu 2\n+The drag\\-and\\-drop operation was performed, but the drop destination\n+did not accept any of the mime types offered through\n+\\fI\\%WlDataSource.target()\\fP\\&.\n+.IP \\(bu 2\n+The drag\\-and\\-drop operation was performed, but the drop destination\n+did not select any of the actions present in the mask offered through\n+\\fI\\%WlDataSource.action()\\fP\\&.\n+.IP \\(bu 2\n+The drag\\-and\\-drop operation was performed but didn\\(aqt happen over a\n+surface.\n+.IP \\(bu 2\n+The compositor cancelled the drag\\-and\\-drop operation (e.g. compositor\n+dependent timeouts to avoid stale drag\\-and\\-drop transfers).\n+.UNINDENT\n+.sp\n+The client should clean up and destroy this data source.\n+.sp\n+For objects of version 2 or older, \\fI\\%WlDataSource.cancelled()\\fP\n+will only be emitted if the data source was replaced by another data\n+source.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B dnd_drop_performed() -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n+.sp\n+The drag\\-and\\-drop operation physically finished\n+.sp\n+The user performed the drop action. This event does not indicate\n+acceptance, \\fI\\%WlDataSource.cancelled()\\fP may still be emitted\n+afterwards if the drop destination does not accept any mime type.\n+.sp\n+However, this event might however not be received if the compositor\n+cancelled the drag\\-and\\-drop operation before this event could happen.\n+.sp\n+Note that the data_source may still be used in the future and should\n+not be destroyed here.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B dnd_finished() -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n+.sp\n+The drag\\-and\\-drop operation concluded\n+.sp\n+The drop destination finished interoperating with this data source, so\n+the client is now free to destroy this data source and free all\n+associated data.\n+.sp\n+If the action used to perform the operation was \\(dqmove\\(dq, the source can\n+now delete the transferred data.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B action(dnd_action: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n+.sp\n+Notify the selected action\n+.sp\n+This event indicates the action selected by the compositor after\n+matching the source/destination side actions. Only one action (or none)\n+will be offered here.\n+.sp\n+This event can be emitted multiple times during the drag\\-and\\-drop\n+operation, mainly in response to destination side changes through\n+\\fI\\%WlDataOffer.set_actions()\\fP, and as the data\n+device enters/leaves surfaces.\n+.sp\n+It is only possible to receive this event after\n+\\fI\\%WlDataSource.dnd_drop_performed()\\fP if the drag\\-and\\-drop\n+operation ended in an \\(dqask\\(dq action, in which case the final\n+\\fI\\%WlDataSource.action()\\fP event will happen immediately before\n+\\fI\\%WlDataSource.dnd_finished()\\fP\\&.\n+.sp\n+Compositors may also change the selected action on the fly, mainly in\n+response to keyboard modifier changes during the drag\\-and\\-drop\n+operation.\n+.sp\n+The most recent action received is always the valid one. The chosen\n+action may change alongside negotiation (e.g. an \\(dqask\\(dq action can turn\n+into a \\(dqmove\\(dq operation), so the effects of the final action must\n+always be applied in \\fBWlDataOffer.dnd_finished()\\fP\\&.\n+.sp\n+Clients can trigger cursor surface changes from this point, so they\n+reflect the current action.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBdnd_action\\fP (\\fIArgumentType.Uint\\fP) \\-\\- action selected by the compositor\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.SS WlCallback\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlCallback\n+Callback object\n+.sp\n+Clients can handle the \\(aqdone\\(aq event to get notified when the related\n+request is done.\n+.sp\n+Note, because \\fI\\%WlCallback\\fP objects are created from multiple\n+independent factory interfaces, the \\fI\\%WlCallback\\fP interface is frozen\n+at version 1.\n+.INDENT 7.0\n+.TP\n+.B done(callback_data: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n+.sp\n+Done event\n+.sp\n+Notify the client when the related request is done.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBcallback_data\\fP (\\fIArgumentType.Uint\\fP) \\-\\- request\\-specific data for the callback\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.SS WlRegion\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlRegion\n+Region interface\n+.sp\n+A region object describes an area.\n+.sp\n+Region objects are used to describe the opaque and input regions of a\n+surface.\n+.INDENT 7.0\n+.TP\n+.B destroy() -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n+.sp\n+Destroy region\n+.sp\n+Destroy the region. This will invalidate the object ID.\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B add(x: \\(aqint\\(aq, y: \\(aqint\\(aq, width: \\(aqint\\(aq, height: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n+.sp\n+Add rectangle to region\n+.sp\n+Add the specified rectangle to the region.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBx\\fP (\\fIArgumentType.Int\\fP) \\-\\- region\\-local x coordinate\n+.IP \\(bu 2\n+\\fBy\\fP (\\fIArgumentType.Int\\fP) \\-\\- region\\-local y coordinate\n+.IP \\(bu 2\n+\\fBwidth\\fP (\\fIArgumentType.Int\\fP) \\-\\- rectangle width\n+.IP \\(bu 2\n+\\fBheight\\fP (\\fIArgumentType.Int\\fP) \\-\\- rectangle height\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B subtract(x: \\(aqint\\(aq, y: \\(aqint\\(aq, width: \\(aqint\\(aq, height: \\(aqint\\(aq) -> \\(aqNone\\(aq\n+.sp\n+Request \\-\\- opcode 2 (attached to \\fBResource\\fP instance)\n+.sp\n+Subtract rectangle from region\n+.sp\n+Subtract the specified rectangle from the region.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+.INDENT 7.0\n+.IP \\(bu 2\n+\\fBx\\fP (\\fIArgumentType.Int\\fP) \\-\\- region\\-local x coordinate\n+.IP \\(bu 2\n+\\fBy\\fP (\\fIArgumentType.Int\\fP) \\-\\- region\\-local y coordinate\n+.IP \\(bu 2\n+\\fBwidth\\fP (\\fIArgumentType.Int\\fP) \\-\\- rectangle width\n+.IP \\(bu 2\n+\\fBheight\\fP (\\fIArgumentType.Int\\fP) \\-\\- rectangle height\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n+.SS WlDataDeviceManager\n+.INDENT 0.0\n+.TP\n+.B class pywayland.protocol.wayland.WlDataDeviceManager\n+Data transfer interface\n+.sp\n+The \\fI\\%WlDataDeviceManager\\fP is a singleton global object that provides\n+access to inter\\-client data transfer mechanisms such as copy\\-and\\-paste and\n+drag\\-and\\-drop. These mechanisms are tied to a\n+\\fI\\%WlSeat\\fP and this interface lets a\n+client get a \\fI\\%WlDataDevice\\fP\n+corresponding to a \\fI\\%WlSeat\\fP\\&.\n+.sp\n+Depending on the version bound, the objects created from the bound\n+\\fI\\%WlDataDeviceManager\\fP object will have different requirements for\n+functioning properly. See \\fI\\%WlDataSource.set_actions()\\fP,\n+\\fI\\%WlDataOffer.accept()\\fP and\n+\\fI\\%WlDataOffer.finish()\\fP for details.\n+.INDENT 7.0\n+.TP\n+.B create_data_source() -> \\(aqProxy[WlDataSource]\\(aq\n+.sp\n+Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n+.sp\n+Create a new data source\n+.sp\n+Create a new data source.\n+.INDENT 7.0\n+.TP\n+.B Returns\n+\\fI\\%WlDataSource\\fP \\-\\- data source to\n+create\n+.UNINDENT\n+.UNINDENT\n+.INDENT 7.0\n+.TP\n+.B get_data_device(seat: \\(aqWlSeat\\(aq) -> \\(aqProxy[WlDataDevice]\\(aq\n+.sp\n+Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n+.sp\n+Create a new data device\n+.sp\n+Create a new data device for a given seat.\n+.INDENT 7.0\n+.TP\n+.B Parameters\n+\\fBseat\\fP (\\fI\\%WlSeat\\fP) \\-\\- seat associated with the data device\n+.TP\n+.B Returns\n+\\fI\\%WlDataDevice\\fP \\-\\- data device to\n+create\n+.UNINDENT\n+.UNINDENT\n+.UNINDENT\n .SS WlShellSurface\n .INDENT 0.0\n .TP\n .B class pywayland.protocol.wayland.WlShellSurface\n Desktop\\-style metadata interface\n .sp\n An interface that may be implemented by a\n@@ -3058,773 +4424,14 @@\n surface may override it to behave as synchronized. For details, see\n \\fI\\%WlSubsurface\\fP\\&.\n .sp\n If a surface\\(aqs parent surface behaves as desynchronized, then the\n cached state is applied on set_desync.\n .UNINDENT\n .UNINDENT\n-.SS WlShm\n-.INDENT 0.0\n-.TP\n-.B class pywayland.protocol.wayland.WlShm\n-Shared memory support\n-.sp\n-A singleton global object that provides support for shared memory.\n-.sp\n-Clients can create \\fI\\%WlShmPool\\fP objects\n-using the create_pool request.\n-.sp\n-On binding the \\fI\\%WlShm\\fP object one or more format events are emitted\n-to inform clients about the valid pixel formats that can be used for\n-buffers.\n-.INDENT 7.0\n-.TP\n-.B create_pool(fd: \\(aqint\\(aq, size: \\(aqint\\(aq) -> \\(aqProxy[WlShmPool]\\(aq\n-.sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n-.sp\n-Create a shm pool\n-.sp\n-Create a new \\fI\\%WlShmPool\\fP object.\n-.sp\n-The pool can be used to create shared memory based buffer objects. The\n-server will mmap size bytes of the passed file descriptor, to use as\n-backing memory for the pool.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBfd\\fP (\\fIArgumentType.FileDescriptor\\fP) \\-\\- file descriptor for the pool\n-.IP \\(bu 2\n-\\fBsize\\fP (\\fIArgumentType.Int\\fP) \\-\\- pool size, in bytes\n-.UNINDENT\n-.TP\n-.B Returns\n-\\fI\\%WlShmPool\\fP \\-\\- pool to create\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B release() -> \\(aqNone\\(aq\n-.sp\n-Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n-.sp\n-Release the shm object\n-.sp\n-Using this request a client can tell the server that it is not going to\n-use the shm object anymore.\n-.sp\n-Objects created via this interface remain unaffected.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B format(format: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n-.sp\n-Pixel format description\n-.sp\n-Informs the client about a valid pixel format that can be used for\n-buffers. Known formats include argb8888 and xrgb8888.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-\\fBformat\\fP (\\fIArgumentType.Uint\\fP) \\-\\- buffer pixel format\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.SS WlKeyboard\n-.INDENT 0.0\n-.TP\n-.B class pywayland.protocol.wayland.WlKeyboard\n-Keyboard input device\n-.sp\n-The \\fI\\%WlKeyboard\\fP interface represents one or more keyboards\n-associated with a seat.\n-.sp\n-Each \\fI\\%WlKeyboard\\fP has the following logical state:\n-.INDENT 7.0\n-.IP \\(bu 2\n-an active surface (possibly null),\n-.IP \\(bu 2\n-the keys currently logically down,\n-.IP \\(bu 2\n-the active modifiers,\n-.IP \\(bu 2\n-the active group.\n-.UNINDENT\n-.sp\n-By default, the active surface is null, the keys currently logically down\n-are empty, the active modifiers and the active group are 0.\n-.INDENT 7.0\n-.TP\n-.B release() -> \\(aqNone\\(aq\n-.sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n-.sp\n-Release the keyboard object\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B keymap(format: \\(aqint\\(aq, fd: \\(aqint\\(aq, size: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n-.sp\n-Keyboard mapping\n-.sp\n-This event provides a file descriptor to the client which can be\n-memory\\-mapped in read\\-only mode to provide a keyboard mapping\n-description.\n-.sp\n-From version 7 onwards, the fd must be mapped with MAP_PRIVATE by the\n-recipient, as MAP_SHARED may fail.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBformat\\fP (\\fIArgumentType.Uint\\fP) \\-\\- keymap format\n-.IP \\(bu 2\n-\\fBfd\\fP (\\fIArgumentType.FileDescriptor\\fP) \\-\\- keymap file descriptor\n-.IP \\(bu 2\n-\\fBsize\\fP (\\fIArgumentType.Uint\\fP) \\-\\- keymap size, in bytes\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B enter(serial: \\(aqint\\(aq, surface: \\(aqWlSurface\\(aq, keys: \\(aqlist\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n-.sp\n-Enter event\n-.sp\n-Notification that this seat\\(aqs keyboard focus is on a certain surface.\n-.sp\n-The compositor must send the \\fI\\%WlKeyboard.modifiers()\\fP event after\n-this event.\n-.sp\n-In the \\fI\\%WlKeyboard\\fP logical state, this event sets the active\n-surface to the surface argument and the keys currently logically down\n-to the keys in the keys argument. The compositor must not send this\n-event if the \\fI\\%WlKeyboard\\fP already had an active surface\n-immediately before this event.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the enter event\n-.IP \\(bu 2\n-\\fBsurface\\fP (\\fI\\%WlSurface\\fP) \\-\\- surface gaining keyboard focus\n-.IP \\(bu 2\n-\\fBkeys\\fP (\\fIArgumentType.Array\\fP) \\-\\- the keys currently logically down\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B leave(serial: \\(aqint\\(aq, surface: \\(aqWlSurface\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 2 (attached to \\fBProxy\\fP instance)\n-.sp\n-Leave event\n-.sp\n-Notification that this seat\\(aqs keyboard focus is no longer on a certain\n-surface.\n-.sp\n-The leave notification is sent before the enter notification for the\n-new focus.\n-.sp\n-In the \\fI\\%WlKeyboard\\fP logical state, this event resets all values\n-to their defaults. The compositor must not send this event if the\n-active surface of the \\fI\\%WlKeyboard\\fP was not equal to the surface\n-argument immediately before this event.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the leave event\n-.IP \\(bu 2\n-\\fBsurface\\fP (\\fI\\%WlSurface\\fP) \\-\\- surface that lost keyboard focus\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B key(serial: \\(aqint\\(aq, time: \\(aqint\\(aq, key: \\(aqint\\(aq, state: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n-.sp\n-Key event\n-.sp\n-A key was pressed or released. The time argument is a timestamp with\n-millisecond granularity, with an undefined base.\n-.sp\n-The key is a platform\\-specific key code that can be interpreted by\n-feeding it to the keyboard mapping (see the keymap event).\n-.sp\n-If this event produces a change in modifiers, then the resulting\n-\\fI\\%WlKeyboard.modifiers()\\fP event must be sent after this event.\n-.sp\n-In the \\fI\\%WlKeyboard\\fP logical state, this event adds the key to\n-the keys currently logically down (if the state argument is pressed) or\n-removes the key from the keys currently logically down (if the state\n-argument is released). The compositor must not send this event if the\n-\\fI\\%WlKeyboard\\fP did not have an active surface immediately before\n-this event. The compositor must not send this event if state is pressed\n-(resp. released) and the key was already logically down (resp. was not\n-logically down) immediately before this event.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the key event\n-.IP \\(bu 2\n-\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n-.IP \\(bu 2\n-\\fBkey\\fP (\\fIArgumentType.Uint\\fP) \\-\\- key that produced the event\n-.IP \\(bu 2\n-\\fBstate\\fP (\\fIArgumentType.Uint\\fP) \\-\\- physical state of the key\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B modifiers(serial: \\(aqint\\(aq, mods_depressed: \\(aqint\\(aq, mods_latched: \\(aqint\\(aq, mods_locked: \\(aqint\\(aq, group: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n-.sp\n-Modifier and group state\n-.sp\n-Notifies clients that the modifier and/or group state has changed, and\n-it should update its local state.\n-.sp\n-The compositor may send this event without a surface of the client\n-having keyboard focus, for example to tie modifier information to\n-pointer focus instead. If a modifier event with pressed modifiers is\n-sent without a prior enter event, the client can assume the modifier\n-state is valid until it receives the next\n-\\fI\\%WlKeyboard.modifiers()\\fP event. In order to reset the modifier\n-state again, the compositor can send a \\fI\\%WlKeyboard.modifiers()\\fP\n-event with no pressed modifiers.\n-.sp\n-In the \\fI\\%WlKeyboard\\fP logical state, this event updates the\n-modifiers and group.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the modifiers event\n-.IP \\(bu 2\n-\\fBmods_depressed\\fP (\\fIArgumentType.Uint\\fP) \\-\\- depressed modifiers\n-.IP \\(bu 2\n-\\fBmods_latched\\fP (\\fIArgumentType.Uint\\fP) \\-\\- latched modifiers\n-.IP \\(bu 2\n-\\fBmods_locked\\fP (\\fIArgumentType.Uint\\fP) \\-\\- locked modifiers\n-.IP \\(bu 2\n-\\fBgroup\\fP (\\fIArgumentType.Uint\\fP) \\-\\- keyboard layout\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B repeat_info(rate: \\(aqint\\(aq, delay: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n-.sp\n-Repeat rate and delay\n-.sp\n-Informs the client about the keyboard\\(aqs repeat rate and delay.\n-.sp\n-This event is sent as soon as the \\fI\\%WlKeyboard\\fP object has been\n-created, and is guaranteed to be received by the client before any key\n-press event.\n-.sp\n-Negative values for either rate or delay are illegal. A rate of zero\n-will disable any repeating (regardless of the value of delay).\n-.sp\n-This event can be sent later on as well with a new value if necessary,\n-so clients should continue listening for the event past the creation of\n-\\fI\\%WlKeyboard\\fP\\&.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBrate\\fP (\\fIArgumentType.Int\\fP) \\-\\- the rate of repeating keys in characters per second\n-.IP \\(bu 2\n-\\fBdelay\\fP (\\fIArgumentType.Int\\fP) \\-\\- delay in milliseconds since key down until repeating starts\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.SS WlTouch\n-.INDENT 0.0\n-.TP\n-.B class pywayland.protocol.wayland.WlTouch\n-Touchscreen input device\n-.sp\n-The \\fI\\%WlTouch\\fP interface represents a touchscreen associated with a\n-seat.\n-.sp\n-Touch interactions can consist of one or more contacts. For each contact, a\n-series of events is generated, starting with a down event, followed by zero\n-or more motion events, and ending with an up event. Events relating to the\n-same contact point can be identified by the ID of the sequence.\n-.INDENT 7.0\n-.TP\n-.B release() -> \\(aqNone\\(aq\n-.sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n-.sp\n-Release the touch object\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B down(serial: \\(aqint\\(aq, time: \\(aqint\\(aq, surface: \\(aqWlSurface\\(aq, id: \\(aqint\\(aq, x: \\(aqfloat\\(aq, y: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n-.sp\n-Touch down event and beginning of a touch sequence\n-.sp\n-A new touch point has appeared on the surface. This touch point is\n-assigned a unique ID. Future events from this touch point reference\n-this ID. The ID ceases to be valid after a touch up event and may be\n-reused in the future.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the touch down event\n-.IP \\(bu 2\n-\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n-.IP \\(bu 2\n-\\fBsurface\\fP (\\fI\\%WlSurface\\fP) \\-\\- surface touched\n-.IP \\(bu 2\n-\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n-.IP \\(bu 2\n-\\fBx\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local x coordinate\n-.IP \\(bu 2\n-\\fBy\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local y coordinate\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B up(serial: \\(aqint\\(aq, time: \\(aqint\\(aq, id: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n-.sp\n-End of a touch event sequence\n-.sp\n-The touch point has disappeared. No further events will be sent for\n-this touch point and the touch point\\(aqs ID is released and may be reused\n-in a future touch down event.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the touch up event\n-.IP \\(bu 2\n-\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n-.IP \\(bu 2\n-\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B motion(time: \\(aqint\\(aq, id: \\(aqint\\(aq, x: \\(aqfloat\\(aq, y: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 2 (attached to \\fBProxy\\fP instance)\n-.sp\n-Update of touch point coordinates\n-.sp\n-A touch point has changed coordinates.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n-.IP \\(bu 2\n-\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n-.IP \\(bu 2\n-\\fBx\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local x coordinate\n-.IP \\(bu 2\n-\\fBy\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local y coordinate\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B frame() -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n-.sp\n-End of touch frame event\n-.sp\n-Indicates the end of a set of events that logically belong together. A\n-client is expected to accumulate the data in all events within the\n-frame before proceeding.\n-.sp\n-A \\fI\\%WlTouch.frame()\\fP terminates at least one event but otherwise\n-no guarantee is provided about the set of events within a frame. A\n-client must assume that any state not updated in a frame is unchanged\n-from the previously known state.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B cancel() -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n-.sp\n-Touch session cancelled\n-.sp\n-Sent if the compositor decides the touch stream is a global gesture. No\n-further events are sent to the clients from that particular gesture.\n-Touch cancellation applies to all touch points currently active on this\n-client\\(aqs surface. The client is responsible for finalizing the touch\n-points, future touch points on this surface may reuse the touch point\n-ID.\n-.sp\n-No frame event is required after the cancel event.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B shape(id: \\(aqint\\(aq, major: \\(aqfloat\\(aq, minor: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n-.sp\n-Update shape of touch point\n-.sp\n-Sent when a touchpoint has changed its shape.\n-.sp\n-This event does not occur on its own. It is sent before a\n-\\fI\\%WlTouch.frame()\\fP event and carries the new shape information for\n-any previously reported, or new touch points of that frame.\n-.sp\n-Other events describing the touch point such as \\fI\\%WlTouch.down()\\fP,\n-\\fI\\%WlTouch.motion()\\fP or \\fI\\%WlTouch.orientation()\\fP may be sent\n-within the same \\fI\\%WlTouch.frame()\\fP\\&. A client should treat these\n-events as a single logical touch point update. The order of\n-\\fI\\%WlTouch.shape()\\fP, \\fI\\%WlTouch.orientation()\\fP and\n-\\fI\\%WlTouch.motion()\\fP is not guaranteed. A \\fI\\%WlTouch.down()\\fP\n-event is guaranteed to occur before the first \\fI\\%WlTouch.shape()\\fP\n-event for this touch ID but both events may occur within the same\n-\\fI\\%WlTouch.frame()\\fP\\&.\n-.sp\n-A touchpoint shape is approximated by an ellipse through the major and\n-minor axis length. The major axis length describes the longer diameter\n-of the ellipse, while the minor axis length describes the shorter\n-diameter. Major and minor are orthogonal and both are specified in\n-surface\\-local coordinates. The center of the ellipse is always at the\n-touchpoint location as reported by \\fI\\%WlTouch.down()\\fP or\n-\\fBWlTouch.move()\\fP\\&.\n-.sp\n-This event is only sent by the compositor if the touch device supports\n-shape reports. The client has to make reasonable assumptions about the\n-shape if it did not receive this event.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n-.IP \\(bu 2\n-\\fBmajor\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- length of the major axis in surface\\-local coordinates\n-.IP \\(bu 2\n-\\fBminor\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- length of the minor axis in surface\\-local coordinates\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B orientation(id: \\(aqint\\(aq, orientation: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 6 (attached to \\fBProxy\\fP instance)\n-.sp\n-Update orientation of touch point\n-.sp\n-Sent when a touchpoint has changed its orientation.\n-.sp\n-This event does not occur on its own. It is sent before a\n-\\fI\\%WlTouch.frame()\\fP event and carries the new shape information for\n-any previously reported, or new touch points of that frame.\n-.sp\n-Other events describing the touch point such as \\fI\\%WlTouch.down()\\fP,\n-\\fI\\%WlTouch.motion()\\fP or \\fI\\%WlTouch.shape()\\fP may be sent within\n-the same \\fI\\%WlTouch.frame()\\fP\\&. A client should treat these events as\n-a single logical touch point update. The order of\n-\\fI\\%WlTouch.shape()\\fP, \\fI\\%WlTouch.orientation()\\fP and\n-\\fI\\%WlTouch.motion()\\fP is not guaranteed. A \\fI\\%WlTouch.down()\\fP\n-event is guaranteed to occur before the first\n-\\fI\\%WlTouch.orientation()\\fP event for this touch ID but both events\n-may occur within the same \\fI\\%WlTouch.frame()\\fP\\&.\n-.sp\n-The orientation describes the clockwise angle of a touchpoint\\(aqs major\n-axis to the positive surface y\\-axis and is normalized to the \\-180 to\n-+180 degree range. The granularity of orientation depends on the touch\n-device, some devices only support binary rotation values between 0 and\n-90 degrees.\n-.sp\n-This event is only sent by the compositor if the touch device supports\n-orientation reports.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBid\\fP (\\fIArgumentType.Int\\fP) \\-\\- the unique ID of this touch point\n-.IP \\(bu 2\n-\\fBorientation\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- angle between major axis and positive surface y\\-axis in degrees\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.SS WlDataDevice\n-.INDENT 0.0\n-.TP\n-.B class pywayland.protocol.wayland.WlDataDevice\n-Data transfer device\n-.sp\n-There is one \\fI\\%WlDataDevice\\fP per seat which can be obtained from the\n-global \\fI\\%WlDataDeviceManager\\fP singleton.\n-.sp\n-A \\fI\\%WlDataDevice\\fP provides access to inter\\-client data transfer\n-mechanisms such as copy\\-and\\-paste and drag\\-and\\-drop.\n-.INDENT 7.0\n-.TP\n-.B start_drag(source: \\(aqWlDataSource | None\\(aq, origin: \\(aqWlSurface\\(aq, icon: \\(aqWlSurface | None\\(aq, serial: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n-.sp\n-Start drag\\-and\\-drop operation\n-.sp\n-This request asks the compositor to start a drag\\-and\\-drop operation on\n-behalf of the client.\n-.sp\n-The source argument is the data source that provides the data for the\n-eventual data transfer. If source is NULL, enter, leave and motion\n-events are sent only to the client that initiated the drag and the\n-client is expected to handle the data passing internally. If source is\n-destroyed, the drag\\-and\\-drop session will be cancelled.\n-.sp\n-The origin surface is the surface where the drag originates and the\n-client must have an active implicit grab that matches the serial.\n-.sp\n-The icon surface is an optional (can be NULL) surface that provides an\n-icon to be moved around with the cursor. Initially, the top\\-left\n-corner of the icon surface is placed at the cursor hotspot, but\n-subsequent \\fI\\%WlSurface.offset()\\fP requests can move the\n-relative position. Attach requests must be confirmed with\n-\\fI\\%WlSurface.commit()\\fP as usual. The icon\n-surface is given the role of a drag\\-and\\-drop icon. If the icon surface\n-already has another role, it raises a protocol error.\n-.sp\n-The input region is ignored for wl_surfaces with the role of a drag\\-\n-and\\-drop icon.\n-.sp\n-The given source may not be used in any further set_selection or\n-start_drag requests. Attempting to reuse a previously\\-used source may\n-send a used_source error.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBsource\\fP (\\fI\\%WlDataSource\\fP or \\fINone\\fP) \\-\\- data source for the eventual transfer\n-.IP \\(bu 2\n-\\fBorigin\\fP (\\fI\\%WlSurface\\fP) \\-\\- surface where the drag originates\n-.IP \\(bu 2\n-\\fBicon\\fP (\\fI\\%WlSurface\\fP or \\fINone\\fP) \\-\\- drag\\-and\\-drop icon surface\n-.IP \\(bu 2\n-\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the implicit grab on the origin\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B set_selection(source: \\(aqWlDataSource | None\\(aq, serial: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n-.sp\n-Copy data to the selection\n-.sp\n-This request asks the compositor to set the selection to the data from\n-the source on behalf of the client.\n-.sp\n-To unset the selection, set the source to NULL.\n-.sp\n-The given source may not be used in any further set_selection or\n-start_drag requests. Attempting to reuse a previously\\-used source may\n-send a used_source error.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBsource\\fP (\\fI\\%WlDataSource\\fP or \\fINone\\fP) \\-\\- data source for the selection\n-.IP \\(bu 2\n-\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the event that triggered this request\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B release() -> \\(aqNone\\(aq\n-.sp\n-Request \\-\\- opcode 2 (attached to \\fBResource\\fP instance)\n-.sp\n-Destroy data device\n-.sp\n-This request destroys the data device.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B data_offer(id: \\(aqWlDataOffer\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n-.sp\n-Introduce a new \\fI\\%WlDataOffer\\fP\n-.sp\n-The data_offer event introduces a new\n-\\fI\\%WlDataOffer\\fP object, which will\n-subsequently be used in either the data_device.enter event (for drag\\-\n-and\\-drop) or the data_device.selection event (for selections).\n-Immediately following the data_device.data_offer event, the new\n-data_offer object will send out data_offer.offer events to describe the\n-mime types it offers.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-\\fBid\\fP (\\fI\\%WlDataOffer\\fP) \\-\\- the new data_offer object\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B enter(serial: \\(aqint\\(aq, surface: \\(aqWlSurface\\(aq, x: \\(aqfloat\\(aq, y: \\(aqfloat\\(aq, id: \\(aqWlDataOffer | None\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n-.sp\n-Initiate drag\\-and\\-drop session\n-.sp\n-This event is sent when an active drag\\-and\\-drop pointer enters a\n-surface owned by the client. The position of the pointer at enter time\n-is provided by the x and y arguments, in surface\\-local coordinates.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBserial\\fP (\\fIArgumentType.Uint\\fP) \\-\\- serial number of the enter event\n-.IP \\(bu 2\n-\\fBsurface\\fP (\\fI\\%WlSurface\\fP) \\-\\- client surface entered\n-.IP \\(bu 2\n-\\fBx\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local x coordinate\n-.IP \\(bu 2\n-\\fBy\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local y coordinate\n-.IP \\(bu 2\n-\\fBid\\fP (\\fI\\%WlDataOffer\\fP or \\fINone\\fP) \\-\\- source data_offer object\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B leave() -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 2 (attached to \\fBProxy\\fP instance)\n-.sp\n-End drag\\-and\\-drop session\n-.sp\n-This event is sent when the drag\\-and\\-drop pointer leaves the surface\n-and the session ends. The client must destroy the\n-\\fI\\%WlDataOffer\\fP introduced at enter\n-time at this point.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B motion(time: \\(aqint\\(aq, x: \\(aqfloat\\(aq, y: \\(aqfloat\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n-.sp\n-Drag\\-and\\-drop session motion\n-.sp\n-This event is sent when the drag\\-and\\-drop pointer moves within the\n-currently focused surface. The new position of the pointer is provided\n-by the x and y arguments, in surface\\-local coordinates.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBtime\\fP (\\fIArgumentType.Uint\\fP) \\-\\- timestamp with millisecond granularity\n-.IP \\(bu 2\n-\\fBx\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local x coordinate\n-.IP \\(bu 2\n-\\fBy\\fP (\\fIArgumentType.Fixed\\fP) \\-\\- surface\\-local y coordinate\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B drop() -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n-.sp\n-End drag\\-and\\-drop session successfully\n-.sp\n-The event is sent when a drag\\-and\\-drop operation is ended because the\n-implicit grab is removed.\n-.sp\n-The drag\\-and\\-drop destination is expected to honor the last action\n-received through \\fI\\%WlDataOffer.action()\\fP, if the resulting\n-action is \\(dqcopy\\(dq or \\(dqmove\\(dq, the destination can still perform\n-\\fI\\%WlDataOffer.receive()\\fP requests, and is\n-expected to end all transfers with a \\fI\\%WlDataOffer.finish()\\fP request.\n-.sp\n-If the resulting action is \\(dqask\\(dq, the action will not be considered\n-final. The drag\\-and\\-drop destination is expected to perform one last\n-\\fI\\%WlDataOffer.set_actions()\\fP request, or\n-\\fI\\%WlDataOffer.destroy()\\fP in order to cancel\n-the operation.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B selection(id: \\(aqWlDataOffer | None\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n-.sp\n-Advertise new selection\n-.sp\n-The selection event is sent out to notify the client of a new\n-\\fI\\%WlDataOffer\\fP for the selection for\n-this device. The data_device.data_offer and the data_offer.offer\n-events are sent out immediately before this event to introduce the data\n-offer object. The selection event is sent to a client immediately\n-before receiving keyboard focus and when a new selection is set while\n-the client has keyboard focus. The data_offer is valid until a new\n-data_offer or NULL is received or until the client loses keyboard\n-focus. Switching surface with keyboard focus within the same client\n-doesn\\(aqt mean a new selection will be sent. The client must destroy the\n-previous selection data_offer, if any, upon receiving this event.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-\\fBid\\fP (\\fI\\%WlDataOffer\\fP or \\fINone\\fP) \\-\\- selection data_offer object\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n .SS WlPointer\n .INDENT 0.0\n .TP\n .B class pywayland.protocol.wayland.WlPointer\n Pointer input device\n .sp\n The \\fI\\%WlPointer\\fP interface represents one or more input devices, such\n@@ -4301,54 +4908,14 @@\n \\fBaxis\\fP (\\fIArgumentType.Uint\\fP) \\-\\- axis type\n .IP \\(bu 2\n \\fBdirection\\fP (\\fIArgumentType.Uint\\fP) \\-\\- physical direction relative to axis motion\n .UNINDENT\n .UNINDENT\n .UNINDENT\n .UNINDENT\n-.SS WlCompositor\n-.INDENT 0.0\n-.TP\n-.B class pywayland.protocol.wayland.WlCompositor\n-The compositor singleton\n-.sp\n-A compositor. This object is a singleton global. The compositor is in\n-charge of combining the contents of multiple surfaces into one displayable\n-output.\n-.INDENT 7.0\n-.TP\n-.B create_surface() -> \\(aqProxy[WlSurface]\\(aq\n-.sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n-.sp\n-Create new surface\n-.sp\n-Ask the compositor to create a new surface.\n-.INDENT 7.0\n-.TP\n-.B Returns\n-\\fI\\%WlSurface\\fP \\-\\- the new surface\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B create_region() -> \\(aqProxy[WlRegion]\\(aq\n-.sp\n-Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n-.sp\n-Create new region\n-.sp\n-Ask the compositor to create a new region.\n-.INDENT 7.0\n-.TP\n-.B Returns\n-\\fI\\%WlRegion\\fP \\-\\- the new region\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n .SS WlShell\n .INDENT 0.0\n .TP\n .B class pywayland.protocol.wayland.WlShell\n Create desktop\\-style surfaces\n .sp\n This interface is implemented by servers that provide desktop\\-style user\n@@ -4486,581 +5053,14 @@\n .INDENT 7.0\n .TP\n .B Parameters\n \\fBid\\fP (\\fIArgumentType.Uint\\fP) \\-\\- deleted object ID\n .UNINDENT\n .UNINDENT\n .UNINDENT\n-.SS WlOutput\n-.INDENT 0.0\n-.TP\n-.B class pywayland.protocol.wayland.WlOutput\n-Compositor output region\n-.sp\n-An output describes part of the compositor geometry. The compositor works\n-in the \\(aqcompositor coordinate system\\(aq and an output corresponds to a\n-rectangular area in that space that is actually visible. This typically\n-corresponds to a monitor that displays part of the compositor space. This\n-object is published as global during start up, or when a monitor is\n-hotplugged.\n-.INDENT 7.0\n-.TP\n-.B release() -> \\(aqNone\\(aq\n-.sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n-.sp\n-Release the output object\n-.sp\n-Using this request a client can tell the server that it is not going to\n-use the output object anymore.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B geometry(x: \\(aqint\\(aq, y: \\(aqint\\(aq, physical_width: \\(aqint\\(aq, physical_height: \\(aqint\\(aq, subpixel: \\(aqint\\(aq, make: \\(aqstr\\(aq, model: \\(aqstr\\(aq, transform: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n-.sp\n-Properties of the output\n-.sp\n-The geometry event describes geometric properties of the output. The\n-event is sent when binding to the output object and whenever any of the\n-properties change.\n-.sp\n-The physical size can be set to zero if it doesn\\(aqt make sense for this\n-output (e.g. for projectors or virtual outputs).\n-.sp\n-The geometry event will be followed by a done event (starting from\n-version 2).\n-.sp\n-Clients should use \\fI\\%WlSurface.preferred_buffer_transform()\\fP\n-instead of the transform advertised by this event to find the preferred\n-buffer transform to use for a surface.\n-.sp\n-Note: \\fI\\%WlOutput\\fP only advertises partial information about the\n-output position and identification. Some compositors, for instance\n-those not implementing a desktop\\-style output layout or those exposing\n-virtual outputs, might fake this information. Instead of using x and y,\n-clients should use xdg_output.logical_position. Instead of using make\n-and model, clients should use name and description.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBx\\fP (\\fIArgumentType.Int\\fP) \\-\\- x position within the global compositor space\n-.IP \\(bu 2\n-\\fBy\\fP (\\fIArgumentType.Int\\fP) \\-\\- y position within the global compositor space\n-.IP \\(bu 2\n-\\fBphysical_width\\fP (\\fIArgumentType.Int\\fP) \\-\\- width in millimeters of the output\n-.IP \\(bu 2\n-\\fBphysical_height\\fP (\\fIArgumentType.Int\\fP) \\-\\- height in millimeters of the output\n-.IP \\(bu 2\n-\\fBsubpixel\\fP (\\fIArgumentType.Int\\fP) \\-\\- subpixel orientation of the output\n-.IP \\(bu 2\n-\\fBmake\\fP (\\fIArgumentType.String\\fP) \\-\\- textual description of the manufacturer\n-.IP \\(bu 2\n-\\fBmodel\\fP (\\fIArgumentType.String\\fP) \\-\\- textual description of the model\n-.IP \\(bu 2\n-\\fBtransform\\fP (\\fIArgumentType.Int\\fP) \\-\\- additional transformation applied to buffer contents during\n-presentation\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B mode(flags: \\(aqint\\(aq, width: \\(aqint\\(aq, height: \\(aqint\\(aq, refresh: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n-.sp\n-Advertise available modes for the output\n-.sp\n-The mode event describes an available mode for the output.\n-.sp\n-The event is sent when binding to the output object and there will\n-always be one mode, the current mode. The event is sent again if an\n-output changes mode, for the mode that is now current. In other words,\n-the current mode is always the last mode that was received with the\n-current flag set.\n-.sp\n-Non\\-current modes are deprecated. A compositor can decide to only\n-advertise the current mode and never send other modes. Clients should\n-not rely on non\\-current modes.\n-.sp\n-The size of a mode is given in physical hardware units of the output\n-device. This is not necessarily the same as the output size in the\n-global compositor space. For instance, the output may be scaled, as\n-described in \\fI\\%WlOutput.scale()\\fP, or transformed, as described in\n-\\fBWlOutput.transform()\\fP\\&. Clients willing to retrieve the output\n-size in the global compositor space should use xdg_output.logical_size\n-instead.\n-.sp\n-The vertical refresh rate can be set to zero if it doesn\\(aqt make sense\n-for this output (e.g. for virtual outputs).\n-.sp\n-The mode event will be followed by a done event (starting from version\n-2).\n-.sp\n-Clients should not use the refresh rate to schedule frames. Instead,\n-they should use the \\fI\\%WlSurface.frame()\\fP event or the\n-presentation\\-time protocol.\n-.sp\n-Note: this information is not always meaningful for all outputs. Some\n-compositors, such as those exposing virtual outputs, might fake the\n-refresh rate or the size.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBflags\\fP (\\fIArgumentType.Uint\\fP) \\-\\- bitfield of mode flags\n-.IP \\(bu 2\n-\\fBwidth\\fP (\\fIArgumentType.Int\\fP) \\-\\- width of the mode in hardware units\n-.IP \\(bu 2\n-\\fBheight\\fP (\\fIArgumentType.Int\\fP) \\-\\- height of the mode in hardware units\n-.IP \\(bu 2\n-\\fBrefresh\\fP (\\fIArgumentType.Int\\fP) \\-\\- vertical refresh rate in mHz\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B done() -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 2 (attached to \\fBProxy\\fP instance)\n-.sp\n-Sent all information about output\n-.sp\n-This event is sent after all other properties have been sent after\n-binding to the output object and after any other property changes done\n-after that. This allows changes to the output properties to be seen as\n-atomic, even if they happen via multiple events.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B scale(factor: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 3 (attached to \\fBProxy\\fP instance)\n-.sp\n-Output scaling properties\n-.sp\n-This event contains scaling geometry information that is not in the\n-geometry event. It may be sent after binding the output object or if\n-the output scale changes later. The compositor will emit a non\\-zero,\n-positive value for scale. If it is not sent, the client should assume a\n-scale of 1.\n-.sp\n-A scale larger than 1 means that the compositor will automatically\n-scale surface buffers by this amount when rendering. This is used for\n-very high resolution displays where applications rendering at the\n-native resolution would be too small to be legible.\n-.sp\n-Clients should use \\fI\\%WlSurface.preferred_buffer_scale()\\fP instead\n-of this event to find the preferred buffer scale to use for a surface.\n-.sp\n-The scale event will be followed by a done event.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-\\fBfactor\\fP (\\fIArgumentType.Int\\fP) \\-\\- scaling factor of output\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B name(name: \\(aqstr\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 4 (attached to \\fBProxy\\fP instance)\n-.sp\n-Name of this output\n-.sp\n-Many compositors will assign user\\-friendly names to their outputs, show\n-them to the user, allow the user to refer to an output, etc. The client\n-may wish to know this name as well to offer the user similar behaviors.\n-.sp\n-The name is a UTF\\-8 string with no convention defined for its contents.\n-Each name is unique among all \\fI\\%WlOutput\\fP globals. The name is\n-only guaranteed to be unique for the compositor instance.\n-.sp\n-The same output name is used for all clients for a given\n-\\fI\\%WlOutput\\fP global. Thus, the name can be shared across processes\n-to refer to a specific \\fI\\%WlOutput\\fP global.\n-.sp\n-The name is not guaranteed to be persistent across sessions, thus\n-cannot be used to reliably identify an output in e.g. configuration\n-files.\n-.sp\n-Examples of names include \\(aqHDMI\\-A\\-1\\(aq, \\(aqWL\\-1\\(aq, \\(aqX11\\-1\\(aq, etc. However, do\n-not assume that the name is a reflection of an underlying DRM\n-connector, X11 connection, etc.\n-.sp\n-The name event is sent after binding the output object. This event is\n-only sent once per output object, and the name does not change over the\n-lifetime of the \\fI\\%WlOutput\\fP global.\n-.sp\n-Compositors may re\\-use the same output name if the \\fI\\%WlOutput\\fP\n-global is destroyed and re\\-created later. Compositors should avoid re\\-\n-using the same name if possible.\n-.sp\n-The name event will be followed by a done event.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-\\fBname\\fP (\\fIArgumentType.String\\fP) \\-\\- output name\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B description(description: \\(aqstr\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 5 (attached to \\fBProxy\\fP instance)\n-.sp\n-Human\\-readable description of this output\n-.sp\n-Many compositors can produce human\\-readable descriptions of their\n-outputs. The client may wish to know this description as well, e.g. for\n-output selection purposes.\n-.sp\n-The description is a UTF\\-8 string with no convention defined for its\n-contents. The description is not guaranteed to be unique among all\n-\\fI\\%WlOutput\\fP globals. Examples might include \\(aqFoocorp 11\\(dq Display\\(aq\n-or \\(aqVirtual X11 output via :1\\(aq.\n-.sp\n-The description event is sent after binding the output object and\n-whenever the description changes. The description is optional, and may\n-not be sent at all.\n-.sp\n-The description event will be followed by a done event.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-\\fBdescription\\fP (\\fIArgumentType.String\\fP) \\-\\- output description\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.SS WlBuffer\n-.INDENT 0.0\n-.TP\n-.B class pywayland.protocol.wayland.WlBuffer\n-Content for a \\fI\\%WlSurface\\fP\n-.sp\n-A buffer provides the content for a\n-\\fI\\%WlSurface\\fP\\&. Buffers are created through\n-factory interfaces such as \\fI\\%WlShm\\fP,\n-wp_linux_buffer_params (from the linux\\-dmabuf protocol extension) or\n-similar. It has a width and a height and can be attached to a\n-\\fI\\%WlSurface\\fP, but the mechanism by which\n-a client provides and updates the contents is defined by the buffer factory\n-interface.\n-.sp\n-Color channels are assumed to be electrical rather than optical (in other\n-words, encoded with a transfer function) unless otherwise specified. If the\n-buffer uses a format that has an alpha channel, the alpha channel is\n-assumed to be premultiplied into the electrical color channel values (after\n-transfer function encoding) unless otherwise specified.\n-.sp\n-Note, because \\fI\\%WlBuffer\\fP objects are created from multiple\n-independent factory interfaces, the \\fI\\%WlBuffer\\fP interface is frozen\n-at version 1.\n-.INDENT 7.0\n-.TP\n-.B destroy() -> \\(aqNone\\(aq\n-.sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n-.sp\n-Destroy a buffer\n-.sp\n-Destroy a buffer. If and how you need to release the backing storage is\n-defined by the buffer factory interface.\n-.sp\n-For possible side\\-effects to a surface, see \\fI\\%WlSurface.attach()\\fP\\&.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B release() -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n-.sp\n-Compositor releases buffer\n-.sp\n-Sent when this \\fI\\%WlBuffer\\fP is no longer used by the compositor.\n-The client is now free to reuse or destroy this buffer and its backing\n-storage.\n-.sp\n-If a client receives a release event before the frame callback\n-requested in the same \\fI\\%WlSurface.commit()\\fP that attaches this\n-\\fI\\%WlBuffer\\fP to a surface, then the client is immediately free to\n-reuse the buffer and its backing storage, and does not need a second\n-buffer for the next surface content update. Typically this is possible,\n-when the compositor maintains a copy of the\n-\\fI\\%WlSurface\\fP contents, e.g. as a GL\n-texture. This is an important optimization for GL(ES) compositors with\n-\\fI\\%WlShm\\fP clients.\n-.UNINDENT\n-.UNINDENT\n-.SS WlSeat\n-.INDENT 0.0\n-.TP\n-.B class pywayland.protocol.wayland.WlSeat\n-Group of input devices\n-.sp\n-A seat is a group of keyboards, pointer and touch devices. This object is\n-published as a global during start up, or when such a device is hot\n-plugged. A seat typically has a pointer and maintains a keyboard focus and\n-a pointer focus.\n-.INDENT 7.0\n-.TP\n-.B get_pointer() -> \\(aqProxy[WlPointer]\\(aq\n-.sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n-.sp\n-Return pointer object\n-.sp\n-The ID provided will be initialized to the\n-\\fI\\%WlPointer\\fP interface for this seat.\n-.sp\n-This request only takes effect if the seat has the pointer capability,\n-or has had the pointer capability in the past. It is a protocol\n-violation to issue this request on a seat that has never had the\n-pointer capability. The missing_capability error will be sent in this\n-case.\n-.INDENT 7.0\n-.TP\n-.B Returns\n-\\fI\\%WlPointer\\fP \\-\\- seat pointer\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B get_keyboard() -> \\(aqProxy[WlKeyboard]\\(aq\n-.sp\n-Request \\-\\- opcode 1 (attached to \\fBResource\\fP instance)\n-.sp\n-Return keyboard object\n-.sp\n-The ID provided will be initialized to the\n-\\fI\\%WlKeyboard\\fP interface for this\n-seat.\n-.sp\n-This request only takes effect if the seat has the keyboard capability,\n-or has had the keyboard capability in the past. It is a protocol\n-violation to issue this request on a seat that has never had the\n-keyboard capability. The missing_capability error will be sent in this\n-case.\n-.INDENT 7.0\n-.TP\n-.B Returns\n-\\fI\\%WlKeyboard\\fP \\-\\- seat keyboard\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B get_touch() -> \\(aqProxy[WlTouch]\\(aq\n-.sp\n-Request \\-\\- opcode 2 (attached to \\fBResource\\fP instance)\n-.sp\n-Return touch object\n-.sp\n-The ID provided will be initialized to the\n-\\fI\\%WlTouch\\fP interface for this seat.\n-.sp\n-This request only takes effect if the seat has the touch capability, or\n-has had the touch capability in the past. It is a protocol violation to\n-issue this request on a seat that has never had the touch capability.\n-The missing_capability error will be sent in this case.\n-.INDENT 7.0\n-.TP\n-.B Returns\n-\\fI\\%WlTouch\\fP \\-\\- seat touch\n-interface\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B release() -> \\(aqNone\\(aq\n-.sp\n-Request \\-\\- opcode 3 (attached to \\fBResource\\fP instance)\n-.sp\n-Release the seat object\n-.sp\n-Using this request a client can tell the server that it is not going to\n-use the seat object anymore.\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B capabilities(capabilities: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n-.sp\n-Seat capabilities changed\n-.sp\n-This is emitted whenever a seat gains or loses the pointer, keyboard or\n-touch capabilities. The argument is a capability enum containing the\n-complete set of capabilities this seat has.\n-.sp\n-When the pointer capability is added, a client may create a\n-\\fI\\%WlPointer\\fP object using the\n-\\fI\\%WlSeat.get_pointer()\\fP request. This object will receive pointer\n-events until the capability is removed in the future.\n-.sp\n-When the pointer capability is removed, a client should destroy the\n-\\fI\\%WlPointer\\fP objects associated with\n-the seat where the capability was removed, using the\n-\\fI\\%WlPointer.release()\\fP request. No further\n-pointer events will be received on these objects.\n-.sp\n-In some compositors, if a seat regains the pointer capability and a\n-client has a previously obtained\n-\\fI\\%WlPointer\\fP object of version 4 or\n-less, that object may start sending pointer events again. This behavior\n-is considered a misinterpretation of the intended behavior and must not\n-be relied upon by the client.\n-\\fI\\%WlPointer\\fP objects of version 5 or\n-later must not send events if created before the most recent event\n-notifying the client of an added pointer capability.\n-.sp\n-The above behavior also applies to\n-\\fI\\%WlKeyboard\\fP and\n-\\fI\\%WlTouch\\fP with the keyboard and\n-touch capabilities, respectively.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-\\fBcapabilities\\fP (\\fIArgumentType.Uint\\fP) \\-\\- capabilities of the seat\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B name(name: \\(aqstr\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n-.sp\n-Unique identifier for this seat\n-.sp\n-In a multi\\-seat configuration the seat name can be used by clients to\n-help identify which physical devices the seat represents.\n-.sp\n-The seat name is a UTF\\-8 string with no convention defined for its\n-contents. Each name is unique among all \\fI\\%WlSeat\\fP globals. The\n-name is only guaranteed to be unique for the current compositor\n-instance.\n-.sp\n-The same seat names are used for all clients. Thus, the name can be\n-shared across processes to refer to a specific \\fI\\%WlSeat\\fP global.\n-.sp\n-The name event is sent after binding to the seat global. This event is\n-only sent once per seat object, and the name does not change over the\n-lifetime of the \\fI\\%WlSeat\\fP global.\n-.sp\n-Compositors may re\\-use the same seat name if the \\fI\\%WlSeat\\fP global\n-is destroyed and re\\-created later.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-\\fBname\\fP (\\fIArgumentType.String\\fP) \\-\\- seat identifier\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.SS WlRegistry\n-.INDENT 0.0\n-.TP\n-.B class pywayland.protocol.wayland.WlRegistry\n-Global registry object\n-.sp\n-The singleton global registry object. The server has a number of global\n-objects that are available to all clients. These objects typically\n-represent an actual object in the server (for example, an input device) or\n-they are singleton objects that provide extension functionality.\n-.sp\n-When a client creates a registry object, the registry object will emit a\n-global event for each global currently in the registry. Globals come and\n-go as a result of device or monitor hotplugs, reconfiguration or other\n-events, and the registry will send out global and global_remove events to\n-keep the client up to date with the changes. To mark the end of the\n-initial burst of events, the client can use the \\fI\\%WlDisplay.sync()\\fP request immediately after\n-calling \\fI\\%WlDisplay.get_registry()\\fP\\&.\n-.sp\n-A client can bind to a global object by using the bind request. This\n-creates a client\\-side handle that lets the object emit events to the client\n-and lets the client invoke requests on the object.\n-.INDENT 7.0\n-.TP\n-.B bind(name: \\(aqint\\(aq, interface: \\(aqtype[T]\\(aq, version: \\(aqint\\(aq) -> \\(aqProxy[T]\\(aq\n-.sp\n-Request \\-\\- opcode 0 (attached to \\fBResource\\fP instance)\n-.sp\n-Bind an object to the display\n-.sp\n-Binds a new, client\\-created object to the server using the specified\n-name as the identifier.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBname\\fP (\\fIArgumentType.Uint\\fP) \\-\\- unique numeric name of the object\n-.IP \\(bu 2\n-\\fBinterface\\fP (\\fIstring\\fP) \\-\\- Interface name\n-.IP \\(bu 2\n-\\fBversion\\fP (\\fIint\\fP) \\-\\- Interface version\n-.UNINDENT\n-.TP\n-.B Returns\n-\\fBpywayland.client.proxy.Proxy\\fP of specified Interface \\-\\-\n-bounded object\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B global_(name: \\(aqint\\(aq, interface: \\(aqstr\\(aq, version: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 0 (attached to \\fBProxy\\fP instance)\n-.sp\n-Announce global object\n-.sp\n-Notify the client of global objects.\n-.sp\n-The event notifies the client that a global object with the given name\n-is now available, and it implements the given version of the given\n-interface.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-.INDENT 7.0\n-.IP \\(bu 2\n-\\fBname\\fP (\\fIArgumentType.Uint\\fP) \\-\\- numeric name of the global object\n-.IP \\(bu 2\n-\\fBinterface\\fP (\\fIArgumentType.String\\fP) \\-\\- interface implemented by the object\n-.IP \\(bu 2\n-\\fBversion\\fP (\\fIArgumentType.Uint\\fP) \\-\\- interface version\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n-.INDENT 7.0\n-.TP\n-.B global_remove(name: \\(aqint\\(aq) -> \\(aqNone\\(aq\n-.sp\n-Event \\-\\- opcode 1 (attached to \\fBProxy\\fP instance)\n-.sp\n-Announce removal of global object\n-.sp\n-Notify the client of removed global objects.\n-.sp\n-This event notifies the client that the global identified by name is no\n-longer available. If the client bound to the global using the bind\n-request, the client should now destroy that object.\n-.sp\n-The object remains valid and requests to the object will be ignored\n-until the client destroys it, to avoid races between the global going\n-away and a client sending a request to it.\n-.INDENT 7.0\n-.TP\n-.B Parameters\n-\\fBname\\fP (\\fIArgumentType.Uint\\fP) \\-\\- numeric name of the global object\n-.UNINDENT\n-.UNINDENT\n-.UNINDENT\n .SS Scanner Modules\n .SS Argumet\n .INDENT 0.0\n .TP\n .B class pywayland.scanner.argument.Argument(name: str, type: \\fI\\%ArgumentType\\fP, summary: str | None, interface: str | None, allow_null: bool, enum: str | None, description: Description | None)\n Argument to a request or event method\n .sp\n"}]}]}]}]}]}