Struct gdk::FrameTimings
source · [−]#[repr(transparent)]pub struct FrameTimings { /* private fields */ }
Expand description
A FrameTimings
object holds timing information for a single frame
of the application’s displays. To retrieve FrameTimings
objects,
use FrameClock::timings()
or FrameClock::current_timings()
.
The information in 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.
Implementations
sourceimpl FrameTimings
impl FrameTimings
sourcepub fn is_complete(&self) -> bool
pub fn is_complete(&self) -> bool
The timing information in a 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
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 is_complete()
returns
true
for a frame, you can be certain that no further values
will become available and be stored in the FrameTimings
.
Returns
true
if all information that will be available
for the frame has been filled in.
sourcepub fn frame_counter(&self) -> i64
pub fn frame_counter(&self) -> i64
Gets the frame counter value of the FrameClock
when this
this frame was drawn.
Returns
the frame counter value for this frame
sourcepub fn frame_time(&self) -> i64
pub fn frame_time(&self) -> i64
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()
.
Returns
the frame time for the frame, in the timescale
of g_get_monotonic_time()
sourceimpl FrameTimings
impl FrameTimings
sourcepub fn predicted_presentation_time(&self) -> Option<NonZeroU64>
pub fn predicted_presentation_time(&self) -> Option<NonZeroU64>
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()
, which is only available
after the frame has been presented. In general, if you are simply
animating, you should use 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.
sourcepub fn presentation_time(&self) -> Option<NonZeroU64>
pub fn presentation_time(&self) -> Option<NonZeroU64>
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()
sourcepub fn refresh_interval(&self) -> Option<NonZeroU64>
pub fn refresh_interval(&self) -> Option<NonZeroU64>
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()
.
Trait Implementations
sourceimpl Clone for FrameTimings
impl Clone for FrameTimings
sourceimpl Debug for FrameTimings
impl Debug for FrameTimings
sourceimpl Hash for FrameTimings
impl Hash for FrameTimings
sourceimpl Ord for FrameTimings
impl Ord for FrameTimings
sourceimpl PartialEq<FrameTimings> for FrameTimings
impl PartialEq<FrameTimings> for FrameTimings
sourcefn eq(&self, other: &FrameTimings) -> bool
fn eq(&self, other: &FrameTimings) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &FrameTimings) -> bool
fn ne(&self, other: &FrameTimings) -> bool
This method tests for !=
.
sourceimpl PartialOrd<FrameTimings> for FrameTimings
impl PartialOrd<FrameTimings> for FrameTimings
sourcefn partial_cmp(&self, other: &FrameTimings) -> Option<Ordering>
fn partial_cmp(&self, other: &FrameTimings) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl StaticType for FrameTimings
impl StaticType for FrameTimings
sourcefn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of Self
.
impl Eq for FrameTimings
impl StructuralEq for FrameTimings
impl StructuralPartialEq for FrameTimings
Auto Trait Implementations
impl RefUnwindSafe for FrameTimings
impl !Send for FrameTimings
impl !Sync for FrameTimings
impl Unpin for FrameTimings
impl UnwindSafe for FrameTimings
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> StaticTypeExt for T where
T: StaticType,
impl<T> StaticTypeExt for T where
T: StaticType,
sourcefn ensure_type()
fn ensure_type()
Ensures that the type has been registered with the type system.
sourceimpl<T> ToClosureReturnValue for T where
T: ToValue,
impl<T> ToClosureReturnValue for T where
T: ToValue,
fn to_closure_return_value(&self) -> Option<Value>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more