Commit Graph

153 Commits

Author SHA1 Message Date
Kristian Høgsberg
ea1fb51aae protocol: Add release requests for wl_pointer, wl_keyboard, and wl_touch
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.
2013-08-30 15:46:41 -07:00
Bryce W. Harrington
f169614738 protocol: Improve a bit of grammar for wl_surface::attach description
Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
2013-08-12 21:25:48 -07:00
Bryce W. Harrington
dbc41f0344 protocol: Fix pluralization of user in popup_done description
Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
2013-08-08 21:42:38 -07:00
Bryce W. Harrington
b5e7f9caef protocol: Improve grammar for set class description
Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
2013-08-08 21:42:26 -07:00
Bryce W. Harrington
3d6470b1ef protocol: Add missing d to 'x an y'
Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
2013-08-08 21:41:57 -07:00
Bryce W. Harrington
fecef1ca66 protocol: Fix typo by removing a redundant 'a'
Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
2013-08-08 21:41:44 -07:00
Tomeu Vizoso
03dc786c90 protocol: Copy missing pixel formats from wl_drm to wl_shm 2013-07-29 09:28:12 -07:00
Rob Bradford
2e07587443 protocol: add no_keymap format to keymap formats
This format is used to specify that the key button events received are not in
relation to any key map and that the codes should be interpreted directly.

v2: Use zero for the no keymap enum value and enhance the documentation
for the enum entry.
2013-06-28 19:51:12 -04:00
Rob Bradford
885d057536 protocol: Add missing since attribute for name event on wl_seat
This event was added in version 2 of the protocol.
2013-06-14 14:56:50 -04:00
Kristian Høgsberg
a3870a297c protocol: Move new name event below existing requests and events and version it
Missed v2 of Robs patch that already did this based on feedback from
Ander and Daniel.
2013-06-05 01:08:58 -04:00
Rob Bradford
dce104dcc2 protocol: Add a name event to give seat name
This provides the ability for a client to differentiate events from
different seats in a multiple seat environment.
2013-06-05 00:05:25 -04:00
Alexander Larsson
b693088904 protocol: Modes are specified in HW pixels
Modes are mainly meant to be used in coordination with fullscreen in
DRIVER mode, by e.g. games. For such games what they generally want
is to match some hardware mode and resize their window for that. We
don't really need to complicate this with the scaling. So, we
keep the resolutions in HW pixels, and drop the SCALED flag (as it
is now useless).

This lets you just create e.g an 800x600 buffer of scale 1 and
fullscreen that, ignoring the output scaling factor (although you can
of course also respect it and create a 400x300 surface at scale 2).
Conceptually the mode change is treated like a scaling which overrides
the normal output scale.

The only complexity is the FILL mode where it can happen that the user
specifies a buffer of the same size as the screen, but the output has scale
2 and the buffer scale 1. Just scanning out this buffer will work, but
effectively this is a downscaling operation, as the "real" size of the surface
in pels is twice the size of the output. We solve this by allowing FILL to
downscale (but still not upscale).
2013-05-28 15:40:02 -04:00
Alexander Larsson
e782dbecbc protocol: Use signed int for scale values
We usually use signed ints for things like this, to avoid
issues C sign coersion.
2013-05-28 15:27:36 -04:00
Alexander Larsson
d68c7d8aed protocol: Support scaled outputs and surfaces
This adds the wl_surface.set_buffer_scale request, and a wl_output.scale
event. These together lets us support automatic upscaling of "old"
clients on very high resolution monitors, while allowing "new" clients
to take advantage of this to render at the higher resolution when the
surface is displayed on the scaled output.

It is similar to set_buffer_transform in that the buffer is stored in
a transformed pixels (in this case scaled). This means that if an output
is scaled we can directly use the pre-scaled buffer with additional data,
rather than having to scale it.

Additionally this adds a "scaled" flag to the wl_output.mode flags
so that clients know which resolutions are native and which are scaled.

Also, in places where the documentation was previously not clear as to
what coordinate system was used this was fleshed out.

It also adds a scaling_factor event to wl_output that specifies the
scaling of an output.

This is meant to be used for outputs with a very high DPI to tell the
client that this particular output has subpixel precision. Coordinates
in other parts of the protocol, like input events, relative window
positioning and output positioning are still in the compositor space
rather than the scaled space. However, input has subpixel precision
so you can still get input at full resolution.

