[][src]Struct piston_window::EventSettings

pub struct EventSettings {
    pub max_fps: u64,
    pub ups: u64,
    pub ups_reset: u64,
    pub swap_buffers: bool,
    pub bench_mode: bool,
    pub lazy: bool,
}

Stores event loop settings.

Fields

max_fps: u64

The maximum number of frames per second

The frame rate can be lower because the next frame is always scheduled from the previous frame. This causes the frames to "slip" over time.

ups: u64

The number of updates per second

This is the fixed update rate on average over time. If the event loop lags, it will try to catch up. When set to 0, update events are disabled.

ups_reset: u64

The number of delayed updates before skipping them to catch up. When set to 0, it will always try to catch up.

swap_buffers: bool

Enable or disable automatic swapping of buffers.

bench_mode: 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.

lazy: bool

Enable or disable rendering only when receiving input. When enabled, update and idle events are disabled.

Methods

impl EventSettings[src]

pub fn new() -> EventSettings[src]

Creates new with default settings.

Trait Implementations

impl Default for EventSettings[src]

impl Copy for EventSettings[src]

impl EventLoop for EventSettings[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 Debug for EventSettings[src]

impl Clone for EventSettings[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 EventSettings

impl Sync for EventSettings

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]