wayland/protocol, branch 1.13

protocol: add axis_source.wheel_tilt

2017-01-24T10:00:19Z

Unlike a wheel rotation, a wheel tilt is a discrete-only axis. Wheel rotations are mapped to degrees in libinput but that that does not apply to wheel tilt axes where there is no physical equivalent. Signed-off-by: Peter Hutterer Reviewed-by: Jonas Ådahl Acked-by: Daniel Stone Reviewed-by: Daniel Stone Reviewed-by: Yong Bakos

protocol: indentation fixes

2016-11-21T11:43:22Z

8 spaces changed to one tab Signed-off-by: Peter Hutterer Reviewed-by: Daniel Stone Acked-by: Bryce Harrington

protocol: spell out that we're using linux/input-event-codes.h button codes

2016-11-21T11:07:12Z

Because we already rely on it in the callers anyway. This is a retrofit, which is not ideal but I'm not sure any compositor out there uses anything else. Might as well define it. Signed-off-by: Peter Hutterer Reviewed-by: Jonas Ådahl Reviewed-by: Daniel Stone

protocol: Extend wl_touch with touchpoint shape and orientation

2016-11-16T16:35:19Z

This CL updates the wl_touch interface with a shape and orientation event. The shape/orientation of a touch point is not relevant for most UI applications, but allows a better experience in some cases such as drawing apps. The events are used by the compositor to inform the client about changes in the shape and orientation of a touchpoint, which is approximated by an ellipse and it's angle to the y-axis. The event is optional and only sent when compositor and the touch device support this type of information. The client is responsible for making a reasonable assumption about the touch shape if no shape is reported. Signed-off-by: Dennis Kempin Reviewed-by: Peter Hutterer Reviewed-by: Yong Bakos Reviewed-by: Daniel Stone

protocol: Remove inconsistent line breaks

2016-11-10T14:41:40Z

Enum entries and message arguments are sometimes preceded by a blank line, but often aren't. Standardize the format of the protocol specification by removing blank lines preceding a list of message arguments and enum entries. Signed-off-by: Yong Bakos Reviewed-by: Pekka Paalanen

protocol: Use singleton global consistently

2016-11-10T11:11:17Z

The protocol describes wl_shm as a "global singleton" rather than "singleton global," which is the order used throughout other protocol object descriptions. Re-order the terms for consistency. Signed-off-by: Yong Bakos Reviewed-by: Pekka Paalanen

protocol: Describe wl_registry as singleton

2016-11-10T11:10:40Z

Other singleton objects in the protocol are described as such. Add a singleton adjective to the wl_registry description, making it similar to other descriptions. Signed-off-by: Yong Bakos Reviewed-by: Pekka Paalanen

protocol: Replace '#defines' with 'macros'

2016-09-13T12:31:41Z

The use of # within a description causes the documentation generator to mistake C syntax with a documentation link. Remove the # from the documentation, suppressing the warning. Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington Reviewed-by: Pekka Paalanen

protocol: Specify upper left corner of damage rectangle

2016-08-12T19:46:02Z

Specify x and y args as the upper left corner of the surface / buffer damage rectangle. Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington

protocol: Describe serial as serial number

2016-08-12T19:45:55Z

Change "serial" to "serial number" in arg summaries, for consistency and clarity. Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington

protocol: Remove wl_ prefix from summary descriptions

2016-08-12T19:45:48Z

Summary attributes sometime describe objects using their wl-prefixed type, but more often don't. Remove the wl_ prefix from summary descriptions, since they tend to describe concepts. Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington

protocol: Correct description indentation

2016-08-12T19:45:41Z

Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington

protocol: Add missing line break

2016-08-12T19:45:34Z

Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington

protocol: Capitalize ID for consistency

2016-08-12T19:45:26Z

Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington

protocol: Hyphenate subsurface

2016-08-12T19:45:19Z

Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington

protocol: Add summary attributes to request params and enum entries

2016-08-12T19:45:09Z

Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington

protocol: Add release (destructor) request to wl_output

2016-08-08T13:22:52Z

Outputs come and go, and this is needed to clean up wl_resources on the server side. All protocol objects need a way to be destroyed. Cc: Neil Roberts Cc: Jason Ekstrand Signed-off-by: Quentin Glidic Reviewed-by: Pekka Paalanen Reviewed-by: Yong Bakos [Pekka: added commit message]

protocol: Remove double line break

2016-05-10T04:06:05Z

All vertical whitespace should manifest as a single blank line, never two. Signed-off-by: Yong Bakos Reviewed-by: Jonas Ådahl

protocol: add support for cross-interface enum attributes

2016-05-03T11:54:11Z

The enum attribute, for which scanner support was introduced in 1771299, can be used to link message arguments to s. However, some arguments refer to s in a different . This adds scanner support for referring to an in a different using dot notation. It also sets the attributes in this style in the wayland XML protocol (wl_shm_pool::create_buffer::format to wl_shm::format, and wl_surface::set_buffer_transform::transform to wl_output::transform), and updates the documentation XSL so that this new style is supported. Changes since v2: - add object:: prefix for all enumerations in the documentation - fix whitespace in scanner.c - minor code fixup to return early and avoid casts in scanner.c Changes since v1: - several implementation bugs fixed Signed-off-by: Auke Booij Reviewed-by: Nils Christopher Brause Reviewed-by: Bill Spitzak [Pekka: rebased across cde251a124d41977b447098cc530fcad2834a45f] [Pekka: wrap lines and space fixes in scanner.c] Signed-off-by: Pekka Paalanen

protocol: Add summaries to event parameters

2016-05-03T01:14:43Z

All event arg elements now have an appropriate summary attribute. This was conducted mostly in response to the undocumented parameter warnings generated during 'make check'. Signed-off-by: Yong Bakos Reviewed-by: Jonas Ådahl Reviewed-by: Bryce Harrington

protocol: Hyphenate compound adjective surface-local

2016-04-29T23:38:05Z

Remove superfluous 'local' from 'buffer local'. In addition, simplify the phrasing of local x/y coordinates in parameter summaries. See https://lists.freedesktop.org/archives/wayland-devel/2016-April/028249.html. Signed-off-by: Yong Bakos Reviewed-by: Bryce Harrington

protocol: Correct grammar and spelling

2016-04-21T22:12:01Z

Fix grammar, spelling, tense, and other inconsistencies, based on correctness, consistency, and precedence both here and influenced by wayland-protocols. - Standardize lower case for summary attribute values. - Minor vertical whitespace removal consistency. - Standarize references to coordinates, preferring 'surface local' - Fix spelling, grammar, tense, and punctuation. Signed-off-by: Yong Bakos

protocol: fix spelling mistake

2016-04-05T23:03:11Z

Signed-off-by: Eric Engestrom

protocol: Add note about per version requirements to wl_data_device_manager

2016-02-02T00:59:55Z

Add a note to the wl_data_device_manager global interface about the different requirements for operating the objects created from the bound global. Signed-off-by: Jonas Ådahl Reviewed-by: Carlos Garnacho

protocol: Add DnD actions

2016-01-16T08:34:52Z

These 2 requests have been added: - wl_data_source.set_actions: Notifies the compositor of the available actions on the data source. - wl_data_offer.set_actions: Notifies the compositor of the available actions on the destination side, plus the preferred action. Out of the data from these requests, the compositor can determine the action both parts agree on (and let the user play a role through eg. keyboard modifiers). The chosen option will be notified to both parties through the following two requests: - wl_data_source.action - wl_data_offer.action In addition, the destination side can peek the source side actions through wl_data_offer.source_actions. Compared to the XDND protocol, there's two notable changes: - XDND lets the source suggest an action, whereas wl_data_device lets the destination prefer a given action. The difference is subtle here, it comes off as convenience because it is the drag destination which receives the motion events (unlike in X) and can perform action updates. The drag destination seems also in a better position to update the preferred action based on things like the data being transferred, the place being dropped, and whether the drag is client-local. - That same source-side preferred action is used in XDND to convey the modifier-induced action to the drag destination, which would then ack it, or reply with another action that's accepted (or none), this makes the XdndPosition/XdndStatus messaging very verbose, and synchronous because the drag source always needs to know the latest status/action for every position+action sent. Here it's the compositor which takes care of modifiers and matching available/accepted actions, this allows for the signaling to happen only whenever the actions/modifiers change for real. Roughly based on previous work by Giulio Camuffo Changes since v10: - Narrow down the situations where wl_data_source/offer.accept requests are supposed to happen. Changes since v9: - Deferred the protocol errors to .finish after some IRC chat with Jonas, added further errors if actions API is used on selection sources/offers. Changes since v8: - Defined further the expected behavior on "ask", described the protocol errors that may happen. Fix more spaces vs tabs issues. Changes since v7: - Misc changes after updating the progress notification patch. Changes since v6: - Further explanations on wl_data_source/offer.set_actions, including a description of "ask" actions. Added protocol errors for unknown action values. Changes since v5: - Applied rewording suggestions from Jonas Ådahl. Dropped slot reservation scheme for actions. Fixed indentation and other minor formatting issues. Changes since v4: - Minor rewording. Changes since v3: - Splitted from DnD progress notification changes. - Further rationales in commit log. Changes since v2: - Renamed notify_actions to set_actions on both sides, seems more consistent with the rest of the protocol. - Spelled out better which events may be triggered on the compositor side by the requests, the circumstances in which events are emitted, and what are events useful for in clients. - Defined a minimal common ground wrt compositor-side action picking and keybindings. - Acknowledge the possibility of compositor/toolkit defined actions, even though none are used at the moment. Changes since v1: - Added wl_data_offer.source_actions to let know of the actions offered by a data source. - Renamed wl_data_source.finished to "drag_finished" for clarity - Improved wording as suggested by Bryce Signed-off-by: Carlos Garnacho Reviewed-by: Michael Catanzaro Reviewed-by: Mike Blumenkrantz Reviewed-by: Jonas Ådahl Reviewed-by: Bryce Harrington

