Skip to content

Create xr full screen effects doc page #10727

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.

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

Merged
merged 1 commit into from
Mar 18, 2025

Conversation

devloglogan
Copy link
Contributor

@devloglogan devloglogan commented Feb 28, 2025

Adds a doc page informing on how users can take asymmetric FOV into account in full screen quad post-processing shaders.

@BastiaanOlij mentioned that attempting to do this while reading from the screen texture is a big no-no so I also included a section at the bottom attempting to warn users about that.

@devloglogan devloglogan added enhancement topic:xr Related to XR documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Feb 28, 2025
@devloglogan devloglogan added this to the 4.x milestone Feb 28, 2025
@BastiaanOlij
Copy link
Contributor

Personally i feel we shouldn't be talking about post processing here. Post processing effects suggest that you modify the rendered output and that is where the big no-no's come in.

Vignettes' etc are not post processes. They are screen space effects that use a quad to render their output (actually a single triangle would be better but we don't have an easy primitive for that). So I think we need to come up with better naming.

In the same line, I don't think that referencing the original post processing document is a good idea. Again, we just set people on the wrong footing, they will read that, figure out they can do that in XR as well, and then when they are too far along find out that doing so is what is causing their performance to never get up to spec. By then it's too late.

@devloglogan
Copy link
Contributor Author

@BastiaanOlij understood, and now that I understand the term a bit better I fully agree! @dsnopek had mentioned something similar to me elsewhere. I'll rework this soon to swap that term out for something like "full screen effects" and also remove the reference to the other doc.

@BastiaanOlij
Copy link
Contributor

@devloglogan it does feel like nitpicking but I feel we can prevent ourselves a bit of hardship if we get that bit right :)

@devloglogan devloglogan force-pushed the asymmetrical-fov-doc branch from 5eacb0c to 8847300 Compare March 3, 2025 21:54
@devloglogan devloglogan changed the title Create xr post-processing doc page Create xr full screen effects doc page Mar 3, 2025
@devloglogan
Copy link
Contributor Author

Alright, I've opted for "full screen effects" as the term instead and removed the reference to the other doc entirely (which adds a touch more on the basic full screen quad setup).

@devloglogan devloglogan force-pushed the asymmetrical-fov-doc branch from 8847300 to 68e234e Compare March 7, 2025 16:41
@devloglogan
Copy link
Contributor Author

@dsnopek Thanks for the review! I believe I've addressed all of your suggestions, please take another look at the doc when you get a chance. :)

Copy link
Contributor

@dsnopek dsnopek left a comment

Choose a reason for hiding this comment

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

Thanks! This is looking good to me now :-)

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.

Grammer and spelling should be good after these two changes. @BastiaanOlij did you want to look this over again?

Copy link
Contributor

@BastiaanOlij BastiaanOlij left a comment

Choose a reason for hiding this comment

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

LGTM, nice writeup Logan! Indeed just need the small grammar fixes and its ready to merge IMHO.

@devloglogan devloglogan force-pushed the asymmetrical-fov-doc branch from 68e234e to 58a5b50 Compare March 17, 2025 11:50
@skyace65 skyace65 merged commit cce8630 into godotengine:master Mar 18, 2025
1 of 2 checks passed
@skyace65
Copy link
Contributor

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:xr Related to XR documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants