gdk4/auto/
frame_timings.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::ffi;
use glib::translate::*;

glib::wrapper! {
    /// A [`FrameTimings`][crate::FrameTimings] object holds timing information for a single frame
    /// of the application’s displays.
    ///
    /// To retrieve [`FrameTimings`][crate::FrameTimings] objects, use [`FrameClock::timings()`][crate::FrameClock::timings()]
    /// or [`FrameClock::current_timings()`][crate::FrameClock::current_timings()]. The information in
    /// [`FrameTimings`][crate::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.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct FrameTimings(Shared<ffi::GdkFrameTimings>);

    match fn {
        ref => |ptr| ffi::gdk_frame_timings_ref(ptr),
        unref => |ptr| ffi::gdk_frame_timings_unref(ptr),
        type_ => || ffi::gdk_frame_timings_get_type(),
    }
}

impl FrameTimings {
    /// Returns whether @self are complete.
    ///
    /// The timing information in a [`FrameTimings`][crate::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 [`FrameTimings`][crate::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 this function returns [`true`] for a frame, you can be
    /// certain that no further values will become available and be
    /// stored in the [`FrameTimings`][crate::FrameTimings].
    ///
    /// # Returns
    ///
    /// [`true`] if all information that will be available
    ///   for the frame has been filled in.
    #[doc(alias = "gdk_frame_timings_get_complete")]
    #[doc(alias = "get_complete")]
    pub fn is_complete(&self) -> bool {
        unsafe { from_glib(ffi::gdk_frame_timings_get_complete(self.to_glib_none().0)) }
    }

    /// Gets the frame counter value of the [`FrameClock`][crate::FrameClock] when
    /// this frame was drawn.
    ///
    /// # Returns
    ///
    /// the frame counter value for this frame
    #[doc(alias = "gdk_frame_timings_get_frame_counter")]
    #[doc(alias = "get_frame_counter")]
    pub fn frame_counter(&self) -> i64 {
        unsafe { ffi::gdk_frame_timings_get_frame_counter(self.to_glib_none().0) }
    }

    /// Returns the frame time for the frame.
    ///
    /// This is the time value that is typically used to time
    /// animations for the frame. See [`FrameClock::frame_time()`][crate::FrameClock::frame_time()].
    ///
    /// # Returns
    ///
    /// the frame time for the frame, in the timescale
    ///  of g_get_monotonic_time()
    #[doc(alias = "gdk_frame_timings_get_frame_time")]
    #[doc(alias = "get_frame_time")]
    pub fn frame_time(&self) -> i64 {
        unsafe { ffi::gdk_frame_timings_get_frame_time(self.to_glib_none().0) }
    }

    /// 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 [`presentation_time()`][Self::presentation_time()], which is only
    /// available after the frame has been presented.
    ///
    /// In general, if you are simply animating, you should use
    /// [`FrameClock::frame_time()`][crate::FrameClock::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
    ///
    /// 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.
    #[doc(alias = "gdk_frame_timings_get_predicted_presentation_time")]
    #[doc(alias = "get_predicted_presentation_time")]
    pub fn predicted_presentation_time(&self) -> i64 {
        unsafe { ffi::gdk_frame_timings_get_predicted_presentation_time(self.to_glib_none().0) }
    }

    /// Reurns the presentation time.
    ///
    /// This is the time at which the frame became visible to the user.
    ///
    /// # Returns
    ///
    /// 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 [`is_complete()`][Self::is_complete()]
    #[doc(alias = "gdk_frame_timings_get_presentation_time")]
    #[doc(alias = "get_presentation_time")]
    pub fn presentation_time(&self) -> i64 {
        unsafe { ffi::gdk_frame_timings_get_presentation_time(self.to_glib_none().0) }
    }

    /// 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
    ///
    /// the refresh interval of the display, in microseconds,
    ///   or 0 if the refresh interval is not available.
    ///   See [`is_complete()`][Self::is_complete()].
    #[doc(alias = "gdk_frame_timings_get_refresh_interval")]
    #[doc(alias = "get_refresh_interval")]
    pub fn refresh_interval(&self) -> i64 {
        unsafe { ffi::gdk_frame_timings_get_refresh_interval(self.to_glib_none().0) }
    }
}