protocol: Improve data source notification around DnD progress

2016-01-16T08:34:52Z

Currently, there's no means for the DnD origin to know whether the destination is actually finished with the DnD transaction, short of finalizing it after the first transfer finishes, or leaking it forever. But this poses other interoperation problems, drag destinations might be requesting several mimetypes at once, might be just poking to find out the most suitable format, might want to defer the action to a popup, might be poking contents early before the selection was dropped... In addition, data_source.cancelled is suitable for the situations where the DnD operation fails (not on a drop target, no matching mimetypes, etc..), but seems undocumented for that use (and unused in weston's DnD). In order to improve the situation, the drag source should be notified of all stages of DnD. In addition to documenting the "cancelled" event for DnD purposes, The following 2 events have been added: - wl_data_source.dnd_drop_performed: Happens when the operation has been physically finished (eg. the button is released), it could be the right place to reset the pointer cursor back and undo any other state resulting from the initial button press. - wl_data_source.dnd_finished: Happens when the destination side destroys the wl_data_offer, at this point the source can just forget all data related to the DnD selection as well, plus optionally deleting the data on move operations. Changes since v6: - Turned wl_data_offer.finish calls with 0/NULL state/mimetype an error, made it explicit that it will only result in wl_data_offer.dnd_finished being sent if successful. Changes since v5: - Further rewording of wl_data_offer.finish and wl_data_offer.accept. Added error for untimely wl_data_offer.finish requests. Changes since v4: - Applied rewording suggestions from Jonas Ådahl. Added new wl_data_offer.finish request to allow explicit finalization on the destination side. Changes since v3: - Renamed dnd_performed to a more descriptive dnd_drop_performed, documented backwards compatible behavior on wl_data_offer.accept and wl_data_source.cancelled. Changes since v2: - Minor rewording. Changes since v1: - Renamed events to have a common "dnd" namespace. Made dnd_performed to happen invariably, data_device.cancelled may still happen afterwards. Signed-off-by: Carlos Garnacho Reviewed-by: Michael Catanzaro Reviewed-by: Jonas Ådahl Reviewed-by: Mike Blumenkrantz Reviewed-by: Bryce Harrington

protocol: add wl_pointer.frame, axis_source, axis_stop, and axis_discrete

2016-01-14T07:29:44Z

