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

Documentation for the new renderer #2884

Conversation

kurtkuehnert
Copy link
Contributor

Objective

Solution

  • Provide documentation for the new renderer so (new) developers can get started faster with switching to and/or extending it.

Questions

  • How should the PRs be scoped? One giant one for the entire renderer, or one per module?

Any advice one adding code examples would be appreciated. :)

@inodentry inodentry added A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation labels Oct 1, 2021
@mockersf
Copy link
Member

could you try rebasing instead of doing a merge commit? it makes it very hard to review

@kurtkuehnert
Copy link
Contributor Author

sry, this went terribly wrong :(. I rebased onto the current pipelined rendering locally, but this resulted in this mess. How can I revert those changes? @mockersf

@kurtkuehnert
Copy link
Contributor Author

I think this it :).
I am probably done with this PR for now and it should be ready for review/merging.
I have not managed to document everything, most notably the module descriptions, buffers, shaders and views, pbr and the core pipeline.
University has started again so I won't have the time to finish those, but I can resolve merge conflicts if needed.

@alice-i-cecile alice-i-cecile added the S-Duplicate This issue or PR already exists label Nov 9, 2021
@alice-i-cecile
Copy link
Member

Closed in favor of the rebased #3094.

bors bot pushed a commit that referenced this pull request Nov 16, 2021
This is a squash-and-rebase of @Ku95's documentation of the new renderer onto the latest `pipelined-rendering` branch.

Original PR is #2884.

Co-authored-by: dataphract <[email protected]>
Co-authored-by: Carter Anderson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation S-Duplicate This issue or PR already exists
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants