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

Rework Reference - Introduction #55

Closed
5 of 6 tasks
jackjt8 opened this issue Mar 16, 2022 · 8 comments · Fixed by #67
Closed
5 of 6 tasks

Rework Reference - Introduction #55

jackjt8 opened this issue Mar 16, 2022 · 8 comments · Fixed by #67
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@jackjt8
Copy link
Member

jackjt8 commented Mar 16, 2022

The Introduction article requires further refinement.

  • Improve Path Tracing and Samples and Noise articles #68
  • Samples Per Pixel (SPP) - Update gif with a smoother animation with more frames
  • Merge NEE/ESS stuff together
  • Emitter Sampling Strategy (ESS) - Section is confusing. Probably needs diagrams to explain the complex nature of ESS.
  • Materials - Need to add a section on various material properties and how they function (in context). This is intended to replace some of the content within Reference - Render Controls - Materials as that article should just be for the UI and short descriptions.
  • Image formats and color - This section does not really fit here. Maybe we should move some of the content to Reference - Scene Format and other parts to Reference - Render Controls - Advanced.

Given the scope of the article, and the changes that may be required, I would not be against the sub-division of the article. Please use this issue to further expand on any issues with the article and your suggestions.

@jackjt8 jackjt8 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Mar 16, 2022
@Peregrine05
Copy link
Member

As to the subdivision of the article: What about placing "Path Tracing", "Random Sampling", and "Renderers" together into one article; "Samples Per Pixel (SPP)", "Render Time", "More about Noise", and "SPP Comparisons together into one article; "Emitter Sampling Strategy (ESS) gets its own article; "Data Structures" gets its own article; and "Image formats and color" gets moved elsewhere?

@jackjt8
Copy link
Member Author

jackjt8 commented Apr 21, 2022

So effectively we would have; and this list of headings is subject to change/expansion:

Introduction:

  • Path Tracing
  • Random Sampling
  • Renderers

"More on Noise":

  • Samples Per Pixel (SPP)
  • Render Time
  • More about Noise
  • SPP Comparisons

Next Event Estimation:

  • "Small intro and bit on sun sampling"
  • Emitter Sampling Strategy (ESS)

Image formats and color move is already noted in final bullet point at the time of writing.

  • Image formats and color - This section does not really fit here. Maybe we should move some of the content to Reference - Scene Format and other parts to Reference - Render Controls - Advanced.

Data Structures is a bit tricky. So yes, we do actually have some information within Reference > Scene Format and we could certainly expand it a bit more however, that is a technical document. Given the importance of BVHs and Octrees both within Chunky and with other applications at the very least we would need to slot an article in between Introduction and "More on Noise". Though I would argue that it's probably more important to keep it together with our Introduction.

@Peregrine05
Copy link
Member

Peregrine05 commented Apr 21, 2022

This is what I have so far:

Introduction

  • "Path Tracing"
  • "Random Sampling"
  • "Renderers"

Samples Per Pixel (SPP) and Noise

  • "Samples Per Pixel (SPP)" (Expand this section and move the part about Sun NEE into Emitter Sampling Strategy (ESS))
  • "More About Noise"
  • "SPP Comparisons"
  • "Render Time"

Emitter Sampling Strategy (ESS) (Maybe rename this to "Next Event Estimation (NEE)")

Data Structures

Maybe move Denoising down with Headless, Scene Format, Skymaps, etc.

User Interface

The first paragraph in Image Formats and Color can be moved to the Scene Format article, and the details about the file formats could be moved to the Advanced tab article.

@jackjt8
Copy link
Member Author

jackjt8 commented Apr 21, 2022

I am mostly happy with the proposed changes. Moving Denoising down with Headless, etc. is a good idea.

I am still not certain on having Data Structures as a standalone article given the overlap with Scene Format. I would still prefer if it would be contained within either Introduction or Samples Per Pixel (SPP) and Noise given it's close relation to both of these topics.

@Peregrine05
Copy link
Member

I was thinking of the logical progression of the topics. First is the Chunky renderer and path tracing. That leads into SPP and noise. And then it goes into other rendering strategies, such as NEE. I agree with keeping how Chunky stores world data with the rest of how Chunky works, but merging that section into the previous sections somewhat breaks the order of topics. That's why, for now, I have it after the ESS page. But it would probably fit best in the Path Tracing article if it is to be merged.

@jackjt8
Copy link
Member Author

jackjt8 commented Apr 21, 2022

I'll try and figure out how to rework the article at a later date for it's remerge among some of the other improvements.

@jackjt8
Copy link
Member Author

jackjt8 commented Apr 21, 2022

Introduction
	Path Tracing - Shorten Data Structures link to `Scene Format` for in depth
	Samples and Noise
	Next Event Estimation - Sun NEE + (Improved) ESS
	Materials?
User Interface
Render Controls
	... - Expand image formats
Denoising - Moved here
Headless
Scene Format - Expand Octree, BVH, and image format/internal stuff
Skymaps
Theming

Updated*

@Peregrine05
Copy link
Member

Peregrine05 commented Apr 21, 2022

Task 2 of 6 complete:
The main SPP comparison animation.
x2_2-sec_loop
Compare 1k and 2k SPP
1ki-2ki_2-sec_loop
Compare 20k and 21k SPP
20k-21k_2-sec_loop
They are GIFs here, but they will be WEBP files on the docs. All major current web browsers suppor animated WEBP files.

@Peregrine05 Peregrine05 linked a pull request Aug 11, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants