Merge branch 'matthiasc/for-main' into 'main'

gdk: Improve GdkTimeCoord docs

See merge request GNOME/gtk!4795
This commit is contained in:
Matthias Clasen 2022-06-06 13:12:15 +00:00
commit 1f3674cf3e

View File

@ -66,10 +66,15 @@ typedef enum
/** /**
* GdkTimeCoord: * GdkTimeCoord:
* @time: The timestamp for this event * @time: The timestamp for this event
* @flags: Flags indicating what axes are present * @flags: Flags indicating what axes are present, see [flags@Gdk.AxisFlags]
* @axes: (array fixed-size=12): axis values * @axes: (array fixed-size=12): axis values, indexed by [enum@Gdk.AxisUse]
* *
* A `GdkTimeCoord` stores a single event in a motion history. * 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 struct _GdkTimeCoord
{ {