From 1d434bf92944d4aa800985da61799182c8296489 Mon Sep 17 00:00:00 2001 From: Stepan Koltsov Date: Tue, 19 Dec 2023 10:17:11 +0000 Subject: [PATCH] Explain OrthographicProjection.scale --- crates/bevy_render/src/camera/projection.rs | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/crates/bevy_render/src/camera/projection.rs b/crates/bevy_render/src/camera/projection.rs index 637ca423cf544..f1ab86d2aa56c 100644 --- a/crates/bevy_render/src/camera/projection.rs +++ b/crates/bevy_render/src/camera/projection.rs @@ -255,11 +255,16 @@ 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 parameter scales on top of that. + /// + /// This property is particularly useful in implementing zoom functionality. + /// + /// Defaults to `1.0`. pub scale: f32, /// The area that the projection covers relative to `viewport_origin`. ///