Skip to content

IrradianceVolume has undocumented dependency on LightProbe to be functional #19614

Closed
@kpreid

Description

@kpreid

https://docs.rs/bevy/0.16.1/bevy/pbr/irradiance_volume/index.html
https://docs.rs/bevy/0.16.1/bevy/pbr/irradiance_volume/struct.IrradianceVolume.html

Neither of these pages mentions that the entity having an IrradianceVolume component must also have a LightProbe component; I had to find that out by reading example code.

commands.spawn((
Transform::from_matrix(VOXEL_FROM_WORLD),
IrradianceVolume {
voxels: assets.irradiance_volume.clone(),
intensity: IRRADIANCE_VOLUME_INTENSITY,
..default()
},
LightProbe,
));

This should be either documented, a required component, or both; I don't know which would be best.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-RenderingDrawing game state to the screenC-DocsAn addition or correction to our documentationC-UsabilityA targeted quality-of-life change that makes Bevy easier to useD-StraightforwardSimple bug fixes and API improvements, docs, test and examplesS-Ready-For-ImplementationThis issue is ready for an implementation PR. Go for it!

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions