pub struct TimeConfig { /* private fields */ }Expand description
Validated fixed-step timing configuration.
The configuration is frozen before the runner starts. Pause and time scale may later be changed by the runtime without altering the fixed step or catch-up limit.
Implementations§
Source§impl TimeConfig
impl TimeConfig
Sourcepub fn new(
fixed_step: Duration,
max_catch_up_ticks: u32,
) -> Result<Self, TimeConfigurationError>
pub fn new( fixed_step: Duration, max_catch_up_ticks: u32, ) -> Result<Self, TimeConfigurationError>
Creates a configuration with time scale 1.0.
Sourcepub const fn fixed_step(self) -> Duration
pub const fn fixed_step(self) -> Duration
Returns the exact Duration supplied to every FixedUpdate tick.
Sourcepub const fn max_catch_up_ticks(self) -> u32
pub const fn max_catch_up_ticks(self) -> u32
Returns the maximum fixed ticks attempted in one application frame.
Sourcepub const fn time_scale(self) -> f64
pub const fn time_scale(self) -> f64
Returns the multiplier applied before wall delta enters the accumulator.
Sourcepub fn set_time_scale(
&mut self,
time_scale: f64,
) -> Result<(), TimeConfigurationError>
pub fn set_time_scale( &mut self, time_scale: f64, ) -> Result<(), TimeConfigurationError>
Sets the initial finite, non-negative simulation time scale.
The configuration remains unchanged when validation fails.
Sourcepub fn with_time_scale(
self,
time_scale: f64,
) -> Result<Self, TimeConfigurationError>
pub fn with_time_scale( self, time_scale: f64, ) -> Result<Self, TimeConfigurationError>
Returns this configuration with a validated initial time scale.
Trait Implementations§
Source§impl Clone for TimeConfig
impl Clone for TimeConfig
impl Copy for TimeConfig
Source§impl Debug for TimeConfig
impl Debug for TimeConfig
Source§impl Default for TimeConfig
impl Default for TimeConfig
Source§impl PartialEq for TimeConfig
impl PartialEq for TimeConfig
impl StructuralPartialEq for TimeConfig
Auto Trait Implementations§
impl Freeze for TimeConfig
impl RefUnwindSafe for TimeConfig
impl Send for TimeConfig
impl Sync for TimeConfig
impl Unpin for TimeConfig
impl UnsafeUnpin for TimeConfig
impl UnwindSafe for TimeConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
impl<S, T> Duplex<S> for Twhere
T: FromSample<S> + ToSample<S>,
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> FromTemplate for T
impl<T> FromTemplate for T
Source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
Source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self using default().
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Template for T
impl<T> Template for T
Source§fn build_template(
&self,
_context: &mut TemplateContext<'_, '_>,
) -> Result<<T as Template>::Output, BevyError>
fn build_template( &self, _context: &mut TemplateContext<'_, '_>, ) -> Result<<T as Template>::Output, BevyError>
Uses this template and the given
entity context to produce a Template::Output.Source§fn clone_template(&self) -> T
fn clone_template(&self) -> T
Clones this template. See
Clone.