Skip to content

Hair Documentation Pass #5868

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
Oct 2, 2021
Merged

Hair Documentation Pass #5868

merged 8 commits into from
Oct 2, 2021

Conversation

johnpars
Copy link
Contributor

@johnpars johnpars commented Oct 1, 2021 •
edited
Loading

Purpose of this PR

This PR adds updated documentation for the upcoming hair Physical model.

Section explaining the two models.
image
image
image

Section explaining geometry type.
image

Section explaining hair in path tracing.
image

One additional change was to the nomenclature of the Hair "material types". They are now:

  • Kajiya-Kay -> Approximate
  • Marschner -> Physical

Testing status

I built the docs with the DocTools and verified everything was formatted correctly.

@johnpars
Copy link
Contributor Author

johnpars commented Oct 1, 2021

Adding images shortly

@github-actions
Copy link

github-actions bot commented Oct 1, 2021

Hi! This comment will help you figure out which jobs to run before merging your PR. The suggestions are dynamic based on what files you have changed.
Link to Yamato: https://yamato.cds.internal.unity3d.com/jobs/902-Graphics
Search for your PR branch using the sidebar on the left, then add the following segment(s) to the end of the URL (you may need multiple tabs depending on how many packages you change)

HDRP
/.yamato%252Fall-hdrp.yml%2523PR_HDRP_trunk
With changes to HDRP packages, you should also run
/.yamato%252Fall-lightmapper.yml%2523PR_LightMapper_trunk

Depending on the scope of your PR, you may need to run more jobs than what has been suggested. Please speak to your lead or a Graphics SDET (#devs-graphics-automation) if you are unsure.

@github-actions github-actions bot added the HDRP label Oct 1, 2021
@mert-dev-acc
Copy link

mert-dev-acc commented Oct 1, 2021 •
edited
Loading

@johnpars It is a convenient simplification! Although, I would propose putting a side note somewhere to describe what Basic and Physical would refer to as their hair shading model.
Along with that, the term "Basic" might get a bit misleading for the general audience.
Plus the bottom note about the Physical model and strand representation requirement/suggestion can be mentioned at the very beginning to make sure people are not mixing things up.

@johnpars
Copy link
Contributor Author

johnpars commented Oct 1, 2021

Thanks @merpheus-dev, I will incorporate this feeback!

@johnpars
Copy link
Contributor Author

johnpars commented Oct 1, 2021

We decided to switch the nomenclature to Approximate / Physical for both the Material Type and the Scattering Mode for consistency.

@mert-dev-acc
Copy link

Awesome!

@sebastienlagarde sebastienlagarde marked this pull request as ready for review October 1, 2021 19:41
@johnpars
Copy link
Contributor Author

johnpars commented Oct 1, 2021

@sebastienlagarde yamato is now green - I forgot to update the reference image for OSX in the previous PR. It has been updated and the test re-ran.

@sebastienlagarde sebastienlagarde merged commit 840b26e into master Oct 2, 2021
@sebastienlagarde sebastienlagarde deleted the HDPR/hair-documentation branch October 2, 2021 08:20
@sebastienlagarde
Copy link
Contributor

@Vic-Cooper merging this PR as it include change in the feature that need to be in 21.2. Could you do a correction pass in a separate PR? thanks

sebastienlagarde pushed a commit that referenced this pull request Oct 3, 2021
@johnpars @sebastienlagarde
Hair Documentation Pass (#5868)
f033a48 
* Hair Documentation Pass

* Add the images

* Apply various feedback to the documentation

* Fix small typo

* Update the OSX reference image (forgot to add it previous PR, causing failure) and rerun Yamato

* Update the tooltips
@sebastienlagarde sebastienlagarde mentioned this pull request Oct 3, 2021
Merged
sebastienlagarde added a commit that referenced this pull request Oct 3, 2021
@sebastienlagarde @arttu-peltonen
@eturquin @pierre-unity @johnpars
[Backport 21.2][HDRP] Backport various PRs (#5875)
9e0ab52 
* Add missing DisallowMultipleComponent attribute in AdditionalData components #5859

* [HDRP][Path Tracing] Slight robustness improvement for sample rescaling #5800

* recaptured reflection probes, updated normals on 2nd room's floor (#5873)

* Hair Documentation Pass (#5868)

* Hair Documentation Pass

* Add the images

* Apply various feedback to the documentation

* Fix small typo

* Update the OSX reference image (forgot to add it previous PR, causing failure) and rerun Yamato

* Update the tooltips

* [HDRP] Remove Fake GTAO bounce on the occlusion when used for direct lighting #5836

* Update 5014_VolumetricCloudsBanding.png

* Update 2307_Shadow_VeryHigh.png

Co-authored-by: Arttu Peltonen <77337829+arttu-peltonen@users.noreply.github.com>
Co-authored-by: Emmanuel Turquin <emmanuel@turquin.org>
Co-authored-by: pierre-unity <39901544+pierre-unity@users.noreply.github.com>
Co-authored-by: John Parsaie <johnpa@unity3d.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sebastienlagarde sebastienlagarde Awaiting requested review from sebastienlagarde

@Vic-Cooper Vic-Cooper Awaiting requested review from Vic-Cooper

Assignees

No one assigned

Labels

backported-2021.2 HDRP

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@johnpars @mert-dev-acc @sebastienlagarde