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

Explain where rendering is #11018

Merged
merged 1 commit into from
Jan 8, 2024
Merged

Conversation

stepancheg
Copy link
Contributor

It was not easy to find. Add some pointers to the comment.

Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

Helpful! It's still a bit weird to me that we're using this struct like a module-level doc comment, but this is a good addition.

@stepancheg
Copy link
Contributor Author

stepancheg commented Dec 18, 2023

My reasoning is this. I'm looking at various schedule labels like PostUpdate and Last. Do they perform rendering? Not clear, but they link to the Main schedule. So I go to Main, and this is the end, no more outgoing links.

Perhaps we can only add links to plugins, and move the wall of text to PipelinedRenderingPlugin, before this:

/// The [`PipelinedRenderingPlugin`] can be added to your application to enable pipelined rendering.
/// This moves rendering into a different thread, so that the Nth frame's rendering can
/// be run at the same time as the N + 1 frame's simulation.
///
/// ```text
/// |--------------------|--------------------|--------------------|--------------------|
/// | simulation thread | frame 1 simulation | frame 2 simulation | frame 3 simulation |
/// |--------------------|--------------------|--------------------|--------------------|
/// | rendering thread | | frame 1 rendering | frame 2 rendering |
/// |--------------------|--------------------|--------------------|--------------------|
/// ```

@ItsDoot ItsDoot added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen A-ECS Entities, components, systems, and events labels Dec 18, 2023
@stepancheg
Copy link
Contributor Author

Added links to docs.rs, made test in Main shorter, added text to RenderPlugin.

@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jan 7, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 8, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 8, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 8, 2024
Merged via the queue into bevyengine:main with commit dfa1a5e Jan 8, 2024
23 checks passed
@stepancheg stepancheg deleted the main-rendering branch January 8, 2024 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants