summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--legacy/ecore/src/lib/ecore/ecore_timer.c23
1 files changed, 23 insertions, 0 deletions
diff --git a/legacy/ecore/src/lib/ecore/ecore_timer.c b/legacy/ecore/src/lib/ecore/ecore_timer.c
index 36f8c1d8ae..a9758a08ed 100644
--- a/legacy/ecore/src/lib/ecore/ecore_timer.c
+++ b/legacy/ecore/src/lib/ecore/ecore_timer.c
@@ -318,8 +318,18 @@ ecore_timer_pending_get(Ecore_Timer *timer)
318} 318}
319 319
320/** 320/**
321 * Pauses a running timer.
321 * 322 *
323 * @param timer The timer to be paused.
322 * 324 *
325 * The timer callback won't be called while the timer is paused. The remaining
326 * time until the timer expires will be saved, so the timer can be resumed with
327 * that same remaining time to expire, instead of expiring instantly. Use
328 * ecore_timer_thaw() to resume it.
329 *
330 * @note Nothing happens if the timer was already paused.
331 *
332 * @see ecore_timer_thaw()
323 */ 333 */
324EAPI void 334EAPI void
325ecore_timer_freeze(Ecore_Timer *timer) 335ecore_timer_freeze(Ecore_Timer *timer)
@@ -347,6 +357,19 @@ ecore_timer_freeze(Ecore_Timer *timer)
347 timer->frozen = 1; 357 timer->frozen = 1;
348} 358}
349 359
360/**
361 * Resumes a frozen (paused) timer.
362 *
363 * @param timer The timer to be resumed.
364 *
365 * The timer will be resumed from its previous relative position in time. That
366 * means, if it had X seconds remaining until expire when it was paused, it will
367 * be started now with those same X seconds remaining to expire again. But
368 * notice that the interval time won't be touched by this call or by
369 * ecore_timer_freeze().
370 *
371 * @see ecore_timer_freeze()
372 */
350EAPI void 373EAPI void
351ecore_timer_thaw(Ecore_Timer *timer) 374ecore_timer_thaw(Ecore_Timer *timer)
352{ 375{