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

reformatted list #6963

Merged
merged 4 commits into from
Feb 4, 2022
Merged

Conversation

emilybrown1
Copy link
Contributor

Part of a quality review of HDRP docs.

Reformatted the first paragraph into a list

@github-actions
Copy link

github-actions bot commented Feb 2, 2022

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://unity-ci.cds.internal.unity3d.com/project/902/
Search for your PR branch using the search bar at the top, 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
/jobDefinition/.yamato%2Fall-hdrp.yml%23PR_HDRP_trunk
With changes to HDRP packages, you should also run
/jobDefinition/.yamato%2Fall-lightmapping.yml%23PR_Lightmapping_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 Feb 2, 2022
@github-actions
Copy link

github-actions bot commented Feb 2, 2022

It appears that you made a non-draft PR!
Please convert your PR to draft (button on the right side of the page).
See the PR template for more information.
Thank you!

Copy link
Contributor

@Vic-Cooper Vic-Cooper left a comment

Choose a reason for hiding this comment

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

Added a couple of comments.


HDRP supports all the Canvas **Render Modes**, however, it only supports Unlit UI shaders for Canvas UI.

## Working in a linear color space
HDRP Projects require you to work in linear [color space](https://docs.unity3d.com/Manual/LinearLighting.html). When you create UI in the Editor, ensure the sprite textures are in linear color space to make sure the UI renders correctly. This is especially important for transparent sprites. For more information, see [Linear or gamma workflow](https://docs.unity3d.com/Manual/LinearRendering-LinearOrGammaWorkflow.html) and [Working with linear Textures](https://docs.unity3d.com/Manual/LinearRendering-LinearTextures.html).

## Multiple camera setup
HDRP only supports a single camera setup by default. If you need to use more than one camera at the same time, it is best practice to use one the following alternatives:
HDRP only supports a single camera setup by default. If you need to use more than one camera at the same time, you should use one the following alternatives:
Copy link
Contributor

Choose a reason for hiding this comment

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

Should Camera be capitalised here? Also remove "you should" entirely.

Copy link
Contributor

Choose a reason for hiding this comment

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

In the style guide: "Do not use the word should because it is ambiguous. Be explicit. "

@sebastienlagarde sebastienlagarde merged commit f69e584 into master Feb 4, 2022
@sebastienlagarde sebastienlagarde deleted the HDRP/docs/quality-UI-Best-Practices branch February 4, 2022 16:50
sebastienlagarde pushed a commit that referenced this pull request Feb 7, 2022
* reformatted list

* Update UI-Best-Practices.md

* Update UI-Best-Practices.md

* Update UI-Best-Practices.md
sebastienlagarde added a commit that referenced this pull request Feb 7, 2022
* [Fogbugz # 1398085] Fixing flicker when toggling hardware DRS #6868

* [Fogbugz # 1381103] Fixing hardware DRS performance when active with multiple views #6862

* [Fogbugz#1388961] Fixing PBR Dof for DLSS #6651

* Do not use the dynResHandler while initializing the state. Ensuring we use the asset directly until we build up the drs state (#6966)

* [Docs] [HDRP] Update scripts in the accumulation API documentation (#6951)

* Update scripts in the accumulation API documentation

* Min frame rate should not be zero

* Update Ray-Tracing-Path-Tracing.md

* reformatted list (#6963)

* reformatted list

* Update UI-Best-Practices.md

* Update UI-Best-Practices.md

* Update UI-Best-Practices.md

* Fixing formatting #6967

* Fixed RTGI potentially reading from outside the half res pixels due to missing last pixel during the upscale pass (case 1400310). #6985

* add visual scripting to package list (#7018)

* Apply formatting changes

Co-authored-by: Kleber Garcia <kleber.garcia@unity3d.com>
Co-authored-by: Pavlos Mavridis <pavlos.mavridis@unity3d.com>
Co-authored-by: emilybrown1 <88374601+emilybrown1@users.noreply.github.com>
Co-authored-by: anisunity <42026998+anisunity@users.noreply.github.com>
Co-authored-by: noreply@unity3d.com <noreply@unity3d.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants