Enum glutin::event_loop::ControlFlow
source · pub enum ControlFlow {
Poll,
Wait,
WaitUntil(Instant),
Exit,
}
Expand description
Set by the user callback given to the EventLoop::run
method.
Indicates the desired behavior of the event loop after Event::RedrawEventsCleared
is emitted. Defaults to Poll
.
Persistency
Almost every change is persistent between multiple calls to the event loop closure within a
given run loop. The only exception to this is Exit
which, once set, cannot be unset. Changes
are not persistent between multiple calls to run_return
- issuing a new call will reset
the control flow to Poll
.
Variants§
Poll
When the current loop iteration finishes, immediately begin a new iteration regardless of
whether or not new events are available to process. For web, events are sent when
requestAnimationFrame
fires.
Wait
When the current loop iteration finishes, suspend the thread until another event arrives.
WaitUntil(Instant)
When the current loop iteration finishes, suspend the thread until either another event arrives or the given time is reached.
Exit
Send a LoopDestroyed
event and stop the event loop. This variant is sticky - once set,
control_flow
cannot be changed from Exit
, and any future attempts to do so will result
in the control_flow
parameter being reset to Exit
.
Trait Implementations§
source§impl Clone for ControlFlow
impl Clone for ControlFlow
source§fn clone(&self) -> ControlFlow
fn clone(&self) -> ControlFlow
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ControlFlow
impl Debug for ControlFlow
source§impl Default for ControlFlow
impl Default for ControlFlow
source§fn default() -> ControlFlow
fn default() -> ControlFlow
source§impl PartialEq<ControlFlow> for ControlFlow
impl PartialEq<ControlFlow> for ControlFlow
source§fn eq(&self, other: &ControlFlow) -> bool
fn eq(&self, other: &ControlFlow) -> bool
self
and other
values to be equal, and is used
by ==
.