Sprite culling does not update Aabb when Handle<Image> changes

[bonsairobo]

Bevy version

0.12

What you did

I upgraded from Bevy 0.10 to 0.12 and noticed that sprites would disappear before they had completely left the camera view. I assume this is just because sprite culling was implemented (with bugs) after 0.10.

What went wrong

Here's a video. Notice how the spinning cards will pop out when their center leaves the view.

card_clipping_bug.mp4

Additional information

I know what the root cause is. When Sprites are spawned, for some reason they have a "placeholder" Image asset which is only 1x1 pixels. The function calculate_bounds_2d relies on the Image to calculate bounds when there is no custom_size set on the Sprite. However, the change detection on this query does not account for Changed<Handle<Image>>.

bevy/crates/bevy_sprite/src/lib.rs

Lines 130 to 165 in fe777d5

	pub fn calculate_bounds_2d(
	mut commands: Commands,
	meshes: Res<Assets<Mesh>>,
	images: Res<Assets<Image>>,
	atlases: Res<Assets<TextureAtlasLayout>>,
	meshes_without_aabb: Query<(Entity, &Mesh2dHandle), (Without<Aabb>, Without<NoFrustumCulling>)>,
	sprites_to_recalculate_aabb: Query<
	(Entity, &Sprite, &Handle<Image>, Option<&TextureAtlas>),
	(
	Or<(Without<Aabb>, Changed<Sprite>, Changed<TextureAtlas>)>,
	Without<NoFrustumCulling>,
	),
	>,
	) {
	for (entity, mesh_handle) in &meshes_without_aabb {
	if let Some(mesh) = meshes.get(&mesh_handle.0) {
	if let Some(aabb) = mesh.compute_aabb() {
	commands.entity(entity).try_insert(aabb);
	}
	}
	}
	for (entity, sprite, texture_handle, atlas) in &sprites_to_recalculate_aabb {
	if let Some(size) = sprite.custom_size.or_else(|| match atlas {
	// We default to the texture size for regular sprites
	None => images.get(texture_handle).map(|image| image.size_f32()),
	// We default to the drawn rect for atlas sprites
	Some(atlas) => atlas.texture_rect(&atlases).map(|rect| rect.size()),
	}) {
	let aabb = Aabb {
	center: (-sprite.anchor.as_vec() * size).extend(0.0).into(),
	half_extents: (0.5 * size).extend(0.0).into(),
	};
	commands.entity(entity).try_insert(aabb);
	}
	}
	}

I believe the addition of Changed<Handle<Image>> is necessary but not sufficient to completely fix this issue, as we still need to fix #5069.

Related: #10587