bevy/crates/bevy_pbr/src
Kristoffer Søholm 2d1b4939d2
Synchronize removed components with the render world (#15582)
# Objective

Fixes #15560
Fixes (most of) #15570

Currently a lot of examples (and presumably some user code) depend on
toggling certain render features by adding/removing a single component
to an entity, e.g. `SpotLight` to toggle a light. Because of the
retained render world this no longer works: Extract will add any new
components, but when it is removed the entity persists unchanged in the
render world.

## Solution

Add `SyncComponentPlugin<C: Component>` that registers
`SyncToRenderWorld` as a required component for `C`, and adds a
component hook that will clear all components from the render world
entity when `C` is removed. We add this plugin to
`ExtractComponentPlugin` which fixes most instances of the problem. For
custom extraction logic we can manually add `SyncComponentPlugin` for
that component.

We also rename `WorldSyncPlugin` to `SyncWorldPlugin` so we start a
naming convention like all the `Extract` plugins.

In this PR I also fixed a bunch of breakage related to the retained
render world, stemming from old code that assumed that `Entity` would be
the same in both worlds.

I found that using the `RenderEntity` wrapper instead of `Entity` in
data structures when referring to render world entities makes intent
much clearer, so I propose we make this an official pattern.

## Testing

Run examples like

```
cargo run --features pbr_multi_layer_material_textures --example clearcoat
cargo run --example volumetric_fog
```

and see that they work, and that toggles work correctly. But really we
should test every single example, as we might not even have caught all
the breakage yet.

---

## Migration Guide

The retained render world notes should be updated to explain this edge
case and `SyncComponentPlugin`

---------

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Trashtalk217 <trashtalk217@gmail.com>
2024-10-08 22:23:17 +00:00
..
cluster Synchronize removed components with the render world (#15582) 2024-10-08 22:23:17 +00:00
deferred Fix deferred rendering (#15656) 2024-10-04 22:51:23 +00:00
light Synchronize removed components with the render world (#15582) 2024-10-08 22:23:17 +00:00
light_probe Synchronize removed components with the render world (#15582) 2024-10-08 22:23:17 +00:00
lightmap Migrate meshes and materials to required components (#15524) 2024-10-01 21:33:17 +00:00
meshlet Per-meshlet compressed vertex data (#15643) 2024-10-08 18:42:55 +00:00
prepass Synchronize removed components with the render world (#15582) 2024-10-08 22:23:17 +00:00
render Synchronize removed components with the render world (#15582) 2024-10-08 22:23:17 +00:00
ssao Synchronize removed components with the render world (#15582) 2024-10-08 22:23:17 +00:00
ssr Migrate motion blur, TAA, SSAO, and SSR to required components (#15572) 2024-10-01 22:45:31 +00:00
volumetric_fog Synchronize removed components with the render world (#15582) 2024-10-08 22:23:17 +00:00
bundle.rs Synchronize removed components with the render world (#15582) 2024-10-08 22:23:17 +00:00
extended_material.rs Simpler lint fixes: makes ci lints work but disables a lint for now (#15376) 2024-09-24 11:42:59 +00:00
fog.rs Migrate cameras to required components (#15641) 2024-10-05 01:59:52 +00:00
lib.rs Synchronize removed components with the render world (#15582) 2024-10-08 22:23:17 +00:00
material.rs Add Order Independent Transparency (#14876) 2024-10-07 23:50:28 +00:00
mesh_material.rs Migrate meshes and materials to required components (#15524) 2024-10-01 21:33:17 +00:00
parallax.rs
pbr_material.rs Simpler lint fixes: makes ci lints work but disables a lint for now (#15376) 2024-09-24 11:42:59 +00:00
wireframe.rs Revert "Have EntityCommands methods consume self for easier chaining" (#15523) 2024-10-02 12:47:26 +00:00