Struct heron_core::PhysicsSteps

pub struct PhysicsSteps(_);

Resource to control how many physics steps are performed per second.

Note that the physics update will be performed at most once per frame. It means that if the rate of frames per second is lower than the physics step per second, the physics simulation will slows down.

This resource is used to tune the precision and performance of the physics system. It doesn’t change the speed of the simulation. To change the time scale, look at the PhysicsTime resource instead.

Implementations

impl PhysicsSteps

#[must_use]

pub fn from_steps_per_seconds(steps_per_second: f32) -> Self

Configure to run at the given number of steps per second

The higher the value, the more precise and the more expensive the physics simulation will be. If the value gets higher than the frame rate of the game, the physics simulation will slows down.

For good results, it is better to choose a value as high as possible but lower than the typical frame rate of the game.

Panics

Panics if the argument is nan, infinite or negative

#[must_use]

pub fn from_delta_time(duration: Duration) -> Self

Configure the physics systems to wait for the given duration before running again

The lower the value, the more precise and the more expensive the physics simulation will be. If the value gets lower than the delta time between each frame of the game, the physics simulation will slows down.

For good results, it is better to choose a value as low as possible, but higher than the typical delay between each frame of the game.

Panics

Panics if the duration is zero

#[must_use]

pub fn every_frame(duration: Duration) -> Self

Configure the physics systems to run at each and every frame. Regardless of the current FPS.

It takes a duration which is “haw much” the physics simulation should advance at each frame.

Should NOT be used in production. It is mostly useful for testing purposes.

Panics

Panics if the duration is zero

#[must_use]

pub fn is_step_frame(&self) -> bool

Returns true only if the current frame is a frame that execute a physics simulation step

#[must_use]

pub fn duration(&self) -> Duration

Time that elapses between each physics step

Trait Implementations

impl Default for PhysicsSteps

fn default() -> Self

Returns the “default value” for a type.