Struct gdk4::FrameTimings

#[repr(transparent)]
pub struct FrameTimings { /* private fields */ }

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

impl FrameTimings

pub fn is_complete(&self) -> bool

Returns whether @self are complete.

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 this function 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 frame_counter(&self) -> i64

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

Returns

the frame counter value for this frame

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

pub fn predicted_presentation_time(&self) -> i64

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.

pub fn presentation_time(&self) -> i64

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

pub fn refresh_interval(&self) -> i64

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

impl Clone for FrameTimings

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FrameTimings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for FrameTimings

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FrameTimings

fn cmp(&self, other: &FrameTimings) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<FrameTimings> for FrameTimings

fn eq(&self, other: &FrameTimings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<FrameTimings> for FrameTimings

fn partial_cmp(&self, other: &FrameTimings) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FrameTimings

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FrameTimings

impl StructuralEq for FrameTimings

impl StructuralPartialEq for FrameTimings