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

Revamp global illumination documentation #6216

Merged
merged 1 commit into from
Feb 3, 2023
Merged

Revamp global illumination documentation #6216

merged 1 commit into from
Feb 3, 2023

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Sep 23, 2022 •
edited
Loading

Detailed documentation for SSIL will be added in a separate pull request that rewrites the Environment and post-processing page. I plan to tackle this on my end.
Edit: I opened a PR for updated Environment docs: #6273

Testing project used for ReflectionProbe comparison screenshots: test_reflection_probe_vs_ssr.zip

@Calinou Calinou added enhancement content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features labels Sep 23, 2022
@cybereality
Copy link

I might be interested with helping on this. I can at least provide some shots for reflection probe and SSR, etc.

skyace65
skyace65 requested changes Sep 24, 2022
View reviewed changes
tutorials/3d/sdfgi.rst Outdated Show resolved Hide resolved
tutorials/3d/using_voxel_gi.rst Outdated Show resolved Hide resolved
tutorials/3d/using_voxel_gi.rst Outdated Show resolved Hide resolved
skyace65
skyace65 approved these changes Sep 25, 2022
View reviewed changes
Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

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

Looks good now!

@Calinou Calinou mentioned this pull request Sep 27, 2022
Open
41 tasks
mhilbrunner
mhilbrunner approved these changes Oct 1, 2022
View reviewed changes
Copy link
Member

@mhilbrunner mhilbrunner left a comment

Choose a reason for hiding this comment

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

Great work, read it twice now and spotted no errors so far. :)

@clayjohn clayjohn self-requested a review October 2, 2022 14:13
clayjohn
clayjohn reviewed Oct 6, 2022
View reviewed changes
Copy link
Member

@clayjohn clayjohn left a comment

Choose a reason for hiding this comment

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

Great work! I have provided a few comments for your consideration

tutorials/3d/baked_lightmaps.rst Outdated Show resolved Hide resolved
tutorials/3d/baked_lightmaps.rst Outdated Show resolved Hide resolved
tutorials/3d/baked_lightmaps.rst Outdated Show resolved Hide resolved
tutorials/3d/baked_lightmaps.rst Outdated Show resolved Hide resolved
tutorials/3d/baked_lightmaps.rst Show resolved Hide resolved
tutorials/3d/sdfgi.rst Outdated Show resolved Hide resolved
tutorials/3d/sdfgi.rst Outdated Show resolved Hide resolved
tutorials/3d/sdfgi.rst Outdated Show resolved Hide resolved
tutorials/3d/using_voxel_gi.rst Outdated Show resolved Hide resolved
tutorials/3d/using_voxel_gi.rst Outdated Show resolved Hide resolved
@Calinou Calinou marked this pull request as draft October 6, 2022 17:39
@Calinou Calinou mentioned this pull request Oct 6, 2022
Merged
@Calinou Calinou force-pushed the revamp-gi-docs branch 4 times, most recently from b071cf0 to 8d8538d Compare October 12, 2022 17:53
@clayjohn clayjohn mentioned this pull request Oct 23, 2022
Closed
@Calinou Calinou mentioned this pull request Nov 2, 2022
Merged
@skyace65 skyace65 added the area:manual Issues and PRs related to the Manual/Tutorials section of the documentation label Jan 13, 2023
@Calinou Calinou marked this pull request as ready for review January 13, 2023 22:18
@Calinou
Copy link
Member Author

Calinou commented Jan 13, 2023 •
edited
Loading

I've added comparison screenshots on the reflection page between reflection probe only, SSR only and both.

Please review, so that other PRs depending on this one can be merged afterwards 🙂

skyace65
skyace65 approved these changes Jan 14, 2023
View reviewed changes
Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

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

I skimmed through this again quickly, everything still looks good. The new PNGs should be webp but this PR predates that standard change, and since the png files are small I'd be fine with merging it as is just to get it done.

@skyace65
Copy link
Contributor

@clayjohn do you want to look over this again?

clayjohn
clayjohn reviewed Jan 16, 2023
View reviewed changes
tutorials/3d/introduction_to_global_illumination.rst Outdated Show resolved Hide resolved
tutorials/3d/introduction_to_global_illumination.rst Outdated Show resolved Hide resolved
tutorials/3d/introduction_to_global_illumination.rst Outdated Show resolved Hide resolved
tutorials/3d/using_voxel_gi.rst Outdated Show resolved Hide resolved
@Calinou
Revamp global illumination documentation
6e45352 
- Add an introduction page with an explanation and comparison table.
- Add a page on faking global illumination.
@Calinou
Copy link
Member Author

Calinou commented Jan 30, 2023

I applied suggestions and converted images added in this pull request to WebP.

@skyace65 skyace65 merged commit 8f0a570 into godotengine:master Feb 3, 2023
@Calinou Calinou deleted the revamp-gi-docs branch February 3, 2023 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@clayjohn clayjohn clayjohn left review comments

@mhilbrunner mhilbrunner mhilbrunner approved these changes

@skyace65 skyace65 skyace65 approved these changes

Assignees
No one assigned
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features enhancement topic:rendering
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Calinou @cybereality @skyace65 @mhilbrunner @clayjohn