From 9bd90b287d4d97835df1263f2ca8991c247d6eef Mon Sep 17 00:00:00 2001 From: Stepan Koltsov Date: Wed, 3 Jan 2024 01:38:49 +0000 Subject: [PATCH] Explain Camera physical size is in pixel --- crates/bevy_render/src/camera/camera.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/crates/bevy_render/src/camera/camera.rs b/crates/bevy_render/src/camera/camera.rs index 140cdd9138fc32..31b83e29b32f9f 100644 --- a/crates/bevy_render/src/camera/camera.rs +++ b/crates/bevy_render/src/camera/camera.rs @@ -65,7 +65,7 @@ impl Default for Viewport { /// Information about the current [`RenderTarget`]. #[derive(Default, Debug, Clone)] pub struct RenderTargetInfo { - /// The physical size of this render target (ignores scale factor). + /// The physical size of this render target (in pixels). pub physical_size: UVec2, /// The scale factor of this render target. pub scale_factor: f32, @@ -193,7 +193,7 @@ impl Camera { .or_else(|| self.logical_target_size()) } - /// The physical size of this camera's viewport. If the `viewport` field is set to [`Some`], this + /// The physical size of this camera's viewport (in pixels). If the `viewport` field is set to [`Some`], this /// will be the size of that custom viewport. Otherwise it will default to the full physical size of /// the current [`RenderTarget`]. /// For logic that requires the full physical size of the [`RenderTarget`], prefer [`Camera::physical_target_size`]. @@ -216,7 +216,7 @@ impl Camera { .and_then(|t| self.to_logical(t.physical_size)) } - /// The full physical size of this camera's [`RenderTarget`], ignoring custom `viewport` configuration. + /// The full physical size of this camera's [`RenderTarget`] (in pixels), ignoring custom `viewport` configuration. /// Note that if the `viewport` field is [`Some`], this will not represent the size of the rendered area. /// For logic that requires the size of the actually rendered area, prefer [`Camera::physical_viewport_size`]. #[inline]