Enum FrameEvent

#[non_exhaustive]
pub enum FrameEvent {
    Sync,
    Complete,
}

Identifiers that are passed to CoglFrameCallback functions (registered using Onscreen::add_frame_callback) that mark the progression of a frame in some way which usually means that new information will have been accumulated in the frame’s corresponding FrameInfo object.

The last event that will be sent for a frame will be a FrameEvent::Complete event and so these are a good opportunity to collect statistics about a frame since the FrameInfo should hold the most data at this point.

<note>A frame may not be completed before the next frame can start so applications should avoid needing to collect all statistics for a particular frame before they can start a new frame.</note>

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.

Sync

Notifies that the system compositor has acknowledged a frame and is ready for a new frame to be created.

Complete

Notifies that a frame has ended. This is a good time for applications to collect statistics about the frame since the FrameInfo should hold the most data at this point. No other events should be expected after a FrameEvent::Complete event.

Trait Implementations

impl Clone for FrameEvent

fn clone(&self) -> FrameEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameEvent

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

Formats the value using the given formatter.

impl Display for FrameEvent

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

Formats the value using the given formatter.

impl Hash for FrameEvent

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 FrameEvent

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

fn eq(&self, other: &FrameEvent) -> 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 PartialOrd for FrameEvent

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

impl Eq for FrameEvent

impl StructuralPartialEq for FrameEvent