gdk.frame_clock
Module for [FrameClock] class
Types 3
A #GdkFrameClock 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.
#GdkFrameClock 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 [gdk.frame_clock.FrameClock.requestPhase]. 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 #GdkFrameClock class for documentation of the phases. [gdk.types.FrameClockPhase.Update] and the #GdkFrameClock::update signal are most interesting for application writers, and are used to update the animations, using the frame time given by [gdk.frame_clock.FrameClock.getFrameTime].
The frame time is reported in microseconds and generally in the same timescale as [glib.global.getMonotonicTime], however, it is not the same as [glib.global.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 [gdk.frame_clock.FrameClock.getFrameTime] 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 [gdk.frame_clock.FrameClock.getFrameTime] and the value inside the #GdkFrameClock::update signal of the clock, they will stay exactly synchronized.
FrameClock self()Returns `this`, for use in `with` statements.FrameClockGidBuilder builder()Get builder for [gdk.frame_clock.FrameClock] Returns: New builder objectvoid beginUpdating()Starts updates for an animation. Until a matching call to [gdk.frameclock.FrameClock.endUpdating] is made, the frame clock will continually request a new frame with the [gdk.types.FrameClockPhase.U...void endUpdating()Stops updates for an animation. See the documentation for [gdk.frame_clock.FrameClock.beginUpdating].gdk.frame_timings.FrameTimings getCurrentTimings()Gets the frame timings for the current frame. Returns: the #GdkFrameTimings for the frame currently being processed, or even no frame is being processed, for the previous frame. Before any frames h...long getFrameCounter()A #GdkFrameClock maintains a 64-bit counter that increments for each frame drawn. Returns: inside frame processing, the value of the frame counter for the current frame. Outside of frame processing...long getFrameTime()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, i...long getHistoryStart()#GdkFrameClock internally keeps a history of #GdkFrameTimings objects for recent frames that can be retrieved with [gdk.frameclock.FrameClock.getTimings]. The set of stored frames is the set from t...void getRefreshInfo(long baseTime, out long refreshIntervalReturn, out long presentationTimeReturn)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 ...gdk.frame_timings.FrameTimings getTimings(long frameCounter)Retrieves a #GdkFrameTimings object holding timing information for the current frame or a recent frame. The #GdkFrameTimings object may not yet be complete: see [gdk.frame_timings.FrameTimings.getC...void requestPhase(gdk.types.FrameClockPhase phase)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 [gdk.frameclock.FrameClock.re...gulong connectAfterPaint(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : gdk.frame_clock.FrameClock)))
&& Parameters!T.length < 2)Connect to `AfterPaint` signal.gulong connectBeforePaint(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : gdk.frame_clock.FrameClock)))
&& Parameters!T.length < 2)Connect to `BeforePaint` signal.gulong connectFlushEvents(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : gdk.frame_clock.FrameClock)))
&& Parameters!T.length < 2)Connect to `FlushEvents` signal.gulong connectLayout(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : gdk.frame_clock.FrameClock)))
&& Parameters!T.length < 2)Connect to `Layout` signal.gulong connectPaint(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : gdk.frame_clock.FrameClock)))
&& Parameters!T.length < 2)Connect to `Paint` signal.gulong connectResumeEvents(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : gdk.frame_clock.FrameClock)))
&& Parameters!T.length < 2)Connect to `ResumeEvents` signal.gulong connectUpdate(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : gdk.frame_clock.FrameClock)))
&& Parameters!T.length < 2)Connect to `Update` signal.Fluent builder for [gdk.frame_clock.FrameClock]