Struct piston::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.

Implementations

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, 

Returns the next event.

Trait Implementations

impl Clone for Events

pub fn clone(&self) -> Events

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Events

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl EventLoop for Events

pub fn get_event_settings(&self) -> EventSettings

Returns event loop settings.

pub fn set_event_settings(&mut self, settings: EventSettings)

Sets event loop settings.

fn set_ups(&mut self, frames: u64)

The number of updates per second

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

The number of updates per second

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.

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.

fn set_max_fps(&mut self, frames: u64)

The maximum number of frames per second

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

The maximum number of frames per second

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.

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.

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.

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.

impl Copy for Events