| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GLib.Structs.Timer
Description
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.
Synopsis
- newtype Timer = Timer (ManagedPtr Timer)
- type family ResolveTimerMethod (t :: Symbol) o where ...
- data TimerContinueMethodInfo
- timerContinue :: (HasCallStack, MonadIO m) => Timer -> m ()
- data TimerDestroyMethodInfo
- timerDestroy :: (HasCallStack, MonadIO m) => Timer -> m ()
- data TimerElapsedMethodInfo
- timerElapsed :: (HasCallStack, MonadIO m) => Timer -> CULong -> m Double
- data TimerIsActiveMethodInfo
- timerIsActive :: (HasCallStack, MonadIO m) => Timer -> m Bool
- data TimerResetMethodInfo
- timerReset :: (HasCallStack, MonadIO m) => Timer -> m ()
- data TimerStartMethodInfo
- timerStart :: (HasCallStack, MonadIO m) => Timer -> m ()
- data TimerStopMethodInfo
- timerStop :: (HasCallStack, MonadIO m) => Timer -> m ()
Exported types
Memory-managed wrapper type.
Constructors
| Timer (ManagedPtr Timer) |
Instances
Methods
Click to display all available methods, including inherited ones
type family ResolveTimerMethod (t :: Symbol) o where ... Source #
Equations
| ResolveTimerMethod "continue" o = TimerContinueMethodInfo | |
| ResolveTimerMethod "destroy" o = TimerDestroyMethodInfo | |
| ResolveTimerMethod "elapsed" o = TimerElapsedMethodInfo | |
| ResolveTimerMethod "isActive" o = TimerIsActiveMethodInfo | |
| ResolveTimerMethod "reset" o = TimerResetMethodInfo | |
| ResolveTimerMethod "start" o = TimerStartMethodInfo | |
| ResolveTimerMethod "stop" o = TimerStopMethodInfo | |
| ResolveTimerMethod l o = MethodResolutionFailed l o :: Type |
continue
data TimerContinueMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod TimerContinueMethodInfo Timer signature Source # | |
Defined in GI.GLib.Structs.Timer Methods overloadedMethod :: Timer -> signature # | |
| OverloadedMethodInfo TimerContinueMethodInfo Timer Source # | |
Defined in GI.GLib.Structs.Timer Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Timer |
|
| -> m () |
destroy
data TimerDestroyMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod TimerDestroyMethodInfo Timer signature Source # | |
Defined in GI.GLib.Structs.Timer Methods overloadedMethod :: Timer -> signature # | |
| OverloadedMethodInfo TimerDestroyMethodInfo Timer Source # | |
Defined in GI.GLib.Structs.Timer Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Timer |
|
| -> m () |
Destroys a timer, freeing associated resources.
elapsed
data TimerElapsedMethodInfo Source #
Instances
| (signature ~ (CULong -> m Double), MonadIO m) => OverloadedMethod TimerElapsedMethodInfo Timer signature Source # | |
Defined in GI.GLib.Structs.Timer Methods overloadedMethod :: Timer -> signature # | |
| OverloadedMethodInfo TimerElapsedMethodInfo Timer Source # | |
Defined in GI.GLib.Structs.Timer Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Timer |
|
| -> CULong |
|
| -> 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
data TimerIsActiveMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m) => OverloadedMethod TimerIsActiveMethodInfo Timer signature Source # | |
Defined in GI.GLib.Structs.Timer Methods overloadedMethod :: Timer -> signature # | |
| OverloadedMethodInfo TimerIsActiveMethodInfo Timer Source # | |
Defined in GI.GLib.Structs.Timer Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Timer |
|
| -> m Bool |
Exposes whether the timer is currently active.
Since: 2.62
reset
data TimerResetMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod TimerResetMethodInfo Timer signature Source # | |
Defined in GI.GLib.Structs.Timer Methods overloadedMethod :: Timer -> signature # | |
| OverloadedMethodInfo TimerResetMethodInfo Timer Source # | |
Defined in GI.GLib.Structs.Timer Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => 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
data TimerStartMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod TimerStartMethodInfo Timer signature Source # | |
Defined in GI.GLib.Structs.Timer Methods overloadedMethod :: Timer -> signature # | |
| OverloadedMethodInfo TimerStartMethodInfo Timer Source # | |
Defined in GI.GLib.Structs.Timer Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => 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
data TimerStopMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod TimerStopMethodInfo Timer signature Source # | |
Defined in GI.GLib.Structs.Timer Methods overloadedMethod :: Timer -> signature # | |
| OverloadedMethodInfo TimerStopMethodInfo Timer Source # | |
Defined in GI.GLib.Structs.Timer Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Timer |
|
| -> m () |
Marks an end time, so calls to timerElapsed will return the
difference between this end time and the start time.