This setup means global properties like mouse acceleration/speed,
pointer size, monitor geometry, etc can be specified in a "mostly
similar" resolution even on a multimonitor setup where some monitors
are low dpi and some are e.g. retina-class outputs.
2013-05-22 16:15:33 -04:00
Alexander Larsson
911c068428 protocol: Allow output changes to be treated atomically
This add a wl_output.done event which is send after every group
of events caused by some property change. This allows clients to treat
changes touching multiple events in an atomic fashion.
2013-05-22 16:15:29 -04:00
Peter Hutterer
cfec3aecb9 protocol: revert hotspot_x/y in set_cursor back to int
copy/paste error introduced in 9c0357af6e

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-18 16:28:52 -04:00
Rob Bradford
e7d0a0b0ed protocol: Make it clear that returned "one-shot" objects are destroyed
The objects returned by the frame and sync request are destroyed by the
compositor after the "done" event on the wl_callback interface is fired.
2013-04-18 16:28:52 -04:00
Peter Hutterer
4f7f09b4c8 protocol: input documentation fixes
Fix summary for wl_touch::motion, extend summary for wl_touch::down to match
up/motion a bit better.

Fix a typo in wl_touch, and claim that it's zero or more update events, not
one or more.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-04 16:40:12 -04:00
Peter Hutterer
e5202f76b0 protocol: fix two protocol description 'typos'
Remove "mice, for example", it's described in the wl_pointer interface in
detail. And remove space before the full stop.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-03 15:44:50 -04:00
Peter Hutterer
9c0357af6e protocol: document wl_pointer, wl_keyboard, wl_touch
Most of this should be clear, but let's spell a few things out.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-03 15:44:50 -04:00
Peter Hutterer
4a599e029d protocol: use "summary", not "description" for xkb_v1 format
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-04-03 15:44:50 -04:00
Matthias Clasen
c110fbcb75 docs: Document granularity of timestamps
This information is necessary to make any use of these fields.
2013-04-01 21:43:17 -04:00
Kristian Høgsberg
c7639228b4 docs: Remove mention of touch focus
There is no focused surface for a touch screen.
2013-04-01 20:06:36 -04:00
Matthias Clasen
ab6d96c8c4 docs: Improve wl_region protocol docs
Just cosmetic changes, a few missing periods, and ID was
not capitalized.
2013-04-01 19:59:38 -04:00
Matthias Clasen
4c94024af5 docs: Improve the wl_output protocol docs
Some descriptions were missing.
2013-04-01 19:59:12 -04:00
Matthias Clasen
27eacf423a docs: Improve wl_touch protocol docs
Some descriptions were missing here.
2013-04-01 19:58:06 -04:00
Matthias Clasen
608d81bfd5 docs: Improve wl_keyboard protocol docs
Some descriptions were missing here.
2013-04-01 19:57:28 -04:00
Matthias Clasen
3f4008acb3 docs: Improve wl_pointer protocol docs
Some descriptions were missing here.
2013-04-01 19:56:41 -04:00
Matthias Clasen
53b57a63ee docs: Improve the wl_seat protocol docs
Expand the main description and tell if requests don't have
an effect.
2013-04-01 17:43:31 -04:00
Matthias Clasen
c63a59b802 docs: Improve wl_surface protocol docs
Use NULL consistently. And add some more information in a few
places.
2013-04-01 17:40:14 -04:00
Matthias Clasen
e38f433313 docs: Improve wl_shell/wl_shell_surface docs
Add missing summaries, expand descriptions.
2013-04-01 17:40:14 -04:00
Matthias Clasen
15ec6219e9 docs: Improve the wl_data_* procol docs
Add a few missing summaries and descriptions, spell out file
descriptor, use hyphens in drag-and-drop, don't use hyphens in
'mime type', and reword a few things.
2013-04-01 17:40:14 -04:00
Matthias Clasen
b02e58c718 docs: Improve wl_shm and wl_shm_pool protocol docs
Reword some paragraphs, and spell out 'file descriptor'.
2013-04-01 17:40:14 -04:00
Matthias Clasen
c84155d475 docs: Improve wl_callback protocol docs
Add some information about wl_callback and its done event.
2013-04-01 17:40:14 -04:00
Matthias Clasen
8aa7a690a5 docs: Improve the wl_registry protocol docs
Reword a few things, and add some details.
2013-04-01 17:40:14 -04:00
Matthias Clasen
a5cc5b32bb docs: Improve wl_display protocol docs
This adds a bit of information about in-order event delivery,
removes extraneous formatting, and adds a missing period.
2013-04-01 17:40:14 -04:00
Pekka Paalanen
7165bf2191 protocol: remove implicit attach semantics
To match the Weston commit e7144fd175d1d68b91aa0cec7ab63381b79385a9:
Author: Kristian Høgsberg <krh@bitplanet.net>
Date:   Mon Mar 4 12:11:41 2013 -0500

    compositor: Only send release event in response to wl_surface.attach

