diff options
Diffstat (limited to 'include/yasl')
| -rw-r--r-- | include/yasl/yasl.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/include/yasl/yasl.h b/include/yasl/yasl.h index 22ed308..de9a62c 100644 --- a/include/yasl/yasl.h +++ b/include/yasl/yasl.h @@ -757,10 +757,12 @@ YASL_API bool yasl_surface_poll_event(struct yasl_surface *s, struct yasl_event * Select absolute or relative (locked) pointer input for a surface. * @param s Surface. * @param mode YASL_POINTER_NORMAL or YASL_POINTER_RELATIVE. - * @return true if the mode is supported by the backend; false leaves NORMAL. + * @return true if the mode is supported; false leaves the current mode. * RELATIVE hides the cursor and locks it while the surface is focused; * POINTER_MOTION then carries unbounded delta. Returning to NORMAL restores - * the cursor selected with yasl_surface_set_cursor(). + * the cursor selected with yasl_surface_set_cursor(). RELATIVE is supported on + * Wayland compositors with the relative-pointer and pointer-constraints + * protocols; X11 and Cocoa return false. */ YASL_API bool yasl_surface_set_pointer_mode(struct yasl_surface *s, enum yasl_pointer_mode mode); |