Skip to content

Fix: support RenderLayer filtering for lights #23265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pauliusuza wants to merge 3 commits into
base: main
Choose a base branch
from
+459 −42
Open

Fix: support RenderLayer filtering for lights #23265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f17c16
Add RenderLayer example for Lights
pauliusuza Mar 8, 2026
d6bac8a
Fix: support RenderLayer filtering for lights #23264
pauliusuza Mar 8, 2026
2180e5d
Merge branch 'main' into main
pauliusuza Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1261,6 +1261,17 @@ description = "Illustrates various lighting options in a simple scene"
category = "3D Rendering"
wasm = true

[[example]]
name = "light_render_layers"
path = "examples/3d/light_render_layers.rs"
doc-scrape-examples = true

[package.metadata.example.light_render_layers]
name = "Light Render Layers"
description = "Demonstrates using render layers to control which directional and point lights affect meshes"
category = "3D Rendering"
wasm = true

[[example]]
name = "lines"
path = "examples/3d/lines.rs"
Expand Down
2 changes: 2 additions & 0 deletions crates/bevy_pbr/src/meshlet/visibility_buffer_resolve.wgsl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ struct VertexOutput {
ddy_uv: vec2<f32>,
world_tangent: vec4<f32>,
mesh_flags: u32,
render_layers: u32,
cluster_id: u32,
material_bind_group_slot: u32,
#ifdef PREPASS_FRAGMENT
Expand Down Expand Up @@ -172,6 +173,7 @@ fn resolve_vertex_output(frag_coord: vec4<f32>) -> VertexOutput {
ddy_uv,
world_tangent,
instance_uniform.flags,
instance_uniform.render_layers,
instance_id ^ meshlet_id,
instance_uniform.material_and_lightmap_bind_group_slot & 0xffffu,
#ifdef PREPASS_FRAGMENT
Expand Down
169 changes: 127 additions & 42 deletions crates/bevy_pbr/src/render/light.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ pub struct ExtractedPointLight {
pub shadow_normal_bias: f32,
pub shadow_map_near_z: f32,
pub spot_light_angles: Option<(f32, f32)>,
pub render_layers: RenderLayers,
pub volumetric: bool,
pub soft_shadows_enabled: bool,
/// whether this point light contributes diffuse light to lightmapped meshes
Expand Down Expand Up @@ -129,6 +130,28 @@ bitflags::bitflags! {
}
}

/// The first bit in light flags that stores packed render layer membership.
const LIGHT_RENDER_LAYERS_SHIFT: u32 = 6;
/// The bitmask used to store packed render layer membership in light flags.
const LIGHT_RENDER_LAYERS_MASK: u32 = (1 << (u32::BITS - LIGHT_RENDER_LAYERS_SHIFT)) - 1;

/// Packs render layers into light flags.
///
/// We reserve the lower bits for light feature flags. If layers outside the
/// packed range are used, we fall back to `all bits set` to preserve behavior.
fn render_layers_to_light_mask(render_layers: &RenderLayers) -> u32 {
let bits = render_layers.bits();
let low_bits = bits.first().copied().unwrap_or_default();
let unsupported_bits = (low_bits >> (u32::BITS - LIGHT_RENDER_LAYERS_SHIFT)) != 0
|| bits.iter().skip(1).any(|&extra_bits| extra_bits != 0);

if unsupported_bits {
LIGHT_RENDER_LAYERS_MASK
} else {
(low_bits as u32) & LIGHT_RENDER_LAYERS_MASK
}
}

#[derive(Copy, Clone, ShaderType, Default, Debug)]
pub struct GpuDirectionalCascade {
clip_from_world: Mat4,
Expand Down Expand Up @@ -300,6 +323,7 @@ pub fn extract_lights(
&GlobalTransform,
&ViewVisibility,
&CubemapFrusta,
Option<&RenderLayers>,
Option<&VolumetricLight>,
),
Or<(
Expand All @@ -308,6 +332,7 @@ pub fn extract_lights(
Changed<GlobalTransform>,
Changed<ViewVisibility>,
Changed<CubemapFrusta>,
Changed<RenderLayers>,
Changed<VolumetricLight>,
)>,
>,
Expand All @@ -322,6 +347,7 @@ pub fn extract_lights(
&GlobalTransform,
&ViewVisibility,
&Frustum,
Option<&RenderLayers>,
Option<&VolumetricLight>,
),
Or<(
Expand All @@ -330,6 +356,7 @@ pub fn extract_lights(
Changed<GlobalTransform>,
Changed<ViewVisibility>,
Changed<Frustum>,
Changed<RenderLayers>,
Changed<VolumetricLight>,
)>,
>,
Expand Down Expand Up @@ -413,6 +440,7 @@ pub fn extract_lights(
transform,
view_visibility,
frusta,
maybe_layers,
volumetric_light,
) in point_lights.iter()
{
Expand Down Expand Up @@ -462,6 +490,7 @@ pub fn extract_lights(
* core::f32::consts::SQRT_2,
shadow_map_near_z: point_light.shadow_map_near_z,
spot_light_angles: None,
render_layers: maybe_layers.unwrap_or_default().clone(),
volumetric: volumetric_light.is_some(),
affects_lightmapped_mesh_diffuse: point_light.affects_lightmapped_mesh_diffuse,
#[cfg(feature = "experimental_pbr_pcss")]
Expand Down Expand Up @@ -490,6 +519,7 @@ pub fn extract_lights(
transform,
view_visibility,
frustum,
maybe_layers,
volumetric_light,
) in spot_lights.iter()
{
Expand Down Expand Up @@ -538,6 +568,7 @@ pub fn extract_lights(
* core::f32::consts::SQRT_2,
shadow_map_near_z: spot_light.shadow_map_near_z,
spot_light_angles: Some((spot_light.inner_angle, spot_light.outer_angle)),
render_layers: maybe_layers.unwrap_or_default().clone(),
volumetric: volumetric_light.is_some(),
affects_lightmapped_mesh_diffuse: spot_light.affects_lightmapped_mesh_diffuse,
#[cfg(feature = "experimental_pbr_pcss")]
Expand Down Expand Up @@ -1005,6 +1036,8 @@ pub fn prepare_lights(

for (index, &(entity, _, light, _)) in point_lights.iter().enumerate() {
let mut flags = PointLightFlags::NONE;
let render_layers_mask = render_layers_to_light_mask(&light.render_layers);
flags |= PointLightFlags::from_bits_retain(render_layers_mask << LIGHT_RENDER_LAYERS_SHIFT);

// Lights are sorted, shadow enabled lights are first
if light.shadow_maps_enabled
Expand Down Expand Up @@ -1298,6 +1331,9 @@ pub fn prepare_lights(
num_directional_lights_for_this_view += 1;

let mut flags = DirectionalLightFlags::NONE;
let render_layers_mask = render_layers_to_light_mask(&light.render_layers);
flags |=
DirectionalLightFlags::from_bits_retain(render_layers_mask << LIGHT_RENDER_LAYERS_SHIFT);

// Lights are sorted, volumetric and shadow enabled lights are first
if light.volumetric
Expand Down Expand Up @@ -1904,12 +1940,27 @@ pub(crate) struct SpecializeShadowsSystemParam<'w, 's> {
render_lightmaps: Res<'w, RenderLightmaps>,
view_lights: Query<'w, 's, (Entity, &'static ViewLightEntities), With<ExtractedView>>,
view_light_entities: Query<'w, 's, (&'static LightEntity, &'static ExtractedView)>,
point_light_entities:
Query<'w, 's, &'static RenderCubemapVisibleEntities, With<ExtractedPointLight>>,
directional_light_entities:
Query<'w, 's, &'static RenderCascadesVisibleEntities, With<ExtractedDirectionalLight>>,
spot_light_entities:
Query<'w, 's, &'static RenderVisibleMeshEntities, With<ExtractedPointLight>>,
point_light_entities: Query<
'w,
's,
(&'static RenderCubemapVisibleEntities, &'static ExtractedPointLight),
With<ExtractedPointLight>,
>,
directional_light_entities: Query<
'w,
's,
(
&'static RenderCascadesVisibleEntities,
&'static ExtractedDirectionalLight,
),
With<ExtractedDirectionalLight>,
>,
spot_light_entities: Query<
'w,
's,
(&'static RenderVisibleMeshEntities, &'static ExtractedPointLight),
With<ExtractedPointLight>,
>,
Copy link
Copy Markdown
Contributor

@pcwalton pcwalton Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will collide with #23107. It's not a blocker though.

light_key_cache: Res<'w, LightKeyCache>,
specialized_shadow_material_pipeline_cache: ResMut<'w, SpecializedShadowMaterialPipelineCache>,
pending_shadow_queues: ResMut<'w, PendingShadowQueues>,
Expand Down Expand Up @@ -1963,28 +2014,41 @@ pub(crate) fn specialize_shadows(
continue;
};

let visible_entities = match light_entity {
let (visible_entities, light_render_layers) = match light_entity {
LightEntity::Directional {
light_entity,
cascade_index,
} => directional_light_entities
.get(*light_entity)
.expect("Failed to get directional light visible entities")
.entities
.get(&entity)
.expect("Failed to get directional light visible entities for view")
.get(*cascade_index)
.expect("Failed to get directional light visible entities for cascade"),
} => {
let (visible_entities, light) = directional_light_entities
.get(*light_entity)
.expect("Failed to get directional light visible entities");
(
visible_entities
.entities
.get(&entity)
.expect("Failed to get directional light visible entities for view")
.get(*cascade_index)
.expect(
"Failed to get directional light visible entities for cascade",
),
&light.render_layers,
)
}
LightEntity::Point {
light_entity,
face_index,
} => point_light_entities
.get(*light_entity)
.expect("Failed to get point light visible entities")
.get(*face_index),
LightEntity::Spot { light_entity } => spot_light_entities
.get(*light_entity)
.expect("Failed to get spot light visible entities"),
} => {
let (visible_entities, light) = point_light_entities
.get(*light_entity)
.expect("Failed to get point light visible entities");
(visible_entities.get(*face_index), &light.render_layers)
}
LightEntity::Spot { light_entity } => {
let (visible_entities, light) = spot_light_entities
.get(*light_entity)
.expect("Failed to get spot light visible entities");
(visible_entities, &light.render_layers)
}
};

let mut maybe_specialized_shadow_material_pipeline_cache =
Expand Down Expand Up @@ -2071,6 +2135,10 @@ pub(crate) fn specialize_shadows(
{
continue;
}
let mesh_layers = mesh_instance.render_layers.as_ref().unwrap_or_default();
if !light_render_layers.intersects(mesh_layers) {
continue;
}
let Some(mesh) = render_meshes.get(mesh_instance.mesh_asset_id()) else {
continue;
};
Expand Down Expand Up @@ -2178,12 +2246,14 @@ pub fn queue_shadows(
mesh_allocator: Res<MeshAllocator>,
view_lights: Query<(Entity, &ViewLightEntities, Option<&RenderLayers>), With<ExtractedView>>,
view_light_entities: Query<(&LightEntity, &ExtractedView)>,
point_light_entities: Query<&RenderCubemapVisibleEntities, With<ExtractedPointLight>>,
point_light_entities:
Query<(&RenderCubemapVisibleEntities, &ExtractedPointLight), With<ExtractedPointLight>>,
directional_light_entities: Query<
&RenderCascadesVisibleEntities,
(&RenderCascadesVisibleEntities, &ExtractedDirectionalLight),
With<ExtractedDirectionalLight>,
>,
spot_light_entities: Query<&RenderVisibleMeshEntities, With<ExtractedPointLight>>,
spot_light_entities:
Query<(&RenderVisibleMeshEntities, &ExtractedPointLight), With<ExtractedPointLight>>,
specialized_material_pipeline_cache: Res<SpecializedShadowMaterialPipelineCache>,
mut pending_shadow_queues: ResMut<PendingShadowQueues>,
dirty_specializations: Res<DirtySpecializations>,
Expand Down Expand Up @@ -2214,28 +2284,41 @@ pub fn queue_shadows(
"View pending shadow queues should have been created in `specialize_shadows`",
);

let visible_entities = match light_entity {
let (visible_entities, light_render_layers) = match light_entity {
LightEntity::Directional {
light_entity,
cascade_index,
} => directional_light_entities
.get(*light_entity)
.expect("Failed to get directional light visible entities")
.entities
.get(&entity)
.expect("Failed to get directional light visible entities for view")
.get(*cascade_index)
.expect("Failed to get directional light visible entities for cascade"),
} => {
let (visible_entities, light) = directional_light_entities
.get(*light_entity)
.expect("Failed to get directional light visible entities");
(
visible_entities
.entities
.get(&entity)
.expect("Failed to get directional light visible entities for view")
.get(*cascade_index)
.expect(
"Failed to get directional light visible entities for cascade",
),
&light.render_layers,
)
}
LightEntity::Point {
light_entity,
face_index,
} => point_light_entities
.get(*light_entity)
.expect("Failed to get point light visible entities")
.get(*face_index),
LightEntity::Spot { light_entity } => spot_light_entities
.get(*light_entity)
.expect("Failed to get spot light visible entities"),
} => {
let (visible_entities, light) = point_light_entities
.get(*light_entity)
.expect("Failed to get point light visible entities");
(visible_entities.get(*face_index), &light.render_layers)
}
LightEntity::Spot { light_entity } => {
let (visible_entities, light) = spot_light_entities
.get(*light_entity)
.expect("Failed to get spot light visible entities");
(visible_entities, &light.render_layers)
}
Copy link
Copy Markdown
Contributor

@pcwalton pcwalton Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, all of this will collide with #23107

};

// First, remove meshes that need to be respecialized, and those that were removed, from the bins.
Expand Down Expand Up @@ -2277,7 +2360,9 @@ pub fn queue_shadows(

let mesh_layers = mesh_instance.render_layers.as_ref().unwrap_or_default();
let camera_layers = camera_layers.unwrap_or_default();
if !camera_layers.intersects(mesh_layers) {
if !camera_layers.intersects(mesh_layers)
|| !light_render_layers.intersects(mesh_layers)
{
continue;
}

Expand Down
Loading
Loading