Enum FrameResult 

#[non_exhaustive]
pub enum FrameResult {
    Preparing,
    Skipped,
    Empty,
    Submitted,
    Outstanding,
    Discarded,
    Presented,
}

Available on crate feature v4_24 only.

An enumeration describing the process of rendering a frame. Rendering a frame starts with the frame clock cycle and then follows the rendered frame (if there was one) through the display server until it appears on screen.

It is relevant in particular for FrameTimings which may still be waiting for values to be filled in.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Preparing

The frame is currently being prepared and rendered by GTK. This is the initial state.

Skipped

GTK has determined that nothing needs to be rendered because there are no visual changes. No rendering will be submitted to the display server and because of that no information will be forthcoming from the display server.

The frame is complete.

Empty

GTK has determined that nothing needs to be rendered because there are no visual changes. This information has been submitted to the display server. The presentation time has been updated to reflect when this frame would have been displayed.

The frame is complete.

Submitted

A frame has been drawn and submitted to the display server, but the display server will not provide any further feedback about when or how the frame is going to be displayed.

The frame is complete.

Outstanding

The frame has been drawn and submitted to the display server, but the display server has not yet replied what is going to happen with the rendered image.

Discarded

The frame has been drawn and submitted to the display server, but the display server has not displayed it. No presentation time will be available.

The frame is complete.

Presented

The frame has been drawn and submitted to the display server, and the display server has rendered it and displayed the result. The presentation time is accurately reflecting when that happened.

The frame is complete.

Trait Implementations

impl Clone for FrameResult

fn clone(&self) -> FrameResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrameResult

impl Debug for FrameResult

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

Formats the value using the given formatter.

impl Eq for FrameResult

impl From<FrameResult> for Value

fn from(v: FrameResult) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for FrameResult

type Checker = GenericValueTypeChecker<FrameResult>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for FrameResult

type ParamSpec = ParamSpecEnum

type SetValue = FrameResult

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str, FrameResult) -> ParamSpecEnumBuilder<'_, FrameResult>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FrameResult

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 FrameResult

fn cmp(&self, other: &FrameResult) -> 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 PartialEq for FrameResult

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FrameResult

fn partial_cmp(&self, other: &FrameResult) -> 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 FrameResult

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralPartialEq for FrameResult

impl ToValue for FrameResult

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for FrameResult

type Type = FrameResult

Type to get the Type from.