diff --git a/crates/bevy_render/src/spatial_bundle.rs b/crates/bevy_render/src/spatial_bundle.rs index 5287c3880460a..27dba5c215a77 100644 --- a/crates/bevy_render/src/spatial_bundle.rs +++ b/crates/bevy_render/src/spatial_bundle.rs @@ -3,16 +3,18 @@ use bevy_transform::prelude::{GlobalTransform, Transform}; use crate::view::{InheritedVisibility, ViewVisibility, Visibility}; -/// A [`Bundle`] with the following [`Component`](bevy_ecs::component::Component)s: -/// * [`Visibility`], and [`InheritedVisibility`], which describe the visibility of an entity -/// * [`Transform`] and [`GlobalTransform`], which describe the position of an entity +/// A [`Bundle`] that allows the correct positional rendering of an entity. /// -/// * To show or hide an entity, you should set its [`Visibility`]. -/// * To get the computed visibility of an entity, you should get its [`InheritedVisibility`] or [`ViewVisibility`] components. -/// * To place or move an entity, you should set its [`Transform`]. -/// * To get the global transform of an entity, you should get its [`GlobalTransform`]. -/// * For hierarchies to work correctly, you must have all four components. -/// * You may use the [`SpatialBundle`] to guarantee this. +/// It consists of transform components, +/// controlling position, rotation and scale of the entity, +/// but also visibility components, +/// which determine whether the entity is visible or not. +/// +/// Parent-child hierarchies of entities must contain +/// all the [`Component`]s in this `Bundle` +/// to be rendered correctly. +/// +/// [`Component`]: bevy_ecs::component::Component #[derive(Bundle, Debug, Default)] pub struct SpatialBundle { /// The visibility of the entity.