summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2022-06-06 13:12:15 +0000
committerMatthias Clasen <mclasen@redhat.com>2022-06-06 13:12:15 +0000
commit1f3674cf3e9574fa55cd3a565ec02cd062d4b8f5 (patch)
treec7e7fae114407e08e07f588c0acc5fb15482604e
parenteef0c81be9140a2bb4bf5ec1e405a7d084616de5 (diff)
parentc76069389c8e83af665be676712ef29cb344ddcc (diff)
downloadgtk+-1f3674cf3e9574fa55cd3a565ec02cd062d4b8f5.tar.gz
Merge branch 'matthiasc/for-main' into 'main'
gdk: Improve GdkTimeCoord docs See merge request GNOME/gtk!4795
-rw-r--r--gdk/gdkdevice.h9
1 files changed, 7 insertions, 2 deletions
diff --git a/gdk/gdkdevice.h b/gdk/gdkdevice.h
index cf329499a4..c24c084631 100644
--- a/gdk/gdkdevice.h
+++ b/gdk/gdkdevice.h
@@ -66,10 +66,15 @@ typedef enum
/**
* GdkTimeCoord:
* @time: The timestamp for this event
- * @flags: Flags indicating what axes are present
- * @axes: (array fixed-size=12): axis values
+ * @flags: Flags indicating what axes are present, see [flags@Gdk.AxisFlags]
+ * @axes: (array fixed-size=12): axis values, indexed by [enum@Gdk.AxisUse]
*
* A `GdkTimeCoord` stores a single event in a motion history.
+ *
+ * To check whether an axis is present, check whether the corresponding
+ * flag from the [flags@Gdk.AxisFlags] enumeration is set in the @flags
+ * To access individual axis values, use the values of the values of
+ * the [enum@Gdk.AxisUse] enumerations as indices.
*/
struct _GdkTimeCoord
{