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

Clearer spatial bundle pub const docs (#14293)

Browse Source 
# Objective

The docs on SpatialBundle's pub const constructors mention that one is
"visible" when it's actually inherited, which afaik means it's
conditional on its parent's visibility.

I feel it's more correct like this.

_Also I'm seeing how making a PR from github.dev works hopefully nothing
weird happens_
This commit is contained in:
Torstein Grindvik 2024-07-15 18:03:09 +02:00 committed by GitHub
parent b6f61b3ac6
commit ee0a85766d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/bevy_render/src/spatial_bundle.rs
View File

@ -41,7 +41,7 @@ impl SpatialBundle {
} }
} }
/// A visible [`SpatialBundle`], with no translation, rotation, and a scale of 1 on all axes. /// A [`SpatialBundle`] with inherited visibility and identity transform.
pub const INHERITED_IDENTITY: Self = SpatialBundle { pub const INHERITED_IDENTITY: Self = SpatialBundle {
visibility: Visibility::Inherited, visibility: Visibility::Inherited,
inherited_visibility: InheritedVisibility::HIDDEN, inherited_visibility: InheritedVisibility::HIDDEN,
@ -50,7 +50,7 @@ impl SpatialBundle {
global_transform: GlobalTransform::IDENTITY, global_transform: GlobalTransform::IDENTITY,
}; };
/// An invisible [`SpatialBundle`], with no translation, rotation, and a scale of 1 on all axes. /// An invisible [`SpatialBundle`] with identity transform.
pub const HIDDEN_IDENTITY: Self = SpatialBundle { pub const HIDDEN_IDENTITY: Self = SpatialBundle {
visibility: Visibility::Hidden, visibility: Visibility::Hidden,
..Self::INHERITED_IDENTITY ..Self::INHERITED_IDENTITY