Make IrradianceVolume require LightProbe (and document this).
#19621
+11
−7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is consistent with Bevy’s other treatments of cubes but still should be documented rather than implied.
IceSentry
approved these changes
Jun 13, 2025
IceSentry
added
the
S-Needs-Review
alice-i-cecile
approved these changes
Jun 13, 2025
alice-i-cecile
added
C-Usability
hukasu
pushed a commit
to hukasu/bevy
that referenced
this pull request
Jun 15, 2025
…vyengine#19621) ## Objective Make it easier to use `IrradianceVolume` with fewer ways to silently fail. Fix bevyengine#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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Make it easier to use
IrradianceVolumewith fewer ways to silently fail. Fix #19614.Solution
#[require(LightProbe)]tostruct IrradianceVolume.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 requireLightProbe.Testing
examples/3d/irradiance_volumes.rsstill works after removingLightProbe.