[]Struct gdk::FrameTimings

pub struct FrameTimings(_);

A FrameTimings object holds timing information for a single frame of the application’s displays. To retrieve FrameTimings objects, use FrameClock::get_timings or FrameClock::get_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

impl FrameTimings[src]

pub fn get_complete(&self) -> bool[src]

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 FrameTimings::get_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.

pub fn get_frame_counter(&self) -> i64[src]

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

Returns

the frame counter value for this frame

pub fn get_frame_time(&self) -> i64[src]

Returns the frame time for the frame. This is the time value that is typically used to time animations for the frame. See FrameClock::get_frame_time.

Returns

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

impl FrameTimings[src]

pub fn get_predicted_presentation_time(&self) -> Option<NonZeroU64>[src]

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 FrameTimings::get_presentation_time, which is only available after the frame has been presented. In general, if you are simply animating, you should use FrameClock::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

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.

pub fn get_presentation_time(&self) -> Option<NonZeroU64>[src]

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 FrameTimings::get_complete

pub fn get_refresh_interval(&self) -> Option<NonZeroU64>[src]

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 FrameTimings::get_complete.

Trait Implementations

impl Clone for FrameTimings

impl Debug for FrameTimings[src]

impl Eq for FrameTimings[src]

impl Hash for FrameTimings[src]

impl Ord for FrameTimings[src]

impl PartialEq<FrameTimings> for FrameTimings[src]

impl PartialOrd<FrameTimings> for FrameTimings[src]

impl StaticType for FrameTimings

impl StructuralEq for FrameTimings[src]

impl StructuralPartialEq for FrameTimings[src]

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

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where
    T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>, 

type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToSendValue for T where
    T: ToValue + SetValue + Send + ?Sized

impl<T> ToValue for T where
    T: SetValue + ?Sized

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.