Skip to content
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.

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

Visibility as a marker component #3796

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions crates/bevy_pbr/src/bundle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use bevy_reflect::Reflect;
use bevy_render::{
mesh::Mesh,
primitives::{CubemapFrusta, Frustum},
view::{ComputedVisibility, Visibility, VisibleEntities},
view::{ComputedVisibility, Visible, VisibleEntities},
};
use bevy_transform::components::{GlobalTransform, Transform};

Expand All @@ -20,7 +20,7 @@ pub struct MaterialMeshBundle<M: SpecializedMaterial> {
pub transform: Transform,
pub global_transform: GlobalTransform,
/// User indication of whether an entity is visible
pub visibility: Visibility,
pub visible: Visible,
/// Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering
pub computed_visibility: ComputedVisibility,
}
Expand All @@ -32,7 +32,7 @@ impl<M: SpecializedMaterial> Default for MaterialMeshBundle<M> {
material: Default::default(),
transform: Default::default(),
global_transform: Default::default(),
visibility: Default::default(),
visible: Default::default(),
computed_visibility: Default::default(),
}
}
Expand Down
24 changes: 4 additions & 20 deletions crates/bevy_pbr/src/light.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use bevy_render::{
camera::{Camera, CameraProjection, OrthographicProjection},
color::Color,
primitives::{Aabb, CubemapFrusta, Frustum, Sphere},
view::{ComputedVisibility, RenderLayers, Visibility, VisibleEntities},
view::{ComputedVisibility, RenderLayers, Visible, VisibleEntities},
};
use bevy_transform::components::GlobalTransform;
use bevy_window::Windows;
Expand Down Expand Up @@ -705,13 +705,12 @@ pub fn check_light_mesh_visibility(
mut visible_entity_query: Query<
(
Entity,
&Visibility,
&mut ComputedVisibility,
Option<&RenderLayers>,
Option<&Aabb>,
Option<&GlobalTransform>,
),
Without<NotShadowCaster>,
(Without<NotShadowCaster>, With<Visible>),
>,
) {
// Directonal lights
Expand All @@ -727,19 +726,9 @@ pub fn check_light_mesh_visibility(

let view_mask = maybe_view_mask.copied().unwrap_or_default();

for (
entity,
visibility,
mut computed_visibility,
maybe_entity_mask,
maybe_aabb,
maybe_transform,
) in visible_entity_query.iter_mut()
for (entity, mut computed_visibility, maybe_entity_mask, maybe_aabb, maybe_transform) in
visible_entity_query.iter_mut()
{
if !visibility.is_visible {
continue;
}

let entity_mask = maybe_entity_mask.copied().unwrap_or_default();
if !view_mask.intersects(&entity_mask) {
continue;
Expand Down Expand Up @@ -788,17 +777,12 @@ pub fn check_light_mesh_visibility(

for (
entity,
visibility,
mut computed_visibility,
maybe_entity_mask,
maybe_aabb,
maybe_transform,
) in visible_entity_query.iter_mut()
{
if !visibility.is_visible {
continue;
}

let entity_mask = maybe_entity_mask.copied().unwrap_or_default();
if !view_mask.intersects(&entity_mask) {
continue;
Expand Down
4 changes: 2 additions & 2 deletions crates/bevy_render/src/camera/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ pub use projection::*;

use crate::{
primitives::Aabb,
view::{ComputedVisibility, ExtractedView, Visibility, VisibleEntities},
view::{ComputedVisibility, ExtractedView, Visible, VisibleEntities},
RenderApp, RenderStage,
};
use bevy_app::{App, CoreStage, Plugin};
Expand All @@ -34,7 +34,7 @@ impl Plugin for CameraPlugin {
active_cameras.add(Self::CAMERA_2D);
active_cameras.add(Self::CAMERA_3D);
app.register_type::<Camera>()
.register_type::<Visibility>()
.register_type::<Visible>()
.register_type::<ComputedVisibility>()
.register_type::<OrthographicProjection>()
.register_type::<PerspectiveProjection>()
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_render/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pub mod prelude {
mesh::{shape, Mesh},
render_resource::Shader,
texture::Image,
view::{ComputedVisibility, Msaa, Visibility},
view::{ComputedVisibility, Msaa, Visible},
};
}

Expand Down
39 changes: 14 additions & 25 deletions crates/bevy_render/src/view/visibility/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,10 @@ use crate::{
primitives::{Aabb, Frustum},
};

/// User indication of whether an entity is visible
#[derive(Component, Clone, Reflect, Debug)]
/// User indication of whether an entity is visible as a marker component
#[derive(Component, Copy, Clone, Reflect, Debug, Default)]
#[reflect(Component)]
pub struct Visibility {
pub is_visible: bool,
}

impl Default for Visibility {
fn default() -> Self {
Self { is_visible: true }
}
}
pub struct Visible;
Copy link
Member

Choose a reason for hiding this comment

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

Once we have benchmarks for this, we should be testing how changing this component's storage type impacts performance.


/// Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering
#[derive(Component, Clone, Reflect, Debug)]
Expand Down Expand Up @@ -140,15 +132,17 @@ pub fn check_visibility(
mut view_query: Query<(&mut VisibleEntities, &Frustum, Option<&RenderLayers>), With<Camera>>,
mut visible_entity_query: QuerySet<(
QueryState<&mut ComputedVisibility>,
QueryState<(
Entity,
&Visibility,
&mut ComputedVisibility,
Option<&RenderLayers>,
Option<&Aabb>,
Option<&NoFrustumCulling>,
Option<&GlobalTransform>,
)>,
QueryState<
(
Entity,
&mut ComputedVisibility,
Option<&RenderLayers>,
Option<&Aabb>,
Option<&NoFrustumCulling>,
Option<&GlobalTransform>,
),
With<Visible>,
>,
)>,
) {
// Reset the computed visibility to false
Expand All @@ -162,18 +156,13 @@ pub fn check_visibility(

for (
entity,
visibility,
mut computed_visibility,
maybe_entity_mask,
maybe_aabb,
maybe_no_frustum_culling,
maybe_transform,
) in visible_entity_query.q1().iter_mut()
{
if !visibility.is_visible {
continue;
}

let entity_mask = maybe_entity_mask.copied().unwrap_or_default();
if !view_mask.intersects(&entity_mask) {
continue;
Expand Down
8 changes: 4 additions & 4 deletions crates/bevy_sprite/src/bundle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use bevy_asset::Handle;
use bevy_ecs::bundle::Bundle;
use bevy_render::{
texture::{Image, DEFAULT_IMAGE_HANDLE},
view::Visibility,
view::Visible,
};
use bevy_transform::components::{GlobalTransform, Transform};

Expand All @@ -17,7 +17,7 @@ pub struct SpriteBundle {
pub global_transform: GlobalTransform,
pub texture: Handle<Image>,
/// User indication of whether an entity is visible
pub visibility: Visibility,
pub visible: Visible,
}

impl Default for SpriteBundle {
Expand All @@ -27,7 +27,7 @@ impl Default for SpriteBundle {
transform: Default::default(),
global_transform: Default::default(),
texture: DEFAULT_IMAGE_HANDLE.typed(),
visibility: Default::default(),
visible: Default::default(),
}
}
}
Expand All @@ -43,5 +43,5 @@ pub struct SpriteSheetBundle {
pub transform: Transform,
pub global_transform: GlobalTransform,
/// User indication of whether an entity is visible
pub visibility: Visibility,
pub visible: Visible,
}
6 changes: 3 additions & 3 deletions crates/bevy_sprite/src/mesh2d/material.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use bevy_render::{
SpecializedPipeline, SpecializedPipelines,
},
renderer::RenderDevice,
view::{ComputedVisibility, Msaa, Visibility, VisibleEntities},
view::{ComputedVisibility, Msaa, Visible, VisibleEntities},
RenderApp, RenderStage,
};
use bevy_transform::components::{GlobalTransform, Transform};
Expand Down Expand Up @@ -326,7 +326,7 @@ pub struct MaterialMesh2dBundle<M: SpecializedMaterial2d> {
pub transform: Transform,
pub global_transform: GlobalTransform,
/// User indication of whether an entity is visible
pub visibility: Visibility,
pub visible: Visible,
/// Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering
pub computed_visibility: ComputedVisibility,
}
Expand All @@ -338,7 +338,7 @@ impl<M: SpecializedMaterial2d> Default for MaterialMesh2dBundle<M> {
material: Default::default(),
transform: Default::default(),
global_transform: Default::default(),
visibility: Default::default(),
visible: Default::default(),
computed_visibility: Default::default(),
}
}
Expand Down
24 changes: 8 additions & 16 deletions crates/bevy_sprite/src/render/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ use bevy_render::{
render_resource::{std140::AsStd140, *},
renderer::{RenderDevice, RenderQueue},
texture::{BevyDefault, Image},
view::{Msaa, ViewUniform, ViewUniformOffset, ViewUniforms, Visibility},
view::{Msaa, ViewUniform, ViewUniformOffset, ViewUniforms, Visible},
RenderWorld,
};
use bevy_transform::components::GlobalTransform;
Expand Down Expand Up @@ -232,20 +232,15 @@ pub fn extract_sprite_events(
pub fn extract_sprites(
mut render_world: ResMut<RenderWorld>,
texture_atlases: Res<Assets<TextureAtlas>>,
sprite_query: Query<(&Visibility, &Sprite, &GlobalTransform, &Handle<Image>)>,
atlas_query: Query<(
&Visibility,
&TextureAtlasSprite,
&GlobalTransform,
&Handle<TextureAtlas>,
)>,
sprite_query: Query<(&Sprite, &GlobalTransform, &Handle<Image>), With<Visible>>,
atlas_query: Query<
(&TextureAtlasSprite, &GlobalTransform, &Handle<TextureAtlas>),
With<Visible>,
>,
) {
let mut extracted_sprites = render_world.get_resource_mut::<ExtractedSprites>().unwrap();
extracted_sprites.sprites.clear();
for (visibility, sprite, transform, handle) in sprite_query.iter() {
if !visibility.is_visible {
continue;
}
for (sprite, transform, handle) in sprite_query.iter() {
// PERF: we don't check in this function that the `Image` asset is ready, since it should be in most cases and hashing the handle is expensive
extracted_sprites.sprites.alloc().init(ExtractedSprite {
color: sprite.color,
Expand All @@ -259,10 +254,7 @@ pub fn extract_sprites(
image_handle_id: handle.id,
});
}
for (visibility, atlas_sprite, transform, texture_atlas_handle) in atlas_query.iter() {
if !visibility.is_visible {
continue;
}
for (atlas_sprite, transform, texture_atlas_handle) in atlas_query.iter() {
if let Some(texture_atlas) = texture_atlases.get(texture_atlas_handle) {
let rect = Some(texture_atlas.textures[atlas_sprite.index as usize]);
extracted_sprites.sprites.alloc().init(ExtractedSprite {
Expand Down
13 changes: 5 additions & 8 deletions crates/bevy_text/src/text2d.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use bevy_ecs::{
system::{Local, Query, QuerySet, Res, ResMut},
};
use bevy_math::{Size, Vec3};
use bevy_render::{texture::Image, view::Visibility, RenderWorld};
use bevy_render::{texture::Image, view::Visible, RenderWorld};
use bevy_sprite::{ExtractedSprite, ExtractedSprites, TextureAtlas};
use bevy_transform::prelude::{GlobalTransform, Transform};
use bevy_window::Windows;
Expand All @@ -24,7 +24,7 @@ pub struct Text2dBundle {
pub transform: Transform,
pub global_transform: GlobalTransform,
pub text_2d_size: Text2dSize,
pub visibility: Visibility,
pub visible: Visible,
}

impl Default for Text2dBundle {
Expand All @@ -36,7 +36,7 @@ impl Default for Text2dBundle {
text_2d_size: Text2dSize {
size: Size::default(),
},
visibility: Default::default(),
visible: Default::default(),
}
}
}
Expand All @@ -46,7 +46,7 @@ pub fn extract_text2d_sprite(
texture_atlases: Res<Assets<TextureAtlas>>,
text_pipeline: Res<DefaultTextPipeline>,
windows: Res<Windows>,
text2d_query: Query<(Entity, &Visibility, &Text, &GlobalTransform, &Text2dSize)>,
text2d_query: Query<(Entity, &Text, &GlobalTransform, &Text2dSize), With<Visible>>,
) {
let mut extracted_sprites = render_world.get_resource_mut::<ExtractedSprites>().unwrap();

Expand All @@ -56,10 +56,7 @@ pub fn extract_text2d_sprite(
1.
};

for (entity, visibility, text, transform, calculated_size) in text2d_query.iter() {
if !visibility.is_visible {
continue;
}
for (entity, text, transform, calculated_size) in text2d_query.iter() {
let (width, height) = (calculated_size.size.width, calculated_size.size.height);

if let Some(text_layout) = text_pipeline.get_glyphs(&entity) {
Expand Down
Loading