From 18eb7e750288b58ed43ec80cabf9c4db2f58930e Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Mon, 29 Jan 2024 11:47:43 +1100 Subject: [PATCH] Cleanup: correct doc-strings for GHOST_GetMilliSeconds Wayland, macOS & SDL weren't using the start-time of the process. The start-time offset isn't needed so it's similar to forward the systems method of accessing the time in milliseconds. --- intern/ghost/GHOST_C-api.h | 4 ++-- intern/ghost/GHOST_ISystem.hh | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h index d7137509e5e..142796c88d5 100644 --- a/intern/ghost/GHOST_C-api.h +++ b/intern/ghost/GHOST_C-api.h @@ -83,8 +83,8 @@ extern GHOST_TSuccess GHOST_DisposeEventConsumer(GHOST_EventConsumerHandle consu /** * Returns the system time. - * Returns the number of milliseconds since the start of the system process. - * Based on ANSI clock() routine. + * Returns the number of milliseconds since the start of the system. + * * \param systemhandle: The handle to the system. * \return The number of milliseconds. */ diff --git a/intern/ghost/GHOST_ISystem.hh b/intern/ghost/GHOST_ISystem.hh index 9ecde8bdaa6..ec80b9ea395 100644 --- a/intern/ghost/GHOST_ISystem.hh +++ b/intern/ghost/GHOST_ISystem.hh @@ -170,8 +170,10 @@ class GHOST_ISystem { /** * Returns the system time. - * Returns the number of milliseconds since the start of the system process. - * Based on ANSI clock() routine. + * Returns the number of milliseconds since the start of the system. + * \note The exact method used is platform dependent however monotonic methods should be used + * instead of wall-clock time. + * * \return The number of milliseconds. */ virtual uint64_t getMilliSeconds() const = 0;