Skip to content

GLib.Timer

record (struct)

GTimer records a start time, and counts microseconds elapsed since that time.

This is done somewhat differently on different platforms, and can be tricky to get exactly right, so GTimer provides a portable/convenient interface.

Methods

continue_

def continue_(self) -> None

Resumes a timer that has previously been stopped with Timer.stop. Timer.stop must be called before using this function.

destroy

def destroy(self) -> None

Destroys a timer, freeing associated resources.

elapsed

def elapsed(self, microseconds: int) -> float

If timer has been started but not stopped, obtains the time since the timer was started. If timer has been stopped, obtains the elapsed time between the time it was started and the time it was stopped. The return value is the number of seconds elapsed, including any fractional part. The microseconds out parameter is essentially useless.

Parameters:

  • microseconds — return location for the fractional part of seconds elapsed, in microseconds (that is, the total number of microseconds elapsed, modulo 1000000), or None

is_active

def is_active(self) -> bool

Exposes whether the timer is currently active.

reset

def reset(self) -> None

This function is useless; it's fine to call Timer.start on an already-started timer to reset the start time, so Timer.reset serves no purpose.

start

def start(self) -> None

Marks a start time, so that future calls to Timer.elapsed will report the time since Timer.start was called. g_timer_new() automatically marks the start time, so no need to call Timer.start immediately after creating the timer.

stop

def stop(self) -> None

Marks an end time, so calls to Timer.elapsed will return the difference between this end time and the start time.