gi-glib
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

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

Exported types

newtype Timer Source #

Memory-managed wrapper type.

Constructors

Timer (ManagedPtr Timer) 

Instances

Instances details
Eq Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

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

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

BoxedPtr Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

ManagedPtrNewtype Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

HasAttributeList Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

(signature ~ m (), MonadIO m) => OverloadedMethod TimerContinueMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod TimerDestroyMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

(signature ~ (CULong -> m Double), MonadIO m) => OverloadedMethod TimerElapsedMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

(signature ~ m Bool, MonadIO m) => OverloadedMethod TimerIsActiveMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod TimerResetMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod TimerStartMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod TimerStopMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

OverloadedMethodInfo TimerContinueMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

OverloadedMethodInfo TimerDestroyMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

OverloadedMethodInfo TimerElapsedMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

OverloadedMethodInfo TimerIsActiveMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

OverloadedMethodInfo TimerResetMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

OverloadedMethodInfo TimerStartMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

OverloadedMethodInfo TimerStopMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

(info ~ ResolveTimerMethod t Timer, OverloadedMethod info Timer p, HasField t Timer p) => HasField (t :: Symbol) Timer (p :: Type) Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

getField :: Timer -> p #

(info ~ ResolveTimerMethod t Timer, OverloadedMethodInfo info Timer) => IsLabel t (MethodProxy info Timer) Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

fromLabel :: MethodProxy info Timer #

(info ~ ResolveTimerMethod t Timer, OverloadedMethod info Timer p) => IsLabel t (Timer -> p) Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

fromLabel :: Timer -> p #

type AttributeList Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

Click to display all available methods, including inherited ones

Expand

Methods

continue, destroy, elapsed, isActive, reset, start, stop.

Getters

None.

Setters

None.

continue

data TimerContinueMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod TimerContinueMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

OverloadedMethodInfo TimerContinueMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

timerContinue Source #

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

data TimerDestroyMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod TimerDestroyMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

OverloadedMethodInfo TimerDestroyMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

timerDestroy Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Timer

timer: a Timer to destroy.

-> m () 

Destroys a timer, freeing associated resources.

elapsed

data TimerElapsedMethodInfo Source #

Instances

Instances details
(signature ~ (CULong -> m Double), MonadIO m) => OverloadedMethod TimerElapsedMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

OverloadedMethodInfo TimerElapsedMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

timerElapsed Source #

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

data TimerIsActiveMethodInfo Source #

Instances

Instances details
(signature ~ m Bool, MonadIO m) => OverloadedMethod TimerIsActiveMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

OverloadedMethodInfo TimerIsActiveMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

timerIsActive Source #

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

data TimerResetMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod TimerResetMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

OverloadedMethodInfo TimerResetMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

timerReset Source #

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

data TimerStartMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod TimerStartMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

OverloadedMethodInfo TimerStartMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

timerStart Source #

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

data TimerStopMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod TimerStopMethodInfo Timer signature Source # 
Instance details

Defined in GI.GLib.Structs.Timer

Methods

overloadedMethod :: Timer -> signature #

OverloadedMethodInfo TimerStopMethodInfo Timer Source # 
Instance details

Defined in GI.GLib.Structs.Timer

timerStop Source #

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.