mirror of
https://github.com/bevyengine/bevy
synced 2024-11-22 04:33:37 +00:00
2bd328220b
# Objective Fixes #15791. As raised in #11022, scaling orthographic cameras is confusing! In Bevy 0.14, there were multiple completely redundant ways to do this, and no clear guidance on which to use. As a result, #15075 removed the `scale` field from `OrthographicProjection` completely, solving the redundancy issue. However, this resulted in an unintuitive API and a painful migration, as discussed in #15791. Users simply want to change a single parameter to zoom, rather than deal with the irrelevant details of how the camera is being scaled. ## Solution This PR reverts #15075, and takes an alternate, more nuanced approach to the redundancy problem. `ScalingMode::WindowSize` was by far the biggest offender. This was the default variant, and stored a float that was *fully* redundant to setting `scale`. All of the other variants contained meaningful semantic information and had an intuitive scale. I could have made these unitless, storing an aspect ratio, but this would have been a worse API and resulted in a pointlessly painful migration. In the course of this work I've also: - improved the documentation to explain that you should just set `scale` to zoom cameras - swapped to named fields for all of the variants in `ScalingMode` for more clarity about the parameter meanings - substantially improved the `projection_zoom` example - removed the footgunny `Mul` and `Div` impls for `ScalingMode`, especially since these no longer have the intended effect on `ScalingMode::WindowSize`. - removed a rounding step because this is now redundant 🎉 ## Testing I've tested these changes as part of my work in the `projection_zoom` example, and things seem to work fine. ## Migration Guide `ScalingMode` has been refactored for clarity, especially on how to zoom orthographic cameras and their projections: - `ScalingMode::WindowSize` no longer stores a float, and acts as if its value was 1. Divide your camera's scale by any previous value to achieve identical results. - `ScalingMode::FixedVertical` and `FixedHorizontal` now use named fields. --------- Co-authored-by: MiniaczQ <xnetroidpl@gmail.com> |
||
|---|---|---|
| .. | ||
| 2d_shapes.rs | ||
| 2d_viewport_to_world.rs | ||
| bloom_2d.rs | ||
| bounding_2d.rs | ||
| cpu_draw.rs | ||
| custom_gltf_vertex_attribute.rs | ||
| mesh2d.rs | ||
| mesh2d_alpha_mode.rs | ||
| mesh2d_arcs.rs | ||
| mesh2d_manual.rs | ||
| mesh2d_vertex_color_texture.rs | ||
| move_sprite.rs | ||
| pixel_grid_snap.rs | ||
| rotation.rs | ||
| sprite.rs | ||
| sprite_animation.rs | ||
| sprite_flipping.rs | ||
| sprite_sheet.rs | ||
| sprite_slice.rs | ||
| sprite_tile.rs | ||
| text2d.rs | ||
| texture_atlas.rs | ||
| transparency_2d.rs | ||
| wireframe_2d.rs | ||