[−]Struct piston_window::Events
An event loop iterator
Warning: Because the iterator polls events from the window back-end, it must be used on the same thread as the window back-end (usually main thread), unless the window back-end supports multi-thread event polling.
Methods
impl Events
pub fn new(settings: EventSettings) -> Events
Creates a new event iterator with default UPS and FPS settings.
pub fn next<W>(&mut self, window: &mut W) -> Option<Event> where
W: Window,
W: Window,
Returns the next event.
Trait Implementations
impl EventLoop for Events
fn get_event_settings(&self) -> EventSettings
fn set_event_settings(&mut self, settings: EventSettings)
fn set_ups(&mut self, frames: u64)
The number of updates per second Read more
fn ups(self, frames: u64) -> Self
The number of updates per second Read more
fn set_ups_reset(&mut self, frames: u64)
The number of delayed updates before skipping them to catch up. When set to 0
, it will always try to catch up. Read more
fn ups_reset(self, frames: u64) -> Self
The number of delayed updates before skipping them to catch up. When set to 0
, it will always try to catch up. Read more
fn set_max_fps(&mut self, frames: u64)
The maximum number of frames per second Read more
fn max_fps(self, frames: u64) -> Self
The maximum number of frames per second Read more
fn set_swap_buffers(&mut self, enable: bool)
Enable or disable automatic swapping of buffers.
fn swap_buffers(self, enable: bool) -> Self
Enable or disable automatic swapping of buffers.
fn set_bench_mode(&mut self, enable: bool)
Enable or disable benchmark mode. When enabled, it will render and update without sleep and ignore input. Used to test performance by playing through as fast as possible. Requires lazy
to be set to false
. Read more
fn bench_mode(self, enable: bool) -> Self
Enable or disable benchmark mode. When enabled, it will render and update without sleep and ignore input. Used to test performance by playing through as fast as possible. Requires lazy
to be set to false
. Read more
fn set_lazy(&mut self, enable: bool)
Enable or disable rendering only when receiving input. When enabled, update events are disabled. Idle events are emitted while receiving input. Read more
fn lazy(self, enable: bool) -> Self
Enable or disable rendering only when receiving input. When enabled, update events are disabled. Idle events are emitted while receiving input. Read more
impl Copy for Events
impl Clone for Events
Auto Trait Implementations
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
Sets value
as a parameter of self
.