summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/guide.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/guide.md b/docs/guide.md
index a65972f..62c2e1a 100644
--- a/docs/guide.md
+++ b/docs/guide.md
@@ -224,8 +224,12 @@ meaningless. `POINTER_MOTION` reports `delta`, the device-pixel movement since
the previous sample, which restarts from zero after enter, leave, or reset.
`yasl_surface_set_pointer_mode()` with `YASL_POINTER_RELATIVE` hides and locks the
cursor while the surface is focused; motion then carries unbounded `delta` and
-`pos` stays at the lock position. No backend implements it yet, so it
-currently returns false and leaves the surface in `YASL_POINTER_NORMAL`. Pen
+`pos` stays at the lock position. Wayland implements it with the
+relative-pointer and pointer-constraints protocols, reporting the compositor's
+accelerated motion in device pixels. The compositor decides when the lock
+engages; until then, and while it is released on focus loss, motion stays
+absolute with a computed `delta`. X11, Cocoa, and compositors without those
+protocols return false and keep the current mode. Pen
pressure is normalized to 0..65535, signed tilt is in degrees, and missing axes
are zero. Pressure-only changes can produce motion. Zero pressure alone does
not mean release. This interface does not expose simultaneous touch contacts.