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

Clarify RenderLayers docs (#19241)

Browse Source 
# Objective

Clarify `RenderLayers` docs, to fix
https://github.com/bevyengine/bevy/issues/18874

## Solution

-

## Testing

-
This commit is contained in:
theotherphil 2025-05-26 20:52:22 +01:00 committed by GitHub
parent a521998eea
commit 07c9d1acce
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
crates/bevy_render/src/view/visibility/render_layers.rs
View File

@ -7,18 +7,14 @@ pub const DEFAULT_LAYERS: &RenderLayers = &RenderLayers::layer(0);
/// An identifier for a rendering layer.
pub type Layer = usize;
/// Describes which rendering layers an entity belongs to.
/// Defines which rendering layers an entity belongs to.
///
/// Cameras with this component will only render entities with intersecting
/// layers.
/// A camera renders an entity only when their render layers intersect.
///
/// Entities may belong to one or more layers, or no layer at all.
/// The [`Default`] instance of `RenderLayers` contains layer `0`, the first layer. Entities
/// without this component also belong to layer `0`.
///
/// The [`Default`] instance of `RenderLayers` contains layer `0`, the first layer.
///
/// An entity with this component without any layers is invisible.
///
/// Entities without this component belong to layer `0`.
/// An empty `RenderLayers` makes the entity invisible.
#[derive(Component, Clone, Reflect, PartialEq, Eq, PartialOrd, Ord)]
#[reflect(Component, Default, PartialEq, Debug, Clone)]
pub struct RenderLayers(SmallVec<[u64; INLINE_BLOCKS]>);