Add common aspect ratio constants and improve documentation #15091

miniex · 2024-09-08T07:04:04Z

Hello,

I'd like to contribute to this project by adding some useful constants and improving the documentation for the AspectRatio struct. Here's a summary of the changes I've made:

Added new constants for common aspect ratios:
- SIXTEEN_NINE (16:9)
- FOUR_THREE (4:3)
- ULTRAWIDE (21:9)
Enhanced the overall documentation:
- Improved module-level documentation with an overview and use cases
- Expanded explanation of the AspectRatio struct with examples
- Added detailed descriptions and examples for all methods (both existing and new)
- Included explanations for the newly introduced constant values
- Added clarifications for From trait implementations

These changes aim to make the AspectRatio API more user-friendly and easier to understand. The new constants provide convenient access to commonly used aspect ratios, which I believe will be helpful in many scenarios.

crates/bevy_math/src/aspect_ratio.rs

- Add new constants for common aspect ratios: SIXTEEN_NINE, FOUR_THREE, ULTRAWIDE - Enhance module-level documentation with overview and use cases - Expand explanation of AspectRatio struct with examples - Provide detailed descriptions and examples for all methods (existing and new) - Add explanations for the newly introduced constant values - Include clarifications for From trait implementations This commit introduces convenient constants for frequently used aspect ratios and significantly improves the overall documentation, enhancing the usability and understanding of the AspectRatio API.

crates/bevy_math/src/aspect_ratio.rs

Co-authored-by: Gonçalo Rica Pais da Silva <bluefinger@gmail.com>

crates/bevy_math/src/aspect_ratio.rs

crates/bevy_math/src/aspect_ratio/error.rs

crates/bevy_math/src/aspect_ratio/mod.rs

Co-authored-by: Lixou <82600264+DasLixou@users.noreply.github.com>

crates/bevy_math/src/aspect_ratio/error.rs

crates/bevy_math/src/aspect_ratio/mod.rs

alice-i-cecile · 2024-09-08T21:58:47Z

crates/bevy_math/src/aspect_ratio/mod.rs

+/// An `AspectRatio` is the ratio of width to height.
+#[derive(Copy, Clone, Debug, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "bevy_reflect", derive(Reflect), reflect(Debug, PartialEq))]
+pub struct AspectRatio(f32);


I think we're missing a getter for the internal field here. You can call .into, but that's pretty obscure.

Should the getter be named as_f32 or ratio?
I'm thinking about this, ^-^

In my opinion, ratio is more appropriate.

crates/bevy_math/src/aspect_ratio/error.rs

alice-i-cecile

I really like the thrust of this: helpful error types are excellent, and I like the utility methods you've added. I have a few relatively minor requests.

janhohenheim · 2024-09-09T06:35:49Z

There's some potential overlap with #14158, FYI

crates/bevy_core_pipeline/src/bloom/settings.rs

miniex · 2024-09-09T07:24:18Z

Is there anything else we should do to avoid overlap with issue #14158 ?

DasLixou reviewed Sep 8, 2024

View reviewed changes

crates/bevy_math/src/aspect_ratio.rs Outdated Show resolved Hide resolved

crates/bevy_math/src/aspect_ratio.rs Outdated Show resolved Hide resolved

miniex force-pushed the main branch 2 times, most recently from bf4bd87 to 21a52f2 Compare September 8, 2024 07:36

miniex force-pushed the main branch from 21a52f2 to 87383ee Compare September 8, 2024 07:36

miniex requested a review from DasLixou September 8, 2024 07:40