GI.Gdk.Objects.FrameClock

A FrameClock tells the application when to update and repaint a window. This may be synced to the vertical refresh rate of the monitor, for example. Even when the frame clock uses a simple timer rather than a hardware-based vertical sync, the frame clock helps because it ensures everything paints at the same time (reducing the total number of frames). The frame clock can also automatically stop painting when it knows the frames will not be visible, or scale back animation framerates.

FrameClock is designed to be compatible with an OpenGL-based implementation or with mozRequestAnimationFrame in Firefox, for example.

A frame clock is idle until someone requests a frame with frameClockRequestPhase. At some later point that makes sense for the synchronization being implemented, the clock will process a frame and emit signals for each phase that has been requested. (See the signals of the FrameClock class for documentation of the phases. FrameClockPhaseUpdate and the FrameClock::update signal are most interesting for application writers, and are used to update the animations, using the frame time given by frameClockGetFrameTime.

The frame time is reported in microseconds and generally in the same timescale as getMonotonicTime, however, it is not the same as getMonotonicTime. The frame time does not advance during the time a frame is being painted, and outside of a frame, an attempt is made so that all calls to frameClockGetFrameTime that are called at a “similar” time get the same value. This means that if different animations are timed by looking at the difference in time between an initial value from frameClockGetFrameTime and the value inside the FrameClock::update signal of the clock, they will stay exactly synchronized.

Exported types

newtype FrameClock

Constructors

FrameClock (ManagedPtr FrameClock)

Instances

GObject FrameClock

Methods

gobjectType :: FrameClock -> IO GType

IsObject FrameClock

IsFrameClock FrameClock

((~) * info (ResolveFrameClockMethod t FrameClock), MethodInfo * info FrameClock p) => IsLabel t (FrameClock -> p)

Methods

fromLabel :: Proxy# Symbol t -> FrameClock -> p

((~) * info (ResolveFrameClockMethod t FrameClock), MethodInfo * info FrameClock p) => IsLabelProxy t (FrameClock -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> FrameClock -> p

HasAttributeList * FrameClock

type AttributeList FrameClock

type AttributeList FrameClock

type SignalList FrameClock

type SignalList FrameClock

class GObject o => IsFrameClock o

Instances

(GObject a, UnknownAncestorError Constraint FrameClock a) => IsFrameClock a

IsFrameClock FrameClock

toFrameClock :: IsFrameClock o => o -> IO FrameClock

noFrameClock :: Maybe FrameClock

Methods

beginUpdating

data FrameClockBeginUpdatingMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsFrameClock a) => MethodInfo * FrameClockBeginUpdatingMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameClockBeginUpdatingMethodInfo a -> signature -> s

frameClockBeginUpdating

Arguments

:: (HasCallStack, MonadIO m, IsFrameClock a)

=> a

frameClock: a FrameClock

-> m ()

Starts updates for an animation. Until a matching call to frameClockEndUpdating is made, the frame clock will continually request a new frame with the FrameClockPhaseUpdate phase. This function may be called multiple times and frames will be requested until frameClockEndUpdating is called the same number of times.

Since: 3.8

endUpdating

data FrameClockEndUpdatingMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsFrameClock a) => MethodInfo * FrameClockEndUpdatingMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameClockEndUpdatingMethodInfo a -> signature -> s

frameClockEndUpdating

Arguments

:: (HasCallStack, MonadIO m, IsFrameClock a)

=> a

frameClock: a FrameClock

-> m ()

Stops updates for an animation. See the documentation for frameClockBeginUpdating.

Since: 3.8

getCurrentTimings

data FrameClockGetCurrentTimingsMethodInfo

Instances

((~) * signature (m (Maybe FrameTimings)), MonadIO m, IsFrameClock a) => MethodInfo * FrameClockGetCurrentTimingsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameClockGetCurrentTimingsMethodInfo a -> signature -> s

frameClockGetCurrentTimings

Arguments

:: (HasCallStack, MonadIO m, IsFrameClock a)

=> a

frameClock: a FrameClock

-> m (Maybe FrameTimings)

Returns: the FrameTimings for the frame currently being processed, or even no frame is being processed, for the previous frame. Before any frames have been procesed, returns Nothing.

Gets the frame timings for the current frame.

Since: 3.8

getFrameCounter

data FrameClockGetFrameCounterMethodInfo

Instances

((~) * signature (m Int64), MonadIO m, IsFrameClock a) => MethodInfo * FrameClockGetFrameCounterMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameClockGetFrameCounterMethodInfo a -> signature -> s

frameClockGetFrameCounter

Arguments

:: (HasCallStack, MonadIO m, IsFrameClock a)

=> a

