diff options
author | Corentin Noël <corentin.noel@collabora.com> | 2023-04-07 11:04:32 +0200 |
---|---|---|
committer | Corentin Noël <corentin.noel@collabora.com> | 2023-04-07 11:30:40 +0200 |
commit | eeee654031296398c903e3797b434e155948bdac (patch) | |
tree | 44b3a1a270907c7749e15e8d1c0cdb945bf8b45a /clutter/clutter | |
parent | 776e3f329d747e3ac8cd23935e558bedda629846 (diff) | |
download | mutter-eeee654031296398c903e3797b434e155948bdac.tar.gz |
cursor-tracker: Enhance the documentation and increase annotation coverage
Add the (optional) parameters when they are actually supported and at least add
the minimal documentation on functions.
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2951>
Diffstat (limited to 'clutter/clutter')
-rw-r--r-- | clutter/clutter/clutter-seat.c | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/clutter/clutter/clutter-seat.c b/clutter/clutter/clutter-seat.c index 956907b42..1c057325b 100644 --- a/clutter/clutter/clutter-seat.c +++ b/clutter/clutter/clutter-seat.c @@ -679,6 +679,17 @@ clutter_seat_has_touchscreen (ClutterSeat *seat) return has_touchscreen; } +/** + * clutter_seat_query_state: + * @seat: a #ClutterSeat + * @device: a #ClutterInputDevice + * @sequence: (nullable): a #ClutterEventSequence + * @coords: (out caller-allocates) (optional): the coordinates of the pointer + * @modifiers: (out) (optional): the current #ClutterModifierType of the pointer + * + * Returns: %TRUE if @device (or the specific @sequence) is on the stage, %FALSE + * otherwise. + **/ gboolean clutter_seat_query_state (ClutterSeat *seat, ClutterInputDevice *device, |