Explain OrthographicProjection.scale

bevyengine · Dec 19, 2023 · 786c810 · 786c810
1 parent 05b0026
commit 786c810
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/crates/bevy_render/src/camera/projection.rs b/crates/bevy_render/src/camera/projection.rs
@@ -255,11 +255,14 @@ pub struct OrthographicProjection {
     ///
     /// Defaults to `ScalingMode::WindowSize(1.0)`
     pub scaling_mode: ScalingMode,
-    /// Scales the projection in world units.
+    /// Scales the projection.
     ///
     /// As scale increases, the apparent size of objects decreases, and vice versa.
     ///
-    /// Defaults to `1.0`
+    /// Note scaling can be set by [`scaling_mode`](Self::scaling_mode) as well.
+    /// This parameters is scale on top of that.
+    ///
+    /// Defaults to `1.0`.
     pub scale: f32,
     /// The area that the projection covers relative to `viewport_origin`.
     ///