The frame event groups separate pointer events together. The primary use-case for this at the moment is diagonal scrolling - a vertical/horizontal scroll event can be grouped together to calculate the correct motion vector. Frame events group all wl_pointer events. An example sequence of motion events followed by a diagonal scroll followed by a button event is: wl_pointer.motion wl_pointer.frame wl_pointer.motion wl_pointer.frame wl_pointer.axis wl_pointer.axis wl_pointer.frame wl_pointer.button wl_pointer.frame In the future, other extensions may insert additional information about an event into the frame. For example, an extension may add information about the physical device that generated an event into the frame. For this reason, enter/leave events are grouped by a frame event too. The axis_source event determines how an axis event was generated. That enables clients to judge when to use kinetic scrolling. Only one axis_source event is allowed per frame and applies to all events in this frame. The axis_stop event notifies a client about the termination of a scroll sequence, likewise needed to calculate kinetic scrolling parameters. Multiple axis_stop events within the same frame indicate that scrolling has stopped in all these axis at the same time. The axis_discrete event provides the wheel click count. Previously the axis value was some hardcoded number (10), with the discrete steps this enables a client to differ between line-based scrolling on a mouse wheel and smooth scrolling with a touchpad. The axis_discrete event carries the axis information and the discrete value and can occur at any time in the frame provided it is ordered before the matching axis event. Specifically, this sequence is valid: wl_pointer.axis_source wl_pointer.axis_discrete (vert) wl_pointer.axis_discrete (horiz) wl_pointer.axis (horiz) wl_pointer.axis (vert) wl_pointer.frame Enter and leave event also trigger wl_pointer.frame events, where possible the compositor should group leave and subsequent enter into the same frame. This indicates to the client that the pointer has moved between surfaces and may allow a client to shortcut code otherwise triggerd by the leave or enter events. Signed-off-by: Peter Hutterer Reviewed-by: Carlos Garnacho Reviewed-by: Jonas Ådahl Reviewed-by: Daniel Stone Reviewed-by: Bryce Harrington

protocol: specify behavior of get_pointer when capabilities change

2015-12-07T22:26:47Z

Also applies to touch/keyboard Signed-off-by: Peter Hutterer Reviewed-by: Daniel Stone Reviewed-by: Derek Foreman Reviewed-by: Jonas Ådahl

protocol: Add wl_surface.damage_buffer

2015-12-03T15:19:08Z

wl_surface.damage uses surface local co-ordinates. Buffer scale and buffer transforms came along, and EGL surfaces have no understanding of them. Theoretically, clients pass damage rectangles - in Y-inverted surface co-ordinates) to EGLSwapBuffersWithDamage, and the EGL implementation passed them on to wayland. However, for this to work the EGL implementation must be able to flip those rectangles into the space the compositor is expecting, but it's unable to do so because it doesn't know the height of the transformed buffer. So, currently, EGLSwapBuffersWithDamage is unusable and EGLSwapBuffers has to pass (0,0) - (INT32_MAX, INT32_MAX) damage to function. wl_surface.damage_buffer allows damage to be registered on a surface in buffer co-ordinates, avoiding this problem. Credit where it's due, these ideas are not entirely my own: Over a year ago the idea of changing damage co-ordinates to buffer co-ordinates was suggested (by Jason Ekstrand), and it was at least partially rejected and abandoned. At the time it was also suggested (by Pekka Paalanen) that adding a new wl_surface.damage_buffer request was another option. This will eventually resolve: https://bugs.freedesktop.org/show_bug.cgi?id=78190 by making the problem irrelevant. Reviewed-by: Pekka Paalanen Reviewed-by: Jason Ekstrand Signed-off-by: Derek Foreman Reviewed-by: Jonas Ådahl

protocol: fix a couple of whitespace issues

2015-11-24T07:48:27Z

8 spaces is one tab Signed-off-by: Peter Hutterer

protocol: Remove incorrect statement that attach must precede damage

2015-11-20T16:25:33Z

The documentation for wl_surface.commit makes it clear that the application of damage follows attach during the commit, so it doesn't matter what order the app sends the requests. Many existing apps post damage before attaching a buffer already, and it's really quite reasonable to do so. Signed-off-by: Derek Foreman Reviewed-by: Jonas Ådahl Reviewed-by: Daniel Stone

protocol: add the new bitfields to the dtd

2015-11-17T12:36:21Z

See 851614fa78862499e016c5718e730fefbb8e3b73 Signed-off-by: Peter Hutterer Reviewed-by: Auke Booij Reviewed-by: Pekka Paalanen

protocol: allow for a element below

2015-11-17T12:36:21Z

The scanner parses this already, it doesn't do anything with it though. The DTD requires the order to be copyright, description, then the interfaces. That's largely a DTD limitation, the scanner doesn't care. Signed-off-by: Peter Hutterer Reviewed-by: Pekka Paalanen

Revert "Remove protocol/wayland.dtd"

2015-11-17T12:36:21Z

This reverts commit 06fb8bd371403d43bc192577abd6b0a0c8b29c59. Having a DTD hooked up gives an indication of what we expect the protocol to be, which is a clearer documentation than the current "whatever scanner.c manages to parse". Signed-off-by: Peter Hutterer Reviewed-by: Pekka Paalanen

