gdk.frame_clock

Module for [FrameClock] class

class FrameClock FrameClockGidBuilder FrameClockGidBuilderImpl

Types 3

classFrameClock : gobject.object.ObjectWrap

A gdk.frame_clock.FrameClock tells the application when to update and repaint a surface.

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.

gdk.frame_clock.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 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 gdk.frame_clock.FrameClock class for documentation of the phases. gdk.types.FrameClockPhase.Update and the gdk.frame_clock.FrameClock.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 gdk.frame_clock.FrameClock.update signal of the clock, they will stay exactly synchronized.

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

FrameClock self() nothrowReturns `this`, for use in `with` statements.

FrameClockGidBuilder builder() static nothrowGet builder for [gdk.frame_clock.FrameClock] Returns: New builder object

void beginUpdating() nothrowStarts updates for an animation.

void endUpdating() nothrowStops updates for an animation.

gdk.frame_timings.FrameTimings getCurrentTimings() nothrowGets the frame timings for the current frame. Returns: the [gdk.frame_timings.FrameTimings] for the frame currently being processed, or even no frame is being processed, for the previous frame. Bef...

double getFps() nothrowCalculates the current frames-per-second, based on the frame timings of frame_clock. Returns: the current fps, as a `double`

long getFrameCounter() nothrow[gdk.frame_clock.FrameClock] 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 fram...

long getFrameTime() nothrowGets the time that should currently be used for animations.

long getHistoryStart() nothrowReturns the frame counter for the oldest frame available in history.

void getRefreshInfo(long baseTime, out long refreshIntervalReturn, out long presentationTimeReturn) nothrowPredicts a presentation time, based on history.

gdk.frame_timings.FrameTimings getTimings(long frameCounter) nothrowRetrieves a [gdk.frame_timings.FrameTimings] object holding timing information for the current frame or a recent frame.

void requestPhase(gdk.types.FrameClockPhase phase) nothrowAsks the frame clock to run a particular phase.

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)

nothrowConnect 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)

nothrowConnect 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)

nothrowConnect 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)

nothrowConnect 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)

nothrowConnect 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)

nothrowConnect 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)

nothrowConnect to `Update` signal.

Constructors

this(void * ptr, Flag!"Take" take)

classFrameClockGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T

Fluent builder implementation template for gdk.frame_clock.FrameClock

classFrameClockGidBuilder : FrameClockGidBuilderImpl!FrameClockGidBuilder

Fluent builder for gdk.frame_clock.FrameClock

Methods

FrameClock build() nothrowCreate object from builder. Returns: New object