forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix docs for atlas + slicing support (#12325)

Browse Source 
# Objective

The docs say that atlas and slicing are incompatible, but they are now
compatible after https://github.com/bevyengine/bevy/pull/12059.

## Solution

Update the docs.
This commit is contained in:
Ben Frankel 2024-03-05 10:04:22 -08:00 committed by GitHub
parent 212dc6017d
commit e9671f3e96
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
crates/bevy_sprite/src/bundle.rs
View File

@ -13,11 +13,9 @@ use bevy_transform::components::{GlobalTransform, Transform};
/// ///
/// # Extra behaviours /// # Extra behaviours
/// ///
/// You may add the following components to enable additional behaviours: /// You may add one or both of the following components to enable additional behaviours:
/// - [`ImageScaleMode`](crate::ImageScaleMode) to enable either slicing or tiling of the texture /// - [`ImageScaleMode`](crate::ImageScaleMode) to enable either slicing or tiling of the texture
/// - [`TextureAtlas`] to draw specific sections of the texture /// - [`TextureAtlas`] to draw a specific section of the texture
///
/// Note that `ImageScaleMode` is currently not compatible with `TextureAtlas`.
#[derive(Bundle, Clone, Debug, Default)] #[derive(Bundle, Clone, Debug, Default)]
pub struct SpriteBundle { pub struct SpriteBundle {
/// Specifies the rendering properties of the sprite, such as color tint and flip. /// Specifies the rendering properties of the sprite, such as color tint and flip.

12
crates/bevy_ui/src/node_bundles.rs
View File

@ -79,11 +79,9 @@ impl Default for NodeBundle {
/// ///
/// # Extra behaviours /// # Extra behaviours
/// ///
/// You may add the following components to enable additional behaviours: /// You may add one or both of the following components to enable additional behaviours:
/// - [`ImageScaleMode`](bevy_sprite::ImageScaleMode) to enable either slicing or tiling of the texture /// - [`ImageScaleMode`](bevy_sprite::ImageScaleMode) to enable either slicing or tiling of the texture
/// - [`TextureAtlas`] to draw specific sections of the texture /// - [`TextureAtlas`] to draw a specific section of the texture
///
/// Note that `ImageScaleMode` is currently not compatible with `TextureAtlas`.
#[derive(Bundle, Debug, Default)] #[derive(Bundle, Debug, Default)]
pub struct ImageBundle { pub struct ImageBundle {
/// Describes the logical size of the node /// Describes the logical size of the node
@ -298,11 +296,9 @@ where
/// ///
/// # Extra behaviours /// # Extra behaviours
/// ///
/// You may add the following components to enable additional behaviours: /// You may add one or both of the following components to enable additional behaviours:
/// - [`ImageScaleMode`](bevy_sprite::ImageScaleMode) to enable either slicing or tiling of the texture /// - [`ImageScaleMode`](bevy_sprite::ImageScaleMode) to enable either slicing or tiling of the texture
/// - [`TextureAtlas`] to draw specific section of the texture /// - [`TextureAtlas`] to draw a specific section of the texture
///
/// Note that `ImageScaleMode` is currently not compatible with `TextureAtlas`.
#[derive(Bundle, Clone, Debug)] #[derive(Bundle, Clone, Debug)]
pub struct ButtonBundle { pub struct ButtonBundle {
/// Describes the logical size of the node /// Describes the logical size of the node