FrameTimings

A #GdkFrameTimings object holds timing information for a single frame of the application’s displays. To retrieve #GdkFrameTimings objects, use gdk.frame_clock.FrameClock.getTimings or gdk.frame_clock.FrameClock.getCurrentTimings. The information in #GdkFrameTimings is useful for precise synchronization of video with the event or audio streams, and for measuring quality metrics for the application’s display, such as latency and jitter.

Constructors

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

Members

Functions

_cPtr
void* _cPtr(Flag!"Dup" dup)
getComplete
bool getComplete()

The timing information in a #GdkFrameTimings is filled in incrementally as the frame as drawn and passed off to the window system for processing and display to the user. The accessor functions for #GdkFrameTimings can return 0 to indicate an unavailable value for two reasons: either because the information is not yet available, or because it isn't available at all. Once gdk.frame_timings.FrameTimings.getComplete returns true for a frame, you can be certain that no further values will become available and be stored in the #GdkFrameTimings.

getFrameCounter
long getFrameCounter()

Gets the frame counter value of the #GdkFrameClock when this this frame was drawn.

getFrameTime
long getFrameTime()

Returns the frame time for the frame. This is the time value that is typically used to time animations for the frame. See gdk.frame_clock.FrameClock.getFrameTime.

getPredictedPresentationTime
long getPredictedPresentationTime()

Gets the predicted time at which this frame will be displayed. Although no predicted time may be available, if one is available, it will be available while the frame is being generated, in contrast to gdk.frame_timings.FrameTimings.getPresentationTime, which is only available after the frame has been presented. In general, if you are simply animating, you should use gdk.frame_clock.FrameClock.getFrameTime rather than this function, but this function is useful for applications that want exact control over latency. For example, a movie player may want this information for Audio/Video synchronization.

getPresentationTime
long getPresentationTime()

Reurns the presentation time. This is the time at which the frame became visible to the user.

getRefreshInterval
long getRefreshInterval()

Gets the natural interval between presentation times for the display that this frame was displayed on. Frame presentation usually happens during the “vertical blanking interval”.

self
FrameTimings self()

Returns this, for use in with statements.

Properties

_gType
GType _gType [@property getter]

Static functions

_getGType
GType _getGType()

Inherited Members

From Boxed

_cInstancePtr
void* _cInstancePtr;

Pointer to the C boxed value

_getGType
GType _getGType()

Get the GType of this boxed type.

_gType
GType _gType [@property getter]

Boxed GType property.

self
Boxed self()

Convenience method to return this cast to a type. For use in D with statements.

boxCopy
void* boxCopy()

Make a copy of the wrapped C boxed data.

boxedCopy
void* boxedCopy(void* cBoxed)

Copy a C boxed value using g_boxed_copy.

boxedFree
void boxedFree(void* cBoxed)

Free a C boxed value using g_boxed_free.