Struct FrameInfo

pub struct FrameInfo(/* private fields */);

Implementations

impl FrameInfo

pub fn get_frame_counter(&self) -> i64

Gets the frame counter for the Onscreen that corresponds to this frame.

Returns

The frame counter value

pub fn get_output(&self) -> Option<Output>

Gets the Output that the swapped frame was presented to.

Returns

The Output that the frame was presented to, or None if this could not be determined.

pub fn get_presentation_time(&self) -> i64

Gets the presentation time for the frame. This is the time at which the frame became visible to the user.

The presentation time measured in nanoseconds is based on a monotonic time source. The time source is not necessarily correlated with system/wall clock time and may represent the time elapsed since some undefined system event such as when the system last booted.

<note>Linux kernel version less that 3.8 can result in non-monotonic timestamps being reported when using a drm based OpenGL driver. Also some buggy Mesa drivers up to 9.0.1 may also incorrectly report non-monotonic timestamps.</note>

Returns

the presentation time for the frame

pub fn get_refresh_rate(&self) -> f32

Gets the refresh rate in Hertz for the output that the frame was on at the time the frame was presented.

<note>Some platforms can’t associate a Output with a FrameInfo object but are able to report a refresh rate via this api. Therefore if you need this information then this api is more reliable than using FrameInfo::get_output followed by Output::get_refresh_rate.</note>

Returns

the refresh rate in Hertz

Trait Implementations

impl Clone for FrameInfo

fn clone(&self) -> FrameInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameInfo

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

Formats the value using the given formatter.

impl Display for FrameInfo

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

Formats the value using the given formatter.

impl Hash for FrameInfo

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 FrameInfo

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for FrameInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: ObjectType> PartialOrd<T> for FrameInfo

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for FrameInfo

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FrameInfo

impl IsA<Object> for FrameInfo