From 34763642921e9dde35108b6ce1344b891bd1d5df Mon Sep 17 00:00:00 2001 From: Joy <51241057+maniwani@users.noreply.github.com> Date: Wed, 19 Oct 2022 18:56:09 -0700 Subject: [PATCH] doc symmetry --- crates/bevy_time/src/time.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/crates/bevy_time/src/time.rs b/crates/bevy_time/src/time.rs index c700f08b6fa64..22fe3b39ce8bb 100644 --- a/crates/bevy_time/src/time.rs +++ b/crates/bevy_time/src/time.rs @@ -281,6 +281,10 @@ impl Time { } /// Returns the exact clock time elapsed since [`startup`](#method.startup), as [`f32`] seconds. + /// + /// **Note:** This is a monotonically increasing value. It's precision will degrade over time. + /// If you need an `f32` but that precision loss is unacceptable, + /// use [`raw_elapsed_seconds_wrapped`](#method.raw_elapsed_seconds_wrapped). #[inline] pub fn raw_elapsed_seconds(&self) -> f32 { self.raw_elapsed_seconds @@ -301,6 +305,9 @@ impl Time { /// Returns the exact clock time elapsed since [`startup`](#method.startup) modulo /// the [`wrap_period`](#method.wrap_period), as [`f32`] seconds. + /// + /// This method is intended for applications (e.g. shaders) that require an [`f32`] value but + /// suffer from the gradual precision loss of [`elapsed_seconds`](#method.elapsed_seconds). #[inline] pub fn raw_elapsed_seconds_wrapped(&self) -> f32 { self.raw_elapsed_seconds_wrapped