[][src]Struct piston_window::Events

pub struct Events { /* fields omitted */ }

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[src]

pub fn new(settings: EventSettings) -> Events[src]

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
[src]

Returns the next event.

Trait Implementations

impl Copy for Events[src]

impl EventLoop for Events[src]

fn set_ups(&mut self, frames: u64)[src]

The number of updates per second Read more

fn ups(self, frames: u64) -> Self[src]

The number of updates per second Read more

fn set_ups_reset(&mut self, frames: u64)[src]

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[src]

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)[src]

The maximum number of frames per second Read more

fn max_fps(self, frames: u64) -> Self[src]

The maximum number of frames per second Read more

fn set_swap_buffers(&mut self, enable: bool)[src]

Enable or disable automatic swapping of buffers.

fn swap_buffers(self, enable: bool) -> Self[src]

Enable or disable automatic swapping of buffers.

fn set_bench_mode(&mut self, enable: bool)[src]

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[src]

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)[src]

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[src]

Enable or disable rendering only when receiving input. When enabled, update events are disabled. Idle events are emitted while receiving input. Read more

impl Clone for Events[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl Send for Events

impl Sync for Events

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> SetParameter for T[src]

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
    T: Parameter<Self>, 
[src]

Sets value as a parameter of self.

impl<T> Erased for T[src]