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.

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

Add tutorial for reducing pipeline compilation stutters. #10007

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

DarioSamo
Copy link

Tutorial for the new functionality added by godotengine/godot#90400.

Doesn't need to be merged until the PR is merged.

The tutorial is aimed at users familiar with the engine but it should not require them to be rendering experts. Suggestions on what content to include and adjusting the grammar are welcome.

@DarioSamo DarioSamo force-pushed the pipelines branch 5 times, most recently from 851309d to 8326a85 Compare September 26, 2024 19:14
@skyace65 skyace65 added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation waiting on PR merge PR's that can't be merged until a engine PR is merged first topic:shaders labels Sep 27, 2024
@skyace65 skyace65 added this to the 4.4 milestone Sep 27, 2024
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 left a few suggestions to add more detail and improve grammar. This is going to be very helpful for users

tutorials/performance/pipeline_compilations.rst Outdated Show resolved Hide resolved
tutorials/performance/pipeline_compilations.rst Outdated Show resolved Hide resolved
tutorials/performance/pipeline_compilations.rst Outdated Show resolved Hide resolved
tutorials/performance/pipeline_compilations.rst Outdated Show resolved Hide resolved
tutorials/performance/pipeline_compilations.rst Outdated Show resolved Hide resolved
tutorials/performance/pipeline_compilations.rst Outdated Show resolved Hide resolved
tutorials/performance/pipeline_compilations.rst Outdated Show resolved Hide resolved
tutorials/performance/pipeline_compilations.rst Outdated Show resolved Hide resolved
tutorials/performance/pipeline_compilations.rst Outdated Show resolved Hide resolved
@tetrapod00
Copy link
Contributor

We might want to link to this page from https://docs.godotengine.org/en/stable/tutorials/rendering/jitter_stutter.html.

@DarioSamo
Copy link
Author

The PR has been merged, marking ready for review.

@KeyboardDanni
Copy link

It's nice to finally get some documentation on what can cause compilation stutters, but we'll also need to be sure to keep it up to date as the renderer changes. Is there some process we could come up with to make sure this happens?

@DarioSamo
Copy link
Author

It's nice to finally get some documentation on what can cause compilation stutters, but we'll also need to be sure to keep it up to date as the renderer changes. Is there some process we could come up with to make sure this happens?

Probably not worth it. My end goal in the long term would be for this article to not even need to exist in the first place.

It's just that to get there it'll require the generalization of a lot of systems to go through something that dictates the rendering at a higher level and allows the engine to know in advance everything that will be required.

I think manual updates will suffice for the time being.

@AThousandShips
Copy link
Member

Please convert the image to the .webp format.
you can read more about it in the Doc image guidelines.

@DarioSamo
Copy link
Author

Thanks, done!

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:shaders waiting on PR merge PR's that can't be merged until a engine PR is merged first
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants