cogl: Fix cogl_frame_info_get_frame_counter docs

The docs previously suggested that `cogl_frame_info_get_frame_counter`
returned a timestamp of an unknown clock ID. That's not correct. The
cogl source code shows that it does and must use the same clock as
`cogl_get_clock_time`.

Related to https://gitlab.gnome.org/GNOME/mutter/issues/131
This commit is contained in:
Daniel van Vugt 2018-06-28 15:46:47 +08:00
parent ff5d561ca6
commit c6691afa38

View File

@ -89,11 +89,8 @@ int64_t cogl_frame_info_get_frame_counter (CoglFrameInfo *info);
* Gets the presentation time for the frame. This is the time at which * Gets the presentation time for the frame. This is the time at which
* the frame became visible to the user. * the frame became visible to the user.
* *
* The presentation time measured in nanoseconds is based on a * The presentation time measured in nanoseconds, is based on
* monotonic time source. The time source is not necessarily * cogl_get_clock_time().
* correlated with system/wall clock time and may represent the time
* elapsed since some undefined system event such as when the system
* last booted.
* *
* <note>Linux kernel version less that 3.8 can result in * <note>Linux kernel version less that 3.8 can result in
* non-monotonic timestamps being reported when using a drm based * non-monotonic timestamps being reported when using a drm based