Class (GI Struct)

Gdk-3.0 ▶ Gdk ▶ FrameTimingsAbstract

A Gdk.FrameTimings object holds timing information for a single frame of the application’s displays. To retrieve Gdk.FrameTimings objects, use gdk_frame_clock_get_timings() or gdk_frame_clock_get_current_timings(). 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.

Index

Constructors

constructor

Properties

$gtype

Methods

get_complete get_frame_counter get_frame_time get_predicted_presentation_time get_presentation_time get_refresh_interval ref unref

Constructors

Properties

$gtype: GType<Gdk.FrameTimings>

Methods

  • 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 gdk_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 Gdk.FrameTimings.

    Returns boolean

    true if all information that will be available for the frame has been filled in.

  • Gets the frame counter value of the Gdk.FrameClock when this this frame was drawn.

    Returns number

    the frame counter value for this frame

  • 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_get_frame_time().

    Returns number

    the frame time for the frame, in the timescale of g_get_monotonic_time()

  • 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_get_presentation_time(), which is only available after the frame has been presented. In general, if you are simply animating, you should use gdk_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.

    Returns number

    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.

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

    Returns number

    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 gdk_frame_timings_get_complete()

  • 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”.

    Returns number

    the refresh interval of the display, in microseconds, or 0 if the refresh interval is not available. See gdk_frame_timings_get_complete().

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

    Returns void