FrameTimings#
- class FrameTimings(*args, **kwargs)#
A GdkFrameTimings
object holds timing information for a single frame
of the application’s displays.
To retrieve GdkFrameTimings
objects, use get_timings
or get_current_timings
. 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.
Methods#
- class FrameTimings
- get_complete() bool #
Returns whether
timings
are complete.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 forGdkFrameTimings
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 this function returns
True
for a frame, you can be certain that no further values will become available and be stored in theGdkFrameTimings
.
- get_frame_counter() int #
Gets the frame counter value of the
GdkFrameClock
when this frame was drawn.
- get_frame_time() int #
Returns the frame time for the frame.
This is the time value that is typically used to time animations for the frame. See
get_frame_time
.
- get_predicted_presentation_time() int #
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
get_presentation_time
, which is only available after the frame has been presented.In general, if you are simply animating, you should use
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.