frameClock: a FrameClock

-> m Int64

Returns: inside frame processing, the value of the frame counter for the current frame. Outside of frame processing, the frame counter for the last frame.

A FrameClock maintains a 64-bit counter that increments for each frame drawn.

Since: 3.8

getFrameTime

data FrameClockGetFrameTimeMethodInfo

Instances

((~) * signature (m Int64), MonadIO m, IsFrameClock a) => MethodInfo * FrameClockGetFrameTimeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameClockGetFrameTimeMethodInfo a -> signature -> s

frameClockGetFrameTime

Arguments

:: (HasCallStack, MonadIO m, IsFrameClock a)

=> a

frameClock: a FrameClock

-> m Int64

Returns: a timestamp in microseconds, in the timescale of of getMonotonicTime.

Gets the time that should currently be used for animations. Inside the processing of a frame, it’s the time used to compute the animation position of everything in a frame. Outside of a frame, it's the time of the conceptual “previous frame,” which may be either the actual previous frame time, or if that’s too old, an updated time.

Since: 3.8

getHistoryStart

data FrameClockGetHistoryStartMethodInfo

Instances

((~) * signature (m Int64), MonadIO m, IsFrameClock a) => MethodInfo * FrameClockGetHistoryStartMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameClockGetHistoryStartMethodInfo a -> signature -> s

frameClockGetHistoryStart

Arguments

:: (HasCallStack, MonadIO m, IsFrameClock a)

=> a

frameClock: a FrameClock

-> m Int64

Returns: the frame counter value for the oldest frame that is available in the internal frame history of the FrameClock.

FrameClock internally keeps a history of FrameTimings objects for recent frames that can be retrieved with frameClockGetTimings. The set of stored frames is the set from the counter values given by frameClockGetHistoryStart and frameClockGetFrameCounter, inclusive.

Since: 3.8

getRefreshInfo

data FrameClockGetRefreshInfoMethodInfo

Instances

((~) * signature (Int64 -> Int64 -> Int64 -> m ()), MonadIO m, IsFrameClock a) => MethodInfo * FrameClockGetRefreshInfoMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameClockGetRefreshInfoMethodInfo a -> signature -> s

frameClockGetRefreshInfo

Arguments

:: (HasCallStack, MonadIO m, IsFrameClock a)

=> a

frameClock: a FrameClock

-> Int64

baseTime: base time for determining a presentaton time

-> Int64

refreshIntervalReturn: a location to store the determined refresh interval, or Nothing. A default refresh interval of 1/60th of a second will be stored if no history is present.

-> Int64

presentationTimeReturn: a location to store the next candidate presentation time after the given base time. 0 will be will be stored if no history is present.

-> m ()

Using the frame history stored in the frame clock, finds the last known presentation time and refresh interval, and assuming that presentation times are separated by the refresh interval, predicts a presentation time that is a multiple of the refresh interval after the last presentation time, and later than baseTime.

Since: 3.8

getTimings

data FrameClockGetTimingsMethodInfo

Instances

((~) * signature (Int64 -> m (Maybe FrameTimings)), MonadIO m, IsFrameClock a) => MethodInfo * FrameClockGetTimingsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameClockGetTimingsMethodInfo a -> signature -> s

frameClockGetTimings

Arguments

:: (HasCallStack, MonadIO m, IsFrameClock a)

=> a

frameClock: a FrameClock

-> Int64

frameCounter: the frame counter value identifying the frame to be received.

-> m (Maybe FrameTimings)

Returns: the FrameTimings object for the specified frame, or Nothing if it is not available. See frameClockGetHistoryStart.

Retrieves a FrameTimings object holding timing information for the current frame or a recent frame. The FrameTimings object may not yet be complete: see frameTimingsGetComplete.

Since: 3.8

requestPhase

data FrameClockRequestPhaseMethodInfo

Instances

((~) * signature ([FrameClockPhase] -> m ()), MonadIO m, IsFrameClock a) => MethodInfo * FrameClockRequestPhaseMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameClockRequestPhaseMethodInfo a -> signature -> s

frameClockRequestPhase

Arguments

:: (HasCallStack, MonadIO m, IsFrameClock a)

=> a

frameClock: a FrameClock

-> [FrameClockPhase]

phase: the phase that is requested

-> m ()

Asks the frame clock to run a particular phase. The signal corresponding the requested phase will be emitted the next time the frame clock processes. Multiple calls to frameClockRequestPhase will be combined together and only one frame processed. If you are displaying animated content and want to continually request the FrameClockPhaseUpdate phase for a period of time, you should use frameClockBeginUpdating instead, since this allows GTK+ to adjust system parameters to get maximally smooth animations.

