Skip to main content

RuntimeConfig

Struct RuntimeConfig 

Source
pub struct RuntimeConfig { /* private fields */ }
Expand description

Configuration for fixed simulation and variable-rate rendering.

Implementations§

Source§

impl RuntimeConfig

Source

pub fn fixed_hz(updates_per_second: u32) -> Result<Self, RuntimeConfigError>

Creates a fixed-rate configuration with bounded catch-up defaults.

The default maximum accepted frame delta is 250 milliseconds and at most eight fixed steps may run in one frame. Whole fixed steps beyond that budget are discarded to avoid a spiral of death, and the discarded duration is reported by FramePlan::dropped_time.

§Errors

Returns RuntimeConfigError::ZeroUpdateRate when updates_per_second is zero, or RuntimeConfigError::UpdateRateTooHigh when its period is below Duration resolution.

Source

pub fn with_max_frame_delta( self, max_frame_delta: Duration, ) -> Result<Self, RuntimeConfigError>

Replaces the largest wall-clock delta accepted for one frame.

§Errors

Returns RuntimeConfigError::ZeroMaxFrameDelta when the duration is zero.

Source

pub fn with_max_fixed_steps( self, max_fixed_steps: u32, ) -> Result<Self, RuntimeConfigError>

Replaces the maximum number of fixed updates allowed in one frame.

§Errors

Returns RuntimeConfigError::ZeroMaxFixedSteps when the limit is zero.

Source

pub const fn fixed_step(self) -> Duration

Returns the duration of one fixed simulation update.

Source

pub const fn max_frame_delta(self) -> Duration

Returns the largest wall-clock delta accepted for one frame.

Source

pub const fn max_fixed_steps(self) -> u32

Returns the maximum number of fixed updates allowed in one frame.

Trait Implementations§

Source§

impl Clone for RuntimeConfig

Source§

fn clone(&self) -> RuntimeConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RuntimeConfig

Source§

impl Debug for RuntimeConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for RuntimeConfig

Source§

impl PartialEq for RuntimeConfig

Source§

fn eq(&self, other: &RuntimeConfig) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RuntimeConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.