Struct piston::event_loop::WindowEvents

pub struct WindowEvents {
    // some 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 WindowEvents

fn new() -> WindowEvents

Creates a new event iterator with default UPS and FPS settings.

fn next<W>(&mut self, window: &mut W) -> Option<Event<W::Event>> where W: Window

Returns the next game event.

Trait Implementations

impl Clone for WindowEvents

fn clone(&self) -> WindowEvents

impl Copy for WindowEvents

impl EventLoop for WindowEvents

fn set_ups(&mut self, frames: u64)

The number of updates per second

fn set_max_fps(&mut self, frames: u64)

The maximum number of frames per second

fn set_swap_buffers(&mut self, enable: bool)

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.

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

The number of updates per second

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

The maximum number of frames per second

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

Enable or disable automatic swapping of buffers.

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.