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

Updated doc for the newly added debug mode for cluster display. #1519

Merged
merged 3 commits into from
Aug 25, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,8 @@ The **Lighting** panel has tools that you can use to visualize various component
| **Fullscreen Debug Mode** | Use the drop-down to select a fullscreen lighting effect to debug. For example, you can visualize [Contact Shadows](Override-Contact-Shadows.md), the depth pyramid, and indirect diffuse lighting. |
| **Tile/Cluster Debug** | Use the drop-down to select an internal HDRP lighting structure to visualize on screen.<br/>&#8226; **None**: Select this option to turn off this debug feature.<br/>&#8226; **Tile**: Select this option to show an overlay of each lighting tile, and the number of lights in them.<br/>&#8226; **Cluster**: Select this option to show an overlay of each lighting cluster that intersects opaque geometry, and the number of lights in them.<br/>&#8226; **Material Feature Variants**: Select this option to show the index of the lighting Shader variant that HDRP uses for a tile. You can find variant descriptions in the *lit.hlsl* file. |
| **- Tile/Cluster Debug By Category** | Use the drop-down to select the Light type that you want to show the Tile/Cluster debug information for. The options include [Light Types](Light-Component.md), [Decals](Decal-Projector.md), and [Density Volumes](Density-Volume.md).<br/>This property only appears when you select **Tile** or **Cluster** from the **Tile/Cluster Debug** drop-down. |
| **- Cluster Debug Mode** | Use the drop-down to select the visualization mode for the cluster. The options are:<br/> **VisualizeOpaque**: Shows cluster information on opaque geometry.<br/> **VisualizeSlice**: Shows cluster information at a set distance from the camera.<br/>This property only appears when you select **Cluster** from the **Tile/Cluster Debug** drop-down.. |
| **- Cluster Distance** | Use this slider to set the distance from the camera at which to display the cluster slice. This property only appears when you select **VisualizeSlice** from the **Cluster Debug Mode** drop-down. |
| **Display Sky Reflection** | Enable the checkbox to display an overlay of the cube map that the current sky generates and HDRP uses for lighting. |
| **- Sky Reflection Mipmap** | Use the slider to set the mipmap level of the sky reflection cubemap. Use this to view the sky reflection cubemap's different mipmap levels.<br/>This property only appears when you enable the **Display Sky Reflection** checkbox. |
| **Display Light Volumes** | Enable the checkbox to show an overlay of all light bounding volumes. |
Expand Down