protocol: specify enum and bitfield attributes

2015-11-04T22:50:45Z

Signed-off-by: Auke Booij Reviewed-by: Nils Chr. Brause Reviewed-by: Bryce Harrington Acked-by: Victor Berger

Remove protocol/wayland.dtd

2015-10-09T20:32:34Z

The wayland scanner defines the protocol. The DTD specification is not used. Reviewed-by: Pekka Paalanen Reviewed-by: Nils Christopher Brause

wayland: add a release request on wl_seat

2015-10-08T00:31:57Z

This is required if we want to correctly remove a wl_seat compositor-side. A wl_seat is announced as a global object, then it is bound by the client. When the compositor wants to remove the seat, it shall announce the global removal of the object. The client can then call the release request on the wl_seat (which means I won't use that object anymore). Acked-by: Derek Foreman Reviewed-by: Jonas Ådahl

protocol: Update boilerplate from MIT X11 license to MIT Expat license

2015-06-12T22:51:38Z

Signed-off-by: Bryce Harrington Reviewed-by: Pekka Paalanen

protocol: add better description of wl_pointer.release

2015-03-30T11:23:18Z

Add note about what all wl_pointer.release does. Mainly that it destroys the proxy object, so programmer must not call wl_pointer_destroy() on the pointer any further. Signed-off-by: Marek Chalupa Reviewed-by: Pekka Paalanen

Spelling fixes (cosmetic)

2015-03-19T14:56:17Z

A few typos in comments and protocol docs, no code changes. ./src/wayland-util.h:281: recieved ==> received ./src/wayland-client.c:115: occured ==> occurred ./src/wayland-client.c:156: occured ==> occurred ./tests/test-compositor.c:76: parallely ==> parallelly ./tests/test-compositor.c:474: recieve ==> receive ./protocol/wayland.xml:1767: layed ==> laid ./protocol/wayland.xml:2112: dependant ==> dependent ./doc/publican/sources/Client.xml:25: recieved ==> received Signed-off-by: Bryce Harrington Reviewed-by: Bill Spitzak

protocol: Change wording of subsurface placement scheduling

2015-03-04T07:47:48Z

Change wording to be more consistent with other parts of the subsurface protocol. Before this change, wl_subsurface.set_position explicitly stated that the new state was to be applied on the parents wl_surface.commit and wl_subsurface.place_above/below only said "on the next commit of the parent surface". What "committed" means is ambiguous considering that a wl_surface.commit actually defers the actual commit when in synchronized mode, but the intention has always been that placement of a subsurface should be considered part of its content, i.e. placement state should be applied when other state (buffer, regions). This patch makes that more clear. Note that prior to this patch, one could correctly have interpreted the protocol meaning that placements operations takes effect explicitly on wl_surface.commit of the parent surface no matter whether other state of the parent surface is applied at that point. This patch clarifies that that is not the case. https://bugs.freedesktop.org/show_bug.cgi?id=88857 Signed-off-by: Jonas Ådahl Acked-by: Jasper St. Pierre Reviewed-by: Pekka Paalanen

wayland.xml: fixed a typo

2015-02-25T20:38:26Z

protocol: Clarify selection data offer destruction requirement

2015-01-24T02:20:35Z

Clarify that a client receiving a wl_data_device.selection event must destroy the data_offer of the previous wl_data_device.selection event, if any. Signed-off-by: Jonas Ådahl

protocol: Fix typo in wl_data_offer

2015-01-24T02:20:29Z

Signed-off-by: Jonas Ådahl

Protocol : Added destructor to wl_data_device interface

2014-11-04T13:04:29Z

[Pekka Paalanen: removed trailing whitespace, adjust bz link.] Bug: https://bugs.freedesktop.org/show_bug.cgi?id=81745 Signed-off-by: kabeer khan Reviewed-by: Pekka Paalanen

protocol: define error codes for role reassignment

2014-10-08T10:09:56Z

On the interfaces where it was missing: - wl_data_device - wl_shell - wl_pointer add an error code for requests that set a wl_surface role when the wl_surface already has a different role. This is needed for compositors to appropriately report wl_surface role violations. Signed-off-by: Pekka Paalanen Reviewed-by: Jasper St. Pierre Acked-by: Jason Ekstrand

protocol: wl_shell.get_shell_surface gives a role

2014-10-01T08:50:48Z

Now that we have defined "role", use the term. Signed-off-by: Pekka Paalanen Reviewed-by: Jason Ekstrand

protocol: wl_subcompositor.get_subsurface gives a role

2014-10-01T08:50:48Z

Reword the conditions to make use of the definition of "role". It is still forbidden to create more than one wl_subsurface for a wl_surface at a time. Signed-off-by: Pekka Paalanen Reviewed-by: Jason Ekstrand

protocol: wl_data_device.start_drag may give a role

2014-10-01T08:50:47Z

Now that we have defined "role", use the term. Signed-off-by: Pekka Paalanen Reviewed-by: Jason Ekstrand

protocol: wl_pointer.set_cursor gives a role

2014-10-01T08:50:47Z

Now that we have defined "role", use the term. Signed-off-by: Pekka Paalanen Reviewed-by: Jason Ekstrand

protocol: define the concept of wl_surface role

2014-10-01T08:50:47Z

Define what a role is, and what restrictions there are. A change to existing behaviour is that a role cannot be changed at all once set. However, this is unlikely to cause problems, as there is no reason to re-use wl_surfaces in clients. v2: give more concrete examples of roles, define losing a role, Jasper rewrote the paragraph on how a role is set. v3: make role permanent, there is no such thing as "losing a role". Re-issuing the same role again must be allowed for wl_pointer.set_cursor et al. to work. v4: clarify the semantics of destroying a role object. Signed-off-by: Pekka Paalanen Reviewed-by: Jason Ekstrand

wl_surface: clarify the base of time passed in the callback of frame

2014-08-21T07:01:17Z

Signed-off-by: Ryo Munakata Reviewed-by: Pekka Paalanen

protocol: add repeat_info event to wl_keyboard

2014-07-25T12:02:32Z

In the process wl_keyboard's version has been incremented. Given clients get the wl_keyboard from wl_seat without a version, wl_seat's version has also been incremented (wl_seat version 4 implies wl_keyboard version 4). earlier Acked-by: Daniel Stone Reviewed-by: Pekka Paalanen

protocol: remove redundant 'the' in description

2014-06-18T23:09:49Z

Signed-off-by: Silvan Jegen

protocol: add wl_surface errors enum for bad scale and transform values

2014-06-03T06:59:35Z

protocol: Fix order of wl_pointer, wl_keyboard and wl_touch messages

2014-05-09T21:30:14Z

The "release" message of wl_pointer, wl_keyboard and wl_touch introduced in version 3 was placed first in the respective interface XML element, causing wayland-scanner to misbehave and set the version number of the "release" message to all subsequent messages with no explicitly specified "since" version. Signed-off-by: Jonas Ådahl

shm: Disallow shrinking shm pools

2014-04-07T23:01:25Z

Unused shm space will be automatically reclaimed if unused or can be explicitly returned by using fallocate FALLOC_FL_PUNCH_HOLE. https://bugs.freedesktop.org/show_bug.cgi?id=74632

protocol: Document how clients are supposed to get the xkb keycode

2014-04-01T23:47:04Z

This encodes what everyone is doing and avoids other implementers having to guess.

protocol: try to clarify frame callback semantics

2014-03-11T16:09:55Z

"the callback event will arrive after the next output refresh" is wrong, if you interpret "output refresh" as framebuffer flip or the moment when the new pixels turn into light the first time. Weston has probably never worked this way. Weston triggers the frame callbacks when it submits repainting commands to the GPU, which is before the framebuffer flip. Strike the incorrect claim, and the rest of the paragraph which no longer offers useful information. As a replacement, expand on the "throttling and driving animations" characteristic. The main purpose is to let clients animate at the display refresh rate, while avoiding drawing frames that will never be presented. The new claim is that the server should give some time between triggering frame callbacks and repainting itself, for clients to draw and commit. This is somewhat intimate with the repaint scheduling algorithm a compositor uses, but hopefully the right intention. Another point of this update is to imply, that frame callbacks should not be used to count compositor repaint cycles nor monitor refresh cycles. It has never been guaranteed to work. Removing the mention of frame callback without an attach hopefully discourages such use. v2: Don't just remove a paragraph, but add useful information about the request's intent. v3: Specify the order of posting frame callbacks. Signed-off-by: Pekka Paalanen Cc: Axel Davy Cc: Jason Ekstrand

build: Move protocol/ Makefile.am into toplevel Makefile.am

2014-02-18T22:55:09Z

A small step towards non-recursive build system for wayland too.

build: Stop using xmllint to validate protocol files

2014-02-18T22:52:02Z

Same reason as commit cd31275f28b0a04d2ec5426dc81e875197b47e52 from weston: The scanner needs to be good enough. If it crashes or fails to report invalid input, that needs to get fixed.

protocol: when buffer transform and scale change

2014-02-10T05:08:47Z

Clarify when the pending and current buffer transform and scale values change, and what exactly happens on commit. This matches what Weston currently does. Signed-off-by: Pekka Paalanen

protocol: Fix build

2014-01-31T21:35:07Z

"data" is the name of the void* argument in the implementation. While we probably shouldn't use such an easily-collidable name, just rename the callback's argument to callback_data for now.

protocol: Fix documentation for the parameter of wl_callback

2014-01-31T21:10:12Z

The parameter here is an opaque integer, rather than the event serial. The "frame" callback uses this to pass the current time of day in milliseconds.

protocol: Fix the name of the registry argument

2014-01-31T21:10:12Z

A simple copy-paste typo.

protocol: Clarify semantics of wl_subsurface.set_position

2014-01-20T06:43:13Z

Make it clear that multiple requests before commit are allowed and how it is handled. Signed-off-by: Jonas Ådahl Reviewed-by: Jasper St. Pierre

protocol: Clarify semantics of sub-surface placement requests

2014-01-20T06:42:44Z

Clarify some semantics of wl_subsurface.place_below and wl_subsurface.place_below that were not specified. Signed-off-by: Jonas Ådahl Reviewed-by: Jasper St. Pierre

Update .gitignore for protocol/

2013-11-19T21:26:04Z

protocol: add sub-surfaces to the core

2013-11-16T04:49:36Z

The sub-surface protocol was originally committed into Weston on May 10th, 2013, in commit 2396aec6842c709a714f3825dbad9fd88478f2e6. The design for the protocol had started in the beginning of December 2012. I think it is high time to move this into the core now. This patch copies the sub-surface protocol as it was in Weston on Nov 15th, 2013, into Wayland. Weston gets a patch to remove the protocol from there. Sub-surface is a wl_surface role. You create a wl_surface as usual, and assign it the sub-surface role and a parent wl_surface. Sub-surfaces are an integral part of the parent surface, and stay glued to the parent. For window management, a window is the union of the top-level wl_surface and all its sub-surfaces. Sub-surfaces are not clipped to the parent, and the union of the surface tree can be larger than the (top-level) wl_surface at its root. The representative use case for sub-surfaces is a video player window. When the video content is given its own wl_surface, there is no need to modify the video frame contents after decoding or copy them into a whole window sized buffer before submitting it to the compositor. This allows efficient, zero-copy video presentation paths, where video decoding hardware produces a (YUV) buffer, which eventually ends up in a (YUV-capable) hardware overlay and is scanned out directly. This can also be used for zero-copy presentation of windowed OpenGL content, where the OpenGL rendering engine does not need to draw or avoid window decorations. Sub-surfaces allow mixing different buffer types into the same window, e.g. software-rendered decorations in wl_shm buffers, and live content in EGL-based buffers. However, the sub-surface extension does not offer clipping or scaling facilities, or accurate presentation timing. Those are topics for additional extensions. Signed-off-by: Pekka Paalanen

protocol: validate the protocol against a dtd

2013-10-25T17:58:06Z

The scanner is not very forgiving if the protocol doesn't match it's expectations and crashes without much of a notice. Thus, validate the protocol against a DTD. Move the protocol subdir forward so we validate first before trying anything else, and install the DTD so we can validate weston's protocols as well.

protocol: Fix typo in documentation

2013-10-11T17:04:43Z

Export the Wayland protocol XML file

2013-09-22T04:48:56Z

Signed-off-by: Jason Ekstrand

protocol: Add release requests for wl_pointer, wl_keyboard, and wl_touch

2013-08-30T22:46:41Z

We missed destroy requests in the 1.0 protocol and since the scanner generates local-only *_destroy requests in that case we can't add destroy requests without breaking protocol. A client needs to verify that the server provides a version 3 seat to use the protocol destructor so the name needs to be something else than wl_*_destroy. v2 (Rob Bradford): Rebased, bumped the protocol versions and added since attributes to the requests.

protocol: Improve a bit of grammar for wl_surface::attach description

2013-08-13T04:25:48Z