| Top | |
|
|
|
| CdkFrameTimings * | cdk_frame_timings_ref () |
| void | cdk_frame_timings_unref () |
| gint64 | cdk_frame_timings_get_frame_counter () |
| gboolean | cdk_frame_timings_get_complete () |
| gint64 | cdk_frame_timings_get_frame_time () |
| gint64 | cdk_frame_timings_get_presentation_time () |
| gint64 | cdk_frame_timings_get_refresh_interval () |
| gint64 | cdk_frame_timings_get_predicted_presentation_time () |
A CdkFrameTimings object holds timing information for a single frame
of the application’s displays. To retrieve CdkFrameTimings objects,
use cdk_frame_clock_get_timings() or cdk_frame_clock_get_current_timings().
The information in CdkFrameTimings 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.
CdkFrameTimings *
cdk_frame_timings_ref (CdkFrameTimings *timings);
Increases the reference count of timings
.
Since: 3.8
void
cdk_frame_timings_unref (CdkFrameTimings *timings);
Decreases the reference count of timings
. If timings
is no longer referenced, it will be freed.
Since: 3.8
gint64
cdk_frame_timings_get_frame_counter (CdkFrameTimings *timings);
Gets the frame counter value of the CdkFrameClock when this this frame was drawn.
Since: 3.8
gboolean
cdk_frame_timings_get_complete (CdkFrameTimings *timings);
The timing information in a CdkFrameTimings 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 CdkFrameTimings 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 cdk_frame_timings_get_complete() returns
TRUE for a frame, you can be certain that no further values
will become available and be stored in the CdkFrameTimings.
Since: 3.8
gint64
cdk_frame_timings_get_frame_time (CdkFrameTimings *timings);
Returns the frame time for the frame. This is the time value
that is typically used to time animations for the frame. See
cdk_frame_clock_get_frame_time().
gint64
cdk_frame_timings_get_presentation_time
(CdkFrameTimings *timings);
Reurns the presentation time. This is the time at which the frame became visible to the user.
the time the frame was displayed to the user, in the
timescale of g_get_monotonic_time(), or 0 if no presentation
time is available. See cdk_frame_timings_get_complete()
Since: 3.8
gint64
cdk_frame_timings_get_refresh_interval
(CdkFrameTimings *timings);
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”.
the refresh interval of the display, in microseconds,
or 0 if the refresh interval is not available.
See cdk_frame_timings_get_complete().
Since: 3.8
gint64
cdk_frame_timings_get_predicted_presentation_time
(CdkFrameTimings *timings);
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
cdk_frame_timings_get_presentation_time(), which is only available
after the frame has been presented. In general, if you are simply
animating, you should use cdk_frame_clock_get_frame_time() 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.
The predicted time at which the frame will be presented,
in the timescale of g_get_monotonic_time(), or 0 if no predicted
presentation time is available.
Since: 3.8