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

Implementations

impl EventSettings

pub fn new() -> EventSettings

Creates new with default settings.

Trait Implementations

impl Clone for EventSettings

pub fn clone(&self) -> EventSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EventSettings

impl Debug for EventSettings

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

Formats the value using the given formatter.

impl Default for EventSettings

pub fn default() -> EventSettings

Returns the “default value” for a type.

impl EventLoop for EventSettings

pub fn get_event_settings(&self) -> EventSettings

Returns event loop settings.

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

Sets event loop settings.

pub fn set_ups(&mut self, frames: u64)

The number of updates per second

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

The number of updates per second

pub 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.

pub 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.

pub fn set_max_fps(&mut self, frames: u64)

The maximum number of frames per second

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

The maximum number of frames per second

pub fn set_swap_buffers(&mut self, enable: bool)

Enable or disable automatic swapping of buffers.

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

Enable or disable automatic swapping of buffers.

pub 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.

pub 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.

pub 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.

pub 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.