Enum ggez::event::ControlFlow
source · [−]pub enum ControlFlow {
Poll,
Wait,
WaitUntil(Instant),
Exit,
}
Expand description
winit
event loop.
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.
Platform-specific
- Web: Events are queued and usually sent when
requestAnimationFrame
fires but sometimes the events in the queue may be sent before the nextrequestAnimationFrame
callback, for example when the scaling of the page has changed. This should be treated as an implementation detail which should not be relied on.
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
sourceimpl Clone for ControlFlow
impl Clone for ControlFlow
sourcefn clone(&self) -> ControlFlow
fn clone(&self) -> ControlFlow
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ControlFlow
impl Debug for ControlFlow
sourceimpl Default for ControlFlow
impl Default for ControlFlow
sourcefn default() -> ControlFlow
fn default() -> ControlFlow
Returns the “default value” for a type. Read more
sourceimpl PartialEq<ControlFlow> for ControlFlow
impl PartialEq<ControlFlow> for ControlFlow
sourcefn eq(&self, other: &ControlFlow) -> bool
fn eq(&self, other: &ControlFlow) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ControlFlow) -> bool
fn ne(&self, other: &ControlFlow) -> bool
This method tests for !=
.
impl Copy for ControlFlow
impl Eq for ControlFlow
impl StructuralEq for ControlFlow
impl StructuralPartialEq for ControlFlow
Auto Trait Implementations
impl RefUnwindSafe for ControlFlow
impl Send for ControlFlow
impl Sync for ControlFlow
impl Unpin for ControlFlow
impl UnwindSafe for ControlFlow
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> HasMut<T> for T
impl<T> HasMut<T> for T
sourcefn retrieve_mut(&mut self) -> &mut T
fn retrieve_mut(&mut self) -> &mut T
Method to retrieve the context type as mutable.