5241e09671
# Objective - Fixes #17960 ## Solution - Followed the [edition upgrade guide](https://doc.rust-lang.org/edition-guide/editions/transitioning-an-existing-project-to-a-new-edition.html) ## Testing - CI --- ## Summary of Changes ### Documentation Indentation When using lists in documentation, proper indentation is now linted for. This means subsequent lines within the same list item must start at the same indentation level as the item. ```rust /* Valid */ /// - Item 1 /// Run-on sentence. /// - Item 2 struct Foo; /* Invalid */ /// - Item 1 /// Run-on sentence. /// - Item 2 struct Foo; ``` ### Implicit `!` to `()` Conversion `!` (the never return type, returned by `panic!`, etc.) no longer implicitly converts to `()`. This is particularly painful for systems with `todo!` or `panic!` statements, as they will no longer be functions returning `()` (or `Result<()>`), making them invalid systems for functions like `add_systems`. The ideal fix would be to accept functions returning `!` (or rather, _not_ returning), but this is blocked on the [stabilisation of the `!` type itself](https://doc.rust-lang.org/std/primitive.never.html), which is not done. The "simple" fix would be to add an explicit `-> ()` to system signatures (e.g., `|| { todo!() }` becomes `|| -> () { todo!() }`). However, this is _also_ banned, as there is an existing lint which (IMO, incorrectly) marks this as an unnecessary annotation. So, the "fix" (read: workaround) is to put these kinds of `|| -> ! { ... }` closuers into variables and give the variable an explicit type (e.g., `fn()`). ```rust // Valid let system: fn() = || todo!("Not implemented yet!"); app.add_systems(..., system); // Invalid app.add_systems(..., || todo!("Not implemented yet!")); ``` ### Temporary Variable Lifetimes The order in which temporary variables are dropped has changed. The simple fix here is _usually_ to just assign temporaries to a named variable before use. ### `gen` is a keyword We can no longer use the name `gen` as it is reserved for a future generator syntax. This involved replacing uses of the name `gen` with `r#gen` (the raw-identifier syntax). ### Formatting has changed Use statements have had the order of imports changed, causing a substantial +/-3,000 diff when applied. For now, I have opted-out of this change by amending `rustfmt.toml` ```toml style_edition = "2021" ``` This preserves the original formatting for now, reducing the size of this PR. It would be a simple followup to update this to 2024 and run `cargo fmt`. ### New `use<>` Opt-Out Syntax Lifetimes are now implicitly included in RPIT types. There was a handful of instances where it needed to be added to satisfy the borrow checker, but there may be more cases where it _should_ be added to avoid breakages in user code. ### `MyUnitStruct { .. }` is an invalid pattern Previously, you could match against unit structs (and unit enum variants) with a `{ .. }` destructuring. This is no longer valid. ### Pretty much every use of `ref` and `mut` are gone Pattern binding has changed to the point where these terms are largely unused now. They still serve a purpose, but it is far more niche now. ### `iter::repeat(...).take(...)` is bad New lint recommends using the more explicit `iter::repeat_n(..., ...)` instead. ## Migration Guide The lifetimes of functions using return-position impl-trait (RPIT) are likely _more_ conservative than they had been previously. If you encounter lifetime issues with such a function, please create an issue to investigate the addition of `+ use<...>`. ## Notes - Check the individual commits for a clearer breakdown for what _actually_ changed. --------- Co-authored-by: François Mockers <francois.mockers@vleue.com>
94 lines
3.3 KiB
Rust
94 lines
3.3 KiB
Rust
mod border_rect;
|
|
mod computed_slices;
|
|
mod slicer;
|
|
|
|
use bevy_math::{Rect, Vec2};
|
|
pub use border_rect::BorderRect;
|
|
pub use slicer::{SliceScaleMode, TextureSlicer};
|
|
|
|
pub(crate) use computed_slices::{
|
|
compute_slices_on_asset_event, compute_slices_on_sprite_change, ComputedTextureSlices,
|
|
};
|
|
|
|
/// Single texture slice, representing a texture rect to draw in a given area
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
pub struct TextureSlice {
|
|
/// texture area to draw
|
|
pub texture_rect: Rect,
|
|
/// slice draw size
|
|
pub draw_size: Vec2,
|
|
/// offset of the slice
|
|
pub offset: Vec2,
|
|
}
|
|
|
|
impl TextureSlice {
|
|
/// Transforms the given slice in a collection of tiled subdivisions.
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// * `stretch_value` - The slice will repeat when the ratio between the *drawing dimensions* of texture and the
|
|
/// *original texture size* (rect) are above `stretch_value`.
|
|
/// * `tile_x` - should the slice be tiled horizontally
|
|
/// * `tile_y` - should the slice be tiled vertically
|
|
#[must_use]
|
|
pub fn tiled(self, stretch_value: f32, (tile_x, tile_y): (bool, bool)) -> Vec<Self> {
|
|
if !tile_x && !tile_y {
|
|
return vec![self];
|
|
}
|
|
let stretch_value = stretch_value.max(0.001);
|
|
let rect_size = self.texture_rect.size();
|
|
// Each tile expected size
|
|
let expected_size = Vec2::new(
|
|
if tile_x {
|
|
// No slice should be less than 1 pixel wide
|
|
(rect_size.x * stretch_value).max(1.0)
|
|
} else {
|
|
self.draw_size.x
|
|
},
|
|
if tile_y {
|
|
// No slice should be less than 1 pixel high
|
|
(rect_size.y * stretch_value).max(1.0)
|
|
} else {
|
|
self.draw_size.y
|
|
},
|
|
)
|
|
.min(self.draw_size);
|
|
let mut slices = Vec::new();
|
|
let base_offset = Vec2::new(
|
|
-self.draw_size.x / 2.0,
|
|
self.draw_size.y / 2.0, // Start from top
|
|
);
|
|
let mut offset = base_offset;
|
|
|
|
let mut remaining_columns = self.draw_size.y;
|
|
while remaining_columns > 0.0 {
|
|
let size_y = expected_size.y.min(remaining_columns);
|
|
offset.x = base_offset.x;
|
|
offset.y -= size_y / 2.0;
|
|
let mut remaining_rows = self.draw_size.x;
|
|
while remaining_rows > 0.0 {
|
|
let size_x = expected_size.x.min(remaining_rows);
|
|
offset.x += size_x / 2.0;
|
|
let draw_size = Vec2::new(size_x, size_y);
|
|
let delta = draw_size / expected_size;
|
|
slices.push(Self {
|
|
texture_rect: Rect {
|
|
min: self.texture_rect.min,
|
|
max: self.texture_rect.min + self.texture_rect.size() * delta,
|
|
},
|
|
draw_size,
|
|
offset: self.offset + offset,
|
|
});
|
|
offset.x += size_x / 2.0;
|
|
remaining_rows -= size_x;
|
|
}
|
|
offset.y -= size_y / 2.0;
|
|
remaining_columns -= size_y;
|
|
}
|
|
if slices.len() > 1_000 {
|
|
tracing::warn!("One of your tiled textures has generated {} slices. You might want to use higher stretch values to avoid a great performance cost", slices.len());
|
|
}
|
|
slices
|
|
}
|
|
}
|