Remove the implicit attach semantics from wl_surface.commit and .attach.

Before, if you did this on a wl_surface: attach, commit, commit, you
would receive wl_buffer.release for both commits. After this change, you
will only receive wl_buffer.release for the first commit. To get a
second release, the same buffer must be attached again.

There is no need for the implicit attach on the second commit. If the
compositor needs the wl_buffer for repainting, it will not release it to
begin with. If the compositor does not need to keep the wl_buffer around
for repainting, it will not need it for a new commit either.

Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2013-03-19 16:49:20 -04:00
Ander Conselvan de Oliveira
e8fbce73c7 protocol: Add a wl_surface request for setting buffer transformation
This request allows a client to render its contents according to the
output transform, enabling the compositor to use optimizations such as
overlays, hardware cursors, scan out of a client buffer for
fullscreen surface, etc, even if the output is rotated.
2012-11-27 11:13:38 -05:00
Tiago Vignatti
5df752ab16 doc: Fix typos
Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-11-23 22:51:51 -05:00
Kristian Høgsberg
173e160632 Fix distcheck by adding back protocol/Makefile.am
5909dddc78 removed protocol/Makefile.am
which meant protocol/wayland.xml no longer got included in the tarball.
Add back protocol/Makefile.am and configure.ac bits and add protocol to
subdirs in Makefile.am to fix this.
2012-11-19 17:11:58 -05:00
Kristian Høgsberg
3a671b4d3d protocol: Fix copy and paste summary 2012-11-19 15:44:14 -05:00
Kristian Høgsberg
94fd3d1dd4 protocol: Add summary description for wl_data_device_manager 2012-11-19 15:02:45 -05:00
Tiago Vignatti
5909dddc78 doc: Remove unused css and xslt for the protocol
This was added previously (commit 015c42e1) when we didn't have docbook
formatted documentation. Now it became quite useless.

Signed-off-by: Tiago Vignatti <tiago.vignatti@intel.com>
2012-11-12 16:08:32 -02:00
Kristian Høgsberg
65eef9d817 wayland: Add protocol documentation for various interfaces 2012-10-21 22:08:08 -04:00
Pekka Paalanen
6c3e9b8f54 protocol: try to clarify wl_buffer doc
Fix few typos in wl_buffer description.

Mention backing storage in wl_buffer.destroy.

Try to clarify the wl_buffer.release semantics by not explaining what
*might* happen. It is important to not suggest, that if release does not
come before frame callback, it will not come before attaching a new
buffer to the surface. We want to allow the following scenario:

The compositor is able to texture from wl_buffers directly, but it also
keeps a copy of the surface contents. The copy is updated when the
compositor is idle, to avoid the performance hit on
wl_surface.attach/commit. When the copy completes some time later, the
server sends the release event. If the client has not yet allocated a
second buffer (e.g. it updates rarely), it can reuse the old buffer.

Reported-by: John Kåre Alsaker <john.kare.alsaker@gmail.com>
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-16 11:06:51 -04:00
Pekka Paalanen
cb2296778d protocol: say update instead of repaint
wl_surface.commit itself does not force any repainting unless there is
damage, so change the wording to not imply repainting.

Reported-by: John Kåre Alsaker <john.kare.alsaker@gmail.com>
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-16 10:52:40 -04:00
Jonas Ådahl
de1b471318 protocol: Clarify pointer axis event
Pointer axis events are in the same coordinate space as motion events.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2012-10-16 10:44:13 -04:00
Jonas Ådahl
36e29df2cb protocol: Clarify pointer axis event
Pointer axis events are in the same coordinate space as motion events.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2012-10-15 14:10:24 -04:00
Pekka Paalanen
eb5fae3226 protocol: clarify multiple wl_surface.attach
Explicitly say what happens with the wl_buffer.release event, if you
attach several wl_buffers without a commit in between.

Reported-by: David Herrmann <dh.herrmann@googlemail.com>
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-11 09:58:28 -04:00
Pekka Paalanen
ae8d4b59a4 protocol: fix clarification of input region on drags and pointers
The previous clarification did not follow the current implementation in
Weston, where when a surface stops being a cursor or an icon, it becomes
a plain unmapped surface again.

Rewrite the related paragraphs, and fix some typos while at it.

For start drag, make it explicit of which surface argument we are
talking about.

v2:

Make the input region undefined when the use ends. Most likely no-one
will re-use these surfaces for anything else than the same use case, so
leave some slack for the implementations to avoid useless work on
resetting the regions.

Reported-by: Ander Conselvan de Oliveira <conselvan2@gmail.com>
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2012-10-11 09:45:22 -04:00