Skip to content

Commit e6a08d3

Browse files
JordanL8Lewis Jordan
authored andcommitted
Added area light support disclaimer snippet to relevant shaders and light doc (#3015)
Co-authored-by: Lewis Jordan <[email protected]>
1 parent 9be572f commit e6a08d3

File tree

7 files changed

+35
-6
lines changed

7 files changed

+35
-6
lines changed

com.unity.render-pipelines.high-definition/Documentation~/Light-Component.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ HDRP includes multiple types of Light. Although HDRP Lights share many propertie
3131

3232
For more detailed information on how to configure realistic light fixtures, see the [Create High-Quality Light Fixtures in Unity](https://docs.unity3d.com/uploads/ExpertGuides/Create_High-Quality_Light_Fixtures_in_Unity.pdf) expert guide. For general guidance on light intensities, see [Physical light units](Physical-Light-Units.md#light-intensities).
3333

34-
### Properties
34+
## Properties
3535

3636
The properties available for Lights are in separate sections. Each section contains some properties that all Lights share, and also properties that customize the behavior of the specific type of Light. These sections also contain [more options](More-Options.md) that you can expose if you want to fine-tune your light's behavior. The sections are:
3737

@@ -65,7 +65,11 @@ To make the Light work with the **Animation window**, when you click on the **Ad
6565
| **Spot** | Emits light from a specified location and range over which the light diminishes. A Spot Light constrains the light it emits to an angle, which results in a cone-shaped region of illumination. The center of the cone points in the forward direction (z-axis) of the Light GameObject. Light also diminishes at the edges of the Spot Light’s cone. Increase the **Spot Angle** to increase the width of the cone. |
6666
| **Directional** | Creates effects that are similar to sunlight in your Scene. Like sunlight, Directional Lights are distant light sources that HDRP treats as though they are infinitely far away. A Directional Light does not have any identifiable source position, and you can place the Light GameObject anywhere in the Scene. A **Directional Light** illuminates all GameObjects in the Scene as if the Light rays are parallel and always from the same direction. The Light disregards the distance between the Light itself and the target GameObject, so the Light does not diminish with distance. |
6767
| **Point** | Projects light out equally in all directions from a point in space. The direction of light hitting a surface is the line from the point of contact back to the center of the Light GameObject. The light intensity diminishes with increased distance from the Light, and it reaches zero at the distance specified in the **Range** field. Light intensity is inversely proportional to the square of the distance from the source. This is known as the [Inverse-square law](https://en.wikipedia.org/wiki/Inverse-square_law), and is similar to how light behaves in the real world. |
68-
| **Area** | Projects light from a surface. Light shines in all directions uniformly from the surface of the rectangle. |
68+
| **Area** | Projects light from a surface. Light shines in all directions uniformly from the surface of the rectangle.|
69+
70+
##### Limitations
71+
72+
[!include[](snippets/area-light-material-support-disclaimer.md)]
6973

7074
<a name="ShapeProperties"></a>
7175

com.unity.render-pipelines.high-definition/Documentation~/Master-Node-Fabric.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,3 +98,7 @@ These properties are in the **Exposed Properties** section of the Inspector, alo
9898
| **Emission** | Toggles whether emission affects global illumination. |
9999
| **- Global Illumination** | The mode HDRP uses to determine how color emission interacts with global illumination.<br />&#8226; **Realtime**: Select this option to make emission affect the result of real-time global illumination.<br />&#8226; **Baked**: Select this option to make emission only affect global illumination during the baking process.<br />&#8226; **None**: Select this option to make emission not affect global illumination. |
100100
| **Motion Vector For Vertex Animation** | Enable the checkbox to make HDRP write motion vectors for GameObjects that use vertex animation. This removes the ghosting that vertex animation can cause. |
101+
102+
## Limitations
103+
104+
[!include[](snippets/area-light-material-support-disclaimer.md)]

com.unity.render-pipelines.high-definition/Documentation~/Master-Node-Hair.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,3 +93,7 @@ These properties are in the **Exposed Properties** section of the Inspector and
9393
| **Emission** | Toggles whether emission affects global illumination. |
9494
| **- Global Illumination** | Use the drop-down to choose how color emission interacts with global illumination.<br />&#8226; **Realtime**: Select this option to make emission affect the result of real-time global illumination.<br />&#8226; **Baked**: Select this option to make emission only affect global illumination during the baking process.<br />&#8226; **None**: Select this option to make emission not affect global illumination. |
9595
| **Motion Vector For Vertex Animation** | Enable the checkbox to make HDRP write motion vectors for GameObjects that use vertex animation. This removes the ghosting that vertex animation can cause. |
96+
97+
## Limitations
98+
99+
[!include[](snippets/area-light-material-support-disclaimer.md)]

com.unity.render-pipelines.high-definition/Documentation~/cotton-wool-shader.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ New Materials in HDRP use the [Lit shader](Lit-Shader.md) by default. To create
6565
| **Fuzz Map UV Scale** | Sets the scale of the Thread UV used to sample the Fuzz Map. |
6666
| **Fuzz Strength** | Sets the strength of the Fuzz Color added to the Base Color. |
6767

68-
###
68+
[!include[](snippets/shader-properties/advanced-options/lit-advanced-options.md)]
6969

70-
[!include[](snippets/shader-properties/advanced-options/lit-advanced-options.md)]
70+
## Limitations
71+
72+
[!include[](snippets/area-light-material-support-disclaimer.md)]

com.unity.render-pipelines.high-definition/Documentation~/hair-shader.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,8 @@ New Materials in HDRP use the [Lit shader](Lit-Shader.md) by default. To create
5757
| **Transmission Color** | Set the fraction of specular lighting that penetrates the hair from behind. This is on a per-color channel basis so you can use this property to set the color of penetrating light. Set this to (0, 0, 0) to stop any light from penetrating through the hair. Set this to (1, 1, 1) to have a strong effect with a lot of white light transmitting through the hair. |
5858
| **Transmission Rim** | Set the intensity of back lit hair around the edge of the hair. Set this to 0 to completely remove the transmission effect. |
5959

60-
[!include[](snippets/shader-properties/advanced-options/lit-advanced-options.md)]
60+
[!include[](snippets/shader-properties/advanced-options/lit-advanced-options.md)]
61+
62+
## Limitations
63+
64+
[!include[](snippets/area-light-material-support-disclaimer.md)]

com.unity.render-pipelines.high-definition/Documentation~/silk-shader.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,8 @@ New Materials in HDRP use the [Lit shader](Lit-Shader.md) by default. To create
6363
| **Fuzz Strength** | Sets the strength of the Fuzz Color added to the Base Color. |
6464
| **Diffusion Profile** | Sets the Diffusion Profile, controlling the Subsurface Scattering properties of your Material. |
6565

66-
[!include[](snippets/shader-properties/advanced-options/lit-advanced-options.md)]
66+
[!include[](snippets/shader-properties/advanced-options/lit-advanced-options.md)]
67+
68+
## Limitations
69+
70+
[!include[](snippets/area-light-material-support-disclaimer.md)]
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Area [Lights](../Light-Component.md) do not currently support Fabric or Hair Materials. This means they do not illuminate or cast shadows for Materials that use any of the following:
2+
3+
* [Cotton/Wool Shader](../cotton-wool-shader.md)
4+
* [Silk Shader](../silk-shader.md)
5+
* [Hair Shader](../hair-shader.md)
6+
* [Fabric Master Stack](../Master-Node-Fabric.md)
7+
* [Hair Master Stack](../Master-Node-Hair.md)

0 commit comments

Comments
 (0)