Since: 3.8

Signals

afterPaint

type C_FrameClockAfterPaintCallback = Ptr () -> Ptr () -> IO ()

type FrameClockAfterPaintCallback = IO ()

data FrameClockAfterPaintSignalInfo

Instances

SignalInfo FrameClockAfterPaintSignalInfo

Associated Types

type HaskellCallbackType FrameClockAfterPaintSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FrameClockAfterPaintSignalInfo -> o -> HaskellCallbackType FrameClockAfterPaintSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FrameClockAfterPaintSignalInfo

type HaskellCallbackType FrameClockAfterPaintSignalInfo = FrameClockAfterPaintCallback

afterFrameClockAfterPaint :: (GObject a, MonadIO m) => a -> FrameClockAfterPaintCallback -> m SignalHandlerId

genClosure_FrameClockAfterPaint :: FrameClockAfterPaintCallback -> IO Closure

mk_FrameClockAfterPaintCallback :: C_FrameClockAfterPaintCallback -> IO (FunPtr C_FrameClockAfterPaintCallback)

noFrameClockAfterPaintCallback :: Maybe FrameClockAfterPaintCallback

onFrameClockAfterPaint :: (GObject a, MonadIO m) => a -> FrameClockAfterPaintCallback -> m SignalHandlerId

wrap_FrameClockAfterPaintCallback :: FrameClockAfterPaintCallback -> Ptr () -> Ptr () -> IO ()

beforePaint

type C_FrameClockBeforePaintCallback = Ptr () -> Ptr () -> IO ()

type FrameClockBeforePaintCallback = IO ()

data FrameClockBeforePaintSignalInfo

Instances

SignalInfo FrameClockBeforePaintSignalInfo

Associated Types

type HaskellCallbackType FrameClockBeforePaintSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FrameClockBeforePaintSignalInfo -> o -> HaskellCallbackType FrameClockBeforePaintSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FrameClockBeforePaintSignalInfo

type HaskellCallbackType FrameClockBeforePaintSignalInfo = FrameClockBeforePaintCallback

afterFrameClockBeforePaint :: (GObject a, MonadIO m) => a -> FrameClockBeforePaintCallback -> m SignalHandlerId

genClosure_FrameClockBeforePaint :: FrameClockBeforePaintCallback -> IO Closure

mk_FrameClockBeforePaintCallback :: C_FrameClockBeforePaintCallback -> IO (FunPtr C_FrameClockBeforePaintCallback)

noFrameClockBeforePaintCallback :: Maybe FrameClockBeforePaintCallback

onFrameClockBeforePaint :: (GObject a, MonadIO m) => a -> FrameClockBeforePaintCallback -> m SignalHandlerId

wrap_FrameClockBeforePaintCallback :: FrameClockBeforePaintCallback -> Ptr () -> Ptr () -> IO ()

flushEvents

type C_FrameClockFlushEventsCallback = Ptr () -> Ptr () -> IO ()

type FrameClockFlushEventsCallback = IO ()

data FrameClockFlushEventsSignalInfo

Instances

SignalInfo FrameClockFlushEventsSignalInfo

Associated Types

type HaskellCallbackType FrameClockFlushEventsSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FrameClockFlushEventsSignalInfo -> o -> HaskellCallbackType FrameClockFlushEventsSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FrameClockFlushEventsSignalInfo

type HaskellCallbackType FrameClockFlushEventsSignalInfo = FrameClockFlushEventsCallback

afterFrameClockFlushEvents :: (GObject a, MonadIO m) => a -> FrameClockFlushEventsCallback -> m SignalHandlerId

genClosure_FrameClockFlushEvents :: FrameClockFlushEventsCallback -> IO Closure

mk_FrameClockFlushEventsCallback :: C_FrameClockFlushEventsCallback -> IO (FunPtr C_FrameClockFlushEventsCallback)

noFrameClockFlushEventsCallback :: Maybe FrameClockFlushEventsCallback

onFrameClockFlushEvents :: (GObject a, MonadIO m) => a -> FrameClockFlushEventsCallback -> m SignalHandlerId

wrap_FrameClockFlushEventsCallback :: FrameClockFlushEventsCallback -> Ptr () -> Ptr () -> IO ()

layout

type C_FrameClockLayoutCallback = Ptr () -> Ptr () -> IO ()

type FrameClockLayoutCallback = IO ()

data FrameClockLayoutSignalInfo

Instances

SignalInfo FrameClockLayoutSignalInfo

Associated Types

type HaskellCallbackType FrameClockLayoutSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FrameClockLayoutSignalInfo -> o -> HaskellCallbackType FrameClockLayoutSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FrameClockLayoutSignalInfo

type HaskellCallbackType FrameClockLayoutSignalInfo = FrameClockLayoutCallback

afterFrameClockLayout :: (GObject a, MonadIO m) => a -> FrameClockLayoutCallback -> m SignalHandlerId

genClosure_FrameClockLayout :: FrameClockLayoutCallback -> IO Closure

mk_FrameClockLayoutCallback :: C_FrameClockLayoutCallback -> IO (FunPtr C_FrameClockLayoutCallback)

noFrameClockLayoutCallback :: Maybe FrameClockLayoutCallback

onFrameClockLayout :: (GObject a, MonadIO m) => a -> FrameClockLayoutCallback -> m SignalHandlerId

wrap_FrameClockLayoutCallback :: FrameClockLayoutCallback -> Ptr () -> Ptr () -> IO ()

paint

type C_FrameClockPaintCallback = Ptr () -> Ptr () -> IO ()

type FrameClockPaintCallback = IO ()

data FrameClockPaintSignalInfo

Instances

SignalInfo FrameClockPaintSignalInfo

Associated Types

type HaskellCallbackType FrameClockPaintSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FrameClockPaintSignalInfo -> o -> HaskellCallbackType FrameClockPaintSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FrameClockPaintSignalInfo

type HaskellCallbackType FrameClockPaintSignalInfo = FrameClockPaintCallback

afterFrameClockPaint :: (GObject a, MonadIO m) => a -> FrameClockPaintCallback -> m SignalHandlerId

genClosure_FrameClockPaint :: FrameClockPaintCallback -> IO Closure

mk_FrameClockPaintCallback :: C_FrameClockPaintCallback -> IO (FunPtr C_FrameClockPaintCallback)

noFrameClockPaintCallback :: Maybe FrameClockPaintCallback

onFrameClockPaint :: (GObject a, MonadIO m) => a -> FrameClockPaintCallback -> m SignalHandlerId

wrap_FrameClockPaintCallback :: FrameClockPaintCallback -> Ptr () -> Ptr () -> IO ()

resumeEvents

type C_FrameClockResumeEventsCallback = Ptr () -> Ptr () -> IO ()

type FrameClockResumeEventsCallback = IO ()

data FrameClockResumeEventsSignalInfo

Instances

SignalInfo FrameClockResumeEventsSignalInfo

Associated Types

type HaskellCallbackType FrameClockResumeEventsSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FrameClockResumeEventsSignalInfo -> o -> HaskellCallbackType FrameClockResumeEventsSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FrameClockResumeEventsSignalInfo

type HaskellCallbackType FrameClockResumeEventsSignalInfo = FrameClockResumeEventsCallback

afterFrameClockResumeEvents :: (GObject a, MonadIO m) => a -> FrameClockResumeEventsCallback -> m SignalHandlerId

genClosure_FrameClockResumeEvents :: FrameClockResumeEventsCallback -> IO Closure

mk_FrameClockResumeEventsCallback :: C_FrameClockResumeEventsCallback -> IO (FunPtr C_FrameClockResumeEventsCallback)

noFrameClockResumeEventsCallback :: Maybe FrameClockResumeEventsCallback

onFrameClockResumeEvents :: (GObject a, MonadIO m) => a -> FrameClockResumeEventsCallback -> m SignalHandlerId

wrap_FrameClockResumeEventsCallback :: FrameClockResumeEventsCallback -> Ptr () -> Ptr () -> IO ()

update

type C_FrameClockUpdateCallback = Ptr () -> Ptr () -> IO ()

type FrameClockUpdateCallback = IO ()

data FrameClockUpdateSignalInfo

Instances

SignalInfo FrameClockUpdateSignalInfo

Associated Types

type HaskellCallbackType FrameClockUpdateSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FrameClockUpdateSignalInfo -> o -> HaskellCallbackType FrameClockUpdateSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FrameClockUpdateSignalInfo

type HaskellCallbackType FrameClockUpdateSignalInfo = FrameClockUpdateCallback

afterFrameClockUpdate :: (GObject a, MonadIO m) => a -> FrameClockUpdateCallback -> m SignalHandlerId

genClosure_FrameClockUpdate :: FrameClockUpdateCallback -> IO Closure

mk_FrameClockUpdateCallback :: C_FrameClockUpdateCallback -> IO (FunPtr C_FrameClockUpdateCallback)

noFrameClockUpdateCallback :: Maybe FrameClockUpdateCallback

onFrameClockUpdate :: (GObject a, MonadIO m) => a -> FrameClockUpdateCallback -> m SignalHandlerId

wrap_FrameClockUpdateCallback :: FrameClockUpdateCallback -> Ptr () -> Ptr () -> IO ()