Enum PerfOverlayMode 

#[non_exhaustive]
pub enum PerfOverlayMode {
    Off,
    Compact,
    Full,
}

How much detail super::PerfOverlayApp currently shows, advanced by the toggle key.

Cycles Off -> Compact -> Full -> Off. Full is only reachable once PerfOverlayApp::cycle_with has registered a second renderer; without one, the cycle skips straight from Compact back to Off, i.e. the plain two-state toggle from before this enum existed.

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.

Off

Nothing renders.

Compact

PerfOverlayApp’s primary PerfRenderer (e.g. DefaultPerfRenderer) renders.

Full

The renderer registered via PerfOverlayApp::cycle_with renders, if any; otherwise equivalent to Off (this mode is unreachable through the toggle key alone in that case, but PerfOverlayApp::set_mode can still be called with it directly).

Trait Implementations

impl Clone for PerfOverlayMode

fn clone(&self) -> PerfOverlayMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PerfOverlayMode

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

Formats the value using the given formatter.

impl Hash for PerfOverlayMode

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 PartialEq for PerfOverlayMode

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

impl Eq for PerfOverlayMode

impl StructuralPartialEq for PerfOverlayMode