Skip to content
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

Jump to bottom

AmbientLight docs do not explain how to use the struct #7465

Closed
alice-i-cecile opened this issue Feb 2, 2023 · 2 comments
Closed

AmbientLight docs do not explain how to use the struct #7465

alice-i-cecile opened this issue Feb 2, 2023 · 2 comments
Labels
A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alice-i-cecile
Copy link
Member

How can Bevy's documentation be improved?

The docs for AmbientLight do not explain how it should be used.

By experimentation (and checking the trait impls), you insert it as a resource to light the scene. This should be explained in the docs.
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-Rendering Drawing game state to the screen labels Feb 2, 2023
@alice-i-cecile
Copy link
Member Author

Ah, apparently this is inserted by default via PbrPlugin. That would be very useful to explain too, along with listing the default values.

midnadimple added a commit to midnadimple/bevy that referenced this issue Feb 7, 2023
@midnadimple
Add Resource information to AmbientLight Docs
5eb4aba 
Addresses bevyengine#7465.

The documentation now tells the reader that AmbientLight is a Resource that has a default color of white and a default brightness of 0.05
@midnadimple midnadimple mentioned this issue Feb 7, 2023
Closed
@rparrett
Copy link
Contributor

Looks like this was fixed in #10712

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Resource information to AmbientLight Docs midnadimple/bevy
2 participants
@rparrett @alice-i-cecile