GI.GLib.Structs.Timer

Opaque datatype that records a start time.

Exported types

newtype Timer

Memory-managed wrapper type.

Constructors

Timer (ManagedPtr Timer)

Instances

Eq Timer

Defined in GI.GLib.Structs.Timer

Methods

(==) :: Timer -> Timer -> Bool

(/=) :: Timer -> Timer -> Bool

ManagedPtrNewtype Timer

Defined in GI.GLib.Structs.Timer

Methods

toManagedPtr :: Timer -> ManagedPtr Timer

BoxedPtr Timer

Defined in GI.GLib.Structs.Timer

Methods

boxedPtrCopy :: Timer -> IO Timer

boxedPtrFree :: Timer -> IO ()

Methods

Overloaded methods

continue

timerContinue

Arguments

:: (HasCallStack, MonadIO m)

=> Timer

timer: a Timer.

-> m ()

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

Since: 2.4

destroy

timerDestroy

Arguments

:: (HasCallStack, MonadIO m)

=> Timer

timer: a Timer to destroy.

-> m ()

Destroys a timer, freeing associated resources.

elapsed

timerElapsed

Arguments

:: (HasCallStack, MonadIO m)

=> Timer

timer: a Timer.

-> CULong

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

-> m Double

Returns: seconds elapsed as a floating point value, including any fractional part.

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.

isActive

timerIsActive

Arguments

:: (HasCallStack, MonadIO m)

=> Timer

timer: a Timer.

-> m Bool

Returns: True if the timer is running, False otherwise

Exposes whether the timer is currently active.

Since: 2.62

reset

timerReset

Arguments

:: (HasCallStack, MonadIO m)

=> Timer

timer: a Timer.

-> m ()

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

start

timerStart

Arguments

:: (HasCallStack, MonadIO m)

=> Timer

timer: a Timer.

-> m ()

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

stop

timerStop

Arguments

:: (HasCallStack, MonadIO m)

=> Timer

timer: a Timer.

-> m ()

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