Skip to content

[Merged by Bors] - add default direction to DirectionalLight docs #5188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

[Merged by Bors] - add default direction to DirectionalLight docs #5188

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
45baf92
add default direction to DirectionalLight docs
strattonbrazil Jul 3, 2022
417aff2
Update light.rs
strattonbrazil Jul 3, 2022
c6d5dc7
Update crates/bevy_pbr/src/light.rs
strattonbrazil Jul 4, 2022
895a1a0
specify local rotation affects direction
strattonbrazil Aug 1, 2022
b87478a
Update crates/bevy_pbr/src/light.rs
strattonbrazil Aug 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions crates/bevy_pbr/src/light.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ impl Default for PointLightShadowMap {
/// approximation for light sources VERY far away, like the sun or
/// the moon.
///
/// By default, the light shines along the negative-Z axis and the local
/// transform adjusts its direction.
Copy link
Member

@alice-i-cecile alice-i-cecile Jul 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// transform adjusts its direction.
/// transform adjusts its direction.
/// The light always points in the "forward" direction of its local rotation.

Copy link
Contributor

@superdump superdump Jul 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem with this is that people don’t always know that negative z is forward.

Copy link
Member

@alice-i-cecile alice-i-cecile Jul 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's explained above, so I think this is fine.

Copy link
Contributor

@superdump superdump Jul 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I misread the diff in the email and thought you were replacing the text. I see now you added to it. Apologies.

///
/// Valid values for `illuminance` are:
///
/// | Illuminance (lux) | Surfaces illuminated by |
Expand Down