bevy/crates/bevy_pbr/src
Kevin Reid ce3db843bc
Make IrradianceVolume require LightProbe (and document this). (#19621)
## Objective

Make it easier to use `IrradianceVolume` with fewer ways to silently
fail. Fix #19614.

## Solution

* Add `#[require(LightProbe)]` to `struct IrradianceVolume`.
* Document this fact.
* Also document the volume being centered on the origin by default (this
was the other thing that was unclear when getting started).

I also looked at the other implementor of `LightProbeComponent`,
`EnvironmentMapLight`, but it has a use which is *not* as a light probe,
so it should not require `LightProbe`.

## Testing

* Confirmed that `examples/3d/irradiance_volumes.rs` still works after
removing `LightProbe`.
* Reviewed generated documentation.
2025-06-13 17:09:31 +00:00
..
atmosphere Remove Shader weak_handles from bevy_pbr (excluding meshlets). (#19365) 2025-05-27 22:32:47 +00:00
cluster Rename bevy_platform_support to bevy_platform (#18813) 2025-04-11 23:13:28 +00:00
decal Remove Shader weak_handles from bevy_pbr (excluding meshlets). (#19365) 2025-05-27 22:32:47 +00:00
deferred Use embedded_asset to load PBR shaders (#19137) 2025-05-16 05:47:34 +00:00
light Make light cascades and tonemapping luts pub (#19189) 2025-05-27 19:46:04 +00:00
light_probe Make IrradianceVolume require LightProbe (and document this). (#19621) 2025-06-13 17:09:31 +00:00
lightmap Component lifecycle reorganization and documentation (#19543) 2025-06-10 00:59:16 +00:00
meshlet Adopt consistent FooSystems naming convention for system sets (#18900) 2025-05-06 15:18:03 +00:00
prepass Remove Shader weak_handles from bevy_pbr (excluding meshlets). (#19365) 2025-05-27 22:32:47 +00:00
render Rename Trigger to On (#19596) 2025-06-12 18:22:33 +00:00
ssao Remove Shader weak_handles from bevy_pbr (excluding meshlets). (#19365) 2025-05-27 22:32:47 +00:00
ssr Remove Shader weak_handles from bevy_pbr (excluding meshlets). (#19365) 2025-05-27 22:32:47 +00:00
volumetric_fog Remove Shader weak_handles from bevy_pbr (excluding meshlets). (#19365) 2025-05-27 22:32:47 +00:00
components.rs reexport entity set collections in entity module (#18413) 2025-03-30 03:51:14 +00:00
extended_material.rs Rename bevy_platform_support to bevy_platform (#18813) 2025-04-11 23:13:28 +00:00
fog.rs bevy_reflect: Add clone registrations project-wide (#18307) 2025-03-17 18:32:35 +00:00
lib.rs bevyengine.org -> bevy.org (#19503) 2025-06-05 23:09:28 +00:00
material_bind_groups.rs Fixed memory leak in bindless material (#19041) 2025-05-30 19:36:56 +00:00
material.rs Adopt consistent FooSystems naming convention for system sets (#18900) 2025-05-06 15:18:03 +00:00
mesh_material.rs bevy_reflect: Add clone registrations project-wide (#18307) 2025-03-17 18:32:35 +00:00
parallax.rs bevy_reflect: Add clone registrations project-wide (#18307) 2025-03-17 18:32:35 +00:00
pbr_material.rs Use embedded_asset to load PBR shaders (#19137) 2025-05-16 05:47:34 +00:00
wireframe.rs Remove Shader weak_handles from bevy_pbr (excluding meshlets). (#19365) 2025-05-27 22:32:47 +00:00