FrameTimings

A gdk.FrameTimings object holds timing information for a single frame of the application’s displays. To retrieve gdk.FrameTimings objects, use Frame.clockGetTimings or Frame.clockGetCurrentTimings. The information in gdk.FrameTimings 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(GdkFrameTimings* gdkFrameTimings, bool ownedRef = false)

Sets our main struct and passes it to the parent class.

Destructor

A destructor is present on this object, but not explicitly documented in the source.

Members

Functions

doref
FrameTimings doref()

Increases the reference count of timings.

getComplete
bool getComplete()

The timing information in a gdk.FrameTimings 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 gdk.FrameTimings 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 Frame.timingsGetComplete returns TRUE for a frame, you can be certain that no further values will become available and be stored in the gdk.FrameTimings

getFrameCounter
long getFrameCounter()

Gets the frame counter value of the gdk.FrameClock 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 Frame.clockGetFrameTime.

getFrameTimingsStruct
GdkFrameTimings* getFrameTimingsStruct(bool transferOwnership = false)

Get the main Gtk struct

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 Frame.timingsGetPresentationTime, which is only available after the frame has been presented. In general, if you are simply animating, you should use Frame.clockGetFrameTime 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”.

getStruct
void* getStruct()

the main Gtk struct as a void*

unref
void unref()

Decreases the reference count of timings. If timings is no longer referenced, it will be freed.

Static functions

getType
GType getType()

Variables

gdkFrameTimings
GdkFrameTimings* gdkFrameTimings;

the main Gtk struct

Meta