+ /// static float GetLensFlareLightAttenuation(Light light, Camera cam, Vector3 wo)
+ /// {
+ /// switch (light.type)
+ /// {
+ /// case LightType.Directional:
+ /// return LensFlareCommonSRP.ShapeAttenuationDirLight(light.transform.forward, cam.transform.forward);
+ /// case LightType.Point:
+ /// // Do nothing point are omnidirectional for the lens flare
+ /// return LensFlareCommonSRP.ShapeAttenuationPointLight();
+ /// case LightType.Spot:
+ /// float innerSpotPercent01 = 1;
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotConeLight(light.transform.forward, wo, light.spotAngle, light.innerSpotAngle / 180.0f);
+ /// case LightType.Pyramid:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotPyramidLight(light.transform.forward, wo);
+ /// case LightType.Box:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotBoxLight(light.transform.forward, wo);
+ /// case LightType.Rectangle:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaRectangleLight(light.transform.forward, wo);
+ /// case LightType.Tube:
+ /// float shapeWidth = 1; // Get this data from an external source if our render pipeline supports tube lights.
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaTubeLight(light.transform.position, light.transform.right, shapeWidth, cam);
+ /// case LightType.Disc:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaDiscLight(light.transform.forward, wo);
+ /// default: throw new Exception($"GetLensFlareLightAttenuation HDLightType Unknown {typeof(LightType)}: {light.type}");
+ /// }
+ /// }
+ ///
+ ///
+ /// static float GetLensFlareLightAttenuation(Light light, Camera cam, Vector3 wo)
+ /// {
+ /// switch (light.type)
+ /// {
+ /// case LightType.Directional:
+ /// return LensFlareCommonSRP.ShapeAttenuationDirLight(light.transform.forward, cam.transform.forward);
+ /// case LightType.Point:
+ /// // Do nothing point are omnidirectional for the lens flare
+ /// return LensFlareCommonSRP.ShapeAttenuationPointLight();
+ /// case LightType.Spot:
+ /// float innerSpotPercent01 = 1;
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotConeLight(light.transform.forward, wo, light.spotAngle, light.innerSpotAngle / 180.0f);
+ /// case LightType.Pyramid:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotPyramidLight(light.transform.forward, wo);
+ /// case LightType.Box:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotBoxLight(light.transform.forward, wo);
+ /// case LightType.Rectangle:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaRectangleLight(light.transform.forward, wo);
+ /// case LightType.Tube:
+ /// float shapeWidth = 1; // Get this data from an external source if our render pipeline supports tube lights.
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaTubeLight(light.transform.position, light.transform.right, shapeWidth, cam);
+ /// case LightType.Disc:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaDiscLight(light.transform.forward, wo);
+ /// default: throw new Exception($"GetLensFlareLightAttenuation HDLightType Unknown {typeof(LightType)}: {light.type}");
+ /// }
+ /// }
+ ///
+ ///
+ /// static float GetLensFlareLightAttenuation(Light light, Camera cam, Vector3 wo)
+ /// {
+ /// switch (light.type)
+ /// {
+ /// case LightType.Directional:
+ /// return LensFlareCommonSRP.ShapeAttenuationDirLight(light.transform.forward, cam.transform.forward);
+ /// case LightType.Point:
+ /// // Do nothing point are omnidirectional for the lens flare
+ /// return LensFlareCommonSRP.ShapeAttenuationPointLight();
+ /// case LightType.Spot:
+ /// float innerSpotPercent01 = 1;
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotConeLight(light.transform.forward, wo, light.spotAngle, light.innerSpotAngle / 180.0f);
+ /// case LightType.Pyramid:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotPyramidLight(light.transform.forward, wo);
+ /// case LightType.Box:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotBoxLight(light.transform.forward, wo);
+ /// case LightType.Rectangle:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaRectangleLight(light.transform.forward, wo);
+ /// case LightType.Tube:
+ /// float shapeWidth = 1; // Get this data from an external source if our render pipeline supports tube lights.
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaTubeLight(light.transform.position, light.transform.right, shapeWidth, cam);
+ /// case LightType.Disc:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaDiscLight(light.transform.forward, wo);
+ /// default: throw new Exception($"GetLensFlareLightAttenuation HDLightType Unknown {typeof(LightType)}: {light.type}");
+ /// }
+ /// }
+ ///
+ ///
+ /// static float GetLensFlareLightAttenuation(Light light, Camera cam, Vector3 wo)
+ /// {
+ /// switch (light.type)
+ /// {
+ /// case LightType.Directional:
+ /// return LensFlareCommonSRP.ShapeAttenuationDirLight(light.transform.forward, cam.transform.forward);
+ /// case LightType.Point:
+ /// // Do nothing point are omnidirectional for the lens flare
+ /// return LensFlareCommonSRP.ShapeAttenuationPointLight();
+ /// case LightType.Spot:
+ /// float innerSpotPercent01 = 1;
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotConeLight(light.transform.forward, wo, light.spotAngle, light.innerSpotAngle / 180.0f);
+ /// case LightType.Pyramid:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotPyramidLight(light.transform.forward, wo);
+ /// case LightType.Box:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotBoxLight(light.transform.forward, wo);
+ /// case LightType.Rectangle:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaRectangleLight(light.transform.forward, wo);
+ /// case LightType.Tube:
+ /// float shapeWidth = 1; // Get this data from an external source if our render pipeline supports tube lights.
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaTubeLight(light.transform.position, light.transform.right, shapeWidth, cam);
+ /// case LightType.Disc:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaDiscLight(light.transform.forward, wo);
+ /// default: throw new Exception($"GetLensFlareLightAttenuation HDLightType Unknown {typeof(LightType)}: {light.type}");
+ /// }
+ /// }
+ ///
+ ///
+ /// static float GetLensFlareLightAttenuation(Light light, Camera cam, Vector3 wo)
+ /// {
+ /// switch (light.type)
+ /// {
+ /// case LightType.Directional:
+ /// return LensFlareCommonSRP.ShapeAttenuationDirLight(light.transform.forward, cam.transform.forward);
+ /// case LightType.Point:
+ /// // Do nothing point are omnidirectional for the lens flare
+ /// return LensFlareCommonSRP.ShapeAttenuationPointLight();
+ /// case LightType.Spot:
+ /// float innerSpotPercent01 = 1;
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotConeLight(light.transform.forward, wo, light.spotAngle, light.innerSpotAngle / 180.0f);
+ /// case LightType.Pyramid:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotPyramidLight(light.transform.forward, wo);
+ /// case LightType.Box:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotBoxLight(light.transform.forward, wo);
+ /// case LightType.Rectangle:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaRectangleLight(light.transform.forward, wo);
+ /// case LightType.Tube:
+ /// float shapeWidth = 1; // Get this data from an external source if our render pipeline supports tube lights.
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaTubeLight(light.transform.position, light.transform.right, shapeWidth, cam);
+ /// case LightType.Disc:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaDiscLight(light.transform.forward, wo);
+ /// default: throw new Exception($"GetLensFlareLightAttenuation HDLightType Unknown {typeof(LightType)}: {light.type}");
+ /// }
+ /// }
+ ///
+ ///
+ /// static float GetLensFlareLightAttenuation(Light light, Camera cam, Vector3 wo)
+ /// {
+ /// switch (light.type)
+ /// {
+ /// case LightType.Directional:
+ /// return LensFlareCommonSRP.ShapeAttenuationDirLight(light.transform.forward, cam.transform.forward);
+ /// case LightType.Point:
+ /// // Do nothing point are omnidirectional for the lens flare
+ /// return LensFlareCommonSRP.ShapeAttenuationPointLight();
+ /// case LightType.Spot:
+ /// float innerSpotPercent01 = 1;
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotConeLight(light.transform.forward, wo, light.spotAngle, light.innerSpotAngle / 180.0f);
+ /// case LightType.Pyramid:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotPyramidLight(light.transform.forward, wo);
+ /// case LightType.Box:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotBoxLight(light.transform.forward, wo);
+ /// case LightType.Rectangle:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaRectangleLight(light.transform.forward, wo);
+ /// case LightType.Tube:
+ /// float shapeWidth = 1; // Get this data from an external source if our render pipeline supports tube lights.
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaTubeLight(light.transform.position, light.transform.right, shapeWidth, cam);
+ /// case LightType.Disc:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaDiscLight(light.transform.forward, wo);
+ /// default: throw new Exception($"GetLensFlareLightAttenuation HDLightType Unknown {typeof(LightType)}: {light.type}");
+ /// }
+ /// }
+ ///
+ ///
+ /// static float GetLensFlareLightAttenuation(Light light, Camera cam, Vector3 wo)
+ /// {
+ /// switch (light.type)
+ /// {
+ /// case LightType.Directional:
+ /// return LensFlareCommonSRP.ShapeAttenuationDirLight(light.transform.forward, cam.transform.forward);
+ /// case LightType.Point:
+ /// // Do nothing point are omnidirectional for the lens flare
+ /// return LensFlareCommonSRP.ShapeAttenuationPointLight();
+ /// case LightType.Spot:
+ /// float innerSpotPercent01 = 1;
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotConeLight(light.transform.forward, wo, light.spotAngle, light.innerSpotAngle / 180.0f);
+ /// case LightType.Pyramid:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotPyramidLight(light.transform.forward, wo);
+ /// case LightType.Box:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotBoxLight(light.transform.forward, wo);
+ /// case LightType.Rectangle:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaRectangleLight(light.transform.forward, wo);
+ /// case LightType.Tube:
+ /// float shapeWidth = 1; // Get this data from an external source if our render pipeline supports tube lights.
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaTubeLight(light.transform.position, light.transform.right, shapeWidth, cam);
+ /// case LightType.Disc:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaDiscLight(light.transform.forward, wo);
+ /// default: throw new Exception($"GetLensFlareLightAttenuation HDLightType Unknown {typeof(LightType)}: {light.type}");
+ /// }
+ /// }
+ ///
+ ///
+ /// static float GetLensFlareLightAttenuation(Light light, Camera cam, Vector3 wo)
+ /// {
+ /// switch (light.type)
+ /// {
+ /// case LightType.Directional:
+ /// return LensFlareCommonSRP.ShapeAttenuationDirLight(light.transform.forward, cam.transform.forward);
+ /// case LightType.Point:
+ /// // Do nothing point are omnidirectional for the lens flare
+ /// return LensFlareCommonSRP.ShapeAttenuationPointLight();
+ /// case LightType.Spot:
+ /// float innerSpotPercent01 = 1;
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotConeLight(light.transform.forward, wo, light.spotAngle, light.innerSpotAngle / 180.0f);
+ /// case LightType.Pyramid:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotPyramidLight(light.transform.forward, wo);
+ /// case LightType.Box:
+ /// return LensFlareCommonSRP.ShapeAttenuationSpotBoxLight(light.transform.forward, wo);
+ /// case LightType.Rectangle:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaRectangleLight(light.transform.forward, wo);
+ /// case LightType.Tube:
+ /// float shapeWidth = 1; // Get this data from an external source if our render pipeline supports tube lights.
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaTubeLight(light.transform.position, light.transform.right, shapeWidth, cam);
+ /// case LightType.Disc:
+ /// return LensFlareCommonSRP.ShapeAttenuationAreaDiscLight(light.transform.forward, wo);
+ /// default: throw new Exception($"GetLensFlareLightAttenuation HDLightType Unknown {typeof(LightType)}: {light.type}");
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ ///
+ /// public static class RenderGraphHelper
+ /// {
+ /// public static bool enableCompilationCaching
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<RenderGraphGlobalSettings>();
+ /// if (gs == null) //not in SRP
+ /// return false;
+ /// return gs.enableCompilationCaching;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ ///
+ /// public static class RPAssetIncludedHelper
+ /// {
+ /// public static string label
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<IncludeAdditionalRPAssets>();
+ /// if (gs == null) //not in SRP
+ /// return null;
+ /// if (!gs.includeAssetsByLabel)
+ /// return null;
+ /// return gs.labelToInclude;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ ///
+ /// public static class ShaderStrippingHelper
+ /// {
+ /// public static bool exportLog
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<ShaderStrippingSetting>();
+ /// if (gs == null) //not in any SRP
+ /// return false;
+ /// return gs.exportShaderVariants;
+ /// }
+ /// }
+ /// }
+ ///
+ /// -
+ ///
Nearest
+ /// Bilinear
+ /// NearestQuad
+ /// BilinearQuad
+ /// NearestQuadPadding
+ /// BilinearQuadPadding
+ /// NearestQuadPaddingRepeat
+ /// BilinearQuadPaddingRepeat
+ /// BilinearQuadPaddingOctahedral
+ /// NearestQuadPaddingAlphaBlend
+ /// BilinearQuadPaddingAlphaBlend
+ /// NearestQuadPaddingAlphaBlendRepeat
+ /// BilinearQuadPaddingAlphaBlendRepeat
+ /// BilinearQuadPaddingAlphaBlendOctahedral
+ /// CubeToOctahedral
+ /// CubeToOctahedralLuminance
+ /// CubeToOctahedralAlpha
+ /// CubeToOctahedralRed
+ /// BilinearQuadLuminance
+ /// BilinearQuadAlpha
+ /// BilinearQuadRed
+ /// NearestCubeToOctahedralPadding
+ /// BilinearCubeToOctahedralPadding
+ ///
-
+ ///
ColorOnly
+ /// ColorAndDepth
+ ///
Diagram detailing the use of the padding, textureSize, scaleBiasTex and scaleBiasRT. + /// + /// The source rect is copied to the destination rect along with extra padding pixels taken from the source texture + /// using the texture's
Diagram detailing the use of the padding, textureSize, scaleBiasTex and scaleBiasRT. + /// + /// The source rect is copied to the destination rect along with extra padding pixels taken from the source texture + /// but, compared to
| | X | |
+ /// // | | + + - +---+ - +
+ /// // | | / | | | |
+ /// // +-------+ + - + - + - +
+ /// Vector4 center3by3 = new Vector4(1.0f/3.0f, 1.0f/3.0f, 1.0f/3.0f, 1.0f/3.0f);
+ /// Blitter.BlitCubeToOctahedral2DQuad(cmd, source, center3by3, 2);
+ /// ]]>
+ /// | | X | |
+ /// // | | + + - +---+ - +
+ /// // | | / | | | |
+ /// // +-------+ + - + - + - +
+ /// // Desired padding on the destination rect
+ /// int paddingInPixelsOneDirection = 16;
+ /// // Multiply by two for the total padding along an axis.
+ /// int paddingInPixels = 2 * paddingInPixelsOneDirection;
+ /// Vector4 center3by3 = new Vector4(1.0f/3.0f, 1.0f/3.0f, 1.0f/3.0f, 1.0f/3.0f);
+ /// Vector2 subTextureSize = new Vector2(sourceWidth, sourceHeight);
+ /// // HDR to non-HDR decoding is not necessary here so drop the
+ /// // last parameter.
+ /// Blitter.BlitCubeToOctahedral2DQuadWithPadding(cmd, source, subTextureSize, center3by3, 2, paddingInPixels);
+ /// ]]>
+ /// -
+ ///
RGB(A) the RGB luminance is written to the destination in all channels.
+ /// Red the red value is written to the destination in all channels.
+ /// Alpha the alpha value is written to the destination in all channels.
+ ///
| | X | |
+ /// // | | + + - +---+ - +
+ /// // | | / | | | |
+ /// // +-------+ + - + - + - +
+ /// Vector4 center3by3 = new Vector4(1.0f/3.0f, 1.0f/3.0f, 1.0f/3.0f, 1.0f/3.0f);
+ /// Blitter.BlitCubeToOctahedral2DQuadSingleChannel(cmd, source, center3by3, 2);
+ /// ]]>
+ /// -
+ ///
RGB(A) the RGB luminance is written to the destination in all channels.
+ /// Red the red value is written to the destination in all channels.
+ /// Alpha the alpha value is written to the destination in all channels.
+ ///
+ /// [VolumeComponentMenu("MyVolumeCategory/LightingEffects")]
+ /// public class CustomLightingVolume : VolumeComponent { ... }
+ ///
+ ///
/// using UnityEngine.Rendering;
///
@@ -92,6 +122,12 @@ public sealed class VolumeComponentDeprecated : Attribute
/// public ClampedFloatParameter intensity = new ClampedFloatParameter(0f, 0f, 1f);
/// }
///
+ ///
+ /// On
Three Lines", "On", "Text
[On]
Three Lines", true); + + } + + [Test, TestCaseSource(nameof(SearchFilterTestCases))] + public void SearchFiltering(Dictionary
A: A sphere with a transparent compute thickness material intersecting an opaque plane. B: A sphere with an opaque compute thickness material intersecting an opaque plane. @@ -140,17 +138,17 @@ To visualize the compute thickness debug mode, perform the following actions: This view displays the thickness or overlap count of the objects in the layer you select in the **Layer Mask** property. - + A: The default appearance of the compute thickness debug view. -B: The compute thickness debug view when you enable **Show Overlap Count** . +B: The compute thickness debug view when you enable **Show Overlap Count**. | **Debug view color** | **Description** | | ------------------------------------------------------------ | ------------------------------------------------------------ | -| Vidris color scale | A gradient scale that represents thickness. Purple represents the minimum thickness and yellow represents the maximum thickness.
When you enable **Show Overlap Count,** yellow areas indicate a high number of overlapping triangles. | -| Red | Negative thickness caused by an open mesh, flipped triangles, or an odd number of triangles in the optical path. | -| Gray | The default background color.
Gray areas inside a mesh indicate pixels that are in a similar position (z-fight) or have no thickness. | -| Orange | Compute Thickness is not active in HDRP graphics settings. To fix this, [enable compute thickness](#computethickness-enable). | -| Pink | This layer is not assigned to the HDRP Asset’s Layer Mask property. To fix this, [enable compute thickness](#computethickness-enable). | +| Vidris color scale | A gradient scale that represents thickness. Purple represents the minimum thickness and yellow represents the maximum thickness.
When you enable **Show Overlap Count,** yellow areas indicate a high number of overlapping triangles. | +| Red | Negative thickness caused by an open mesh, flipped triangles, or an odd number of triangles in the optical path. | +| Gray | The default background color.
Gray areas inside a mesh indicate pixels that are in a similar position (z-fight) or have no thickness. | +| Orange | Compute Thickness is not active in HDRP graphics settings. To fix this, [enable compute thickness](#computethickness-enable). | +| Pink | This layer is not assigned to the HDRP Asset’s Layer Mask property. To fix this, [enable compute thickness](#computethickness-enable). | ## Limitations diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Frame-Debugger.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Frame-Debugger.md deleted file mode 100644 index 1ee40904548..00000000000 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Frame-Debugger.md +++ /dev/null @@ -1,11 +0,0 @@ -# Viewing a Custom Pass in the Frame Debugger - -You can use the [Frame Debugger](https://docs.unity3d.com/Manual/FrameDebugger.html) to examine every draw call you issued in the Custom Pass. To find your pass, look for the name you gave your Custom Pass in the Custom Pass Volume component. - -In this example, the Custom Pass is called **My Outline Pass**. The **Frame Debug** window (menu: - -**Window > Analysis > Frame Debugger**) displays the steps that **My Outline Pass** executes in the left window, highlighted in the image below: - - - -To learn more about the Frame Debugger, see the [Frame Debugger](https://docs.unity3d.com/Manual/FrameDebugger.html) documentation. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Injection-Points.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Injection-Points.md index 89bddeb728f..c44d7802ccd 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Injection-Points.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Custom-Pass-Injection-Points.md @@ -23,6 +23,3 @@ Unity triggers the following injection points in a frame, in order from top to b | BeforeTransparent | Color (Pyramid \| Read \| Write), Depth (Read \| Write), Normal and roughness (Read), Motion Vectors (Read) | The available buffers for this injection point contain:
- All opaque objects.
- Transparent PreRefraction objects.
- Transparent objects with depth-prepass and screen space reflections (SSR) enabled.
In this Injection Point you can sample the color pyramid that Unity uses for transparent refraction. You can use this to create a blur effect. All objects Unity renders in this injection point will not be in the color pyramid.
You can also use this injection point to draw some transparent objects that refract the whole scene, like water. | | BeforePostProcess | Color (Pyramid \| Read \| Write), Depth (Read \| Write), Normal and roughness (Read), Motion Vectors (Read) | The available buffers for this injection point contain all geometry in the frame that uses High Dynamic Range (HDR). | | AfterPostProcess | Color (Read \| Write), Depth (Read) | The available buffers for this injection point contain the final render of the scene, including post-process effects.
This injection point executes the available buffers after Unity applies any post-processing effects.
If you select this injection point, objects that use the depth buffer display jittering artifacts.
When you select this injection point for a [FullscreenCustom Pass](custom-pass-create-gameobject.md#full-screen-custom-pass), Unity assigns the camera color buffer as the target by default. | - -The purple boxes correspond to the injection points above in this diagram representing the pass layout in HDRP: - \ No newline at end of file diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md index 74248e7696a..a58dd6c4047 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Default-Settings-Window.md @@ -6,6 +6,12 @@ The section contains the following settings that let you define project-wide set You can also add your own settings. Refer to [Add custom settings](https://docs.unity3d.com/Packages/com.unity.render-pipelines.core@17.0/manual/add-custom-graphics-settings.html) in the Scriptable Render Pipeline (SRP) Core manual for more information. +## Lightmap Sampling Settings + +| **Property** | **Description** | +| --------------------------| ------------------------------------------------------------ | +| **Use Bicubic Lightmap Sampling** | Improves the visual fidelity of lightmaps by smoothening sharp or jagged edges, especially at the edges of shadows. Enabling this property might reduce performance on lower-end platforms. | + ## Additional Shader Stripping Settings | **Property** | **Description** | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Double-Sided.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Double-Sided.md index 40edb4a4311..c188e48d858 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Double-Sided.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Double-Sided.md @@ -2,7 +2,7 @@ This setting controls whether The High Definition Render Pipeline (HDRP) renders both faces of the geometry of GameObjects using this Material, or just the front face. -  +  This setting is disabled by default. Enable it if you want HDRP to render both faces of your geometry. When disabled, HDRP [culls](https://docs.unity3d.com/Manual/SL-CullAndDepth.html) the back-facing polygons of your geometry and only renders front-facing polygons. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Environement-Limitations.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Environment-Limitations.md similarity index 100% rename from Packages/com.unity.render-pipelines.high-definition/Documentation~/Environement-Limitations.md rename to Packages/com.unity.render-pipelines.high-definition/Documentation~/Environment-Limitations.md diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Glossary.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Glossary.md index c2510eb6521..0a83106cb6c 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Glossary.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Glossary.md @@ -113,8 +113,6 @@ An anti-aliasing technique that uses frames from a history buffer to smooth edge A measure of the amount of light ([luminous flux](#LuminousFlux)) falling onto a given area. Differs from luminance because illuminance is a specific measurement of light whereas luminance describes visual perceptions of light. - - #### luminous flux: diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Features.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Features.md index a6f354177fa..995cb82f790 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Features.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Features.md @@ -76,19 +76,19 @@ HDRP Shaders allow you to use the following features: ### Lit Shader - + The Lit Shader is the default Shader in HDRP. Use the Lit Shader to create realistic Materials. The Lit Shader also includes options for effects including subsurface scattering, iridescence, and translucency. For more information, including the full list of Shader properties, see the [Lit Shader documentation](lit-material.md) and [Lit master stack](lit-master-stack-reference.md). ### Layered Lit Shader - + The Layered Lit Shader combines a main Material with other tileable Materials to produce visuals with a similar quality to a single high-resolution texture, but in a way that's less resource intensive than a [Lit Shader](lit-material.md) using the single high-resolution Texture. For more information, including a full list of Shader properties, see the [Layered Lit Shader documentation](layered-lit-material-inspector-reference.md). ### Unlit Shader - + The Unlit Shader allows you to create Materials that aren't affected by lighting. Unlit Shaders are perfect for visual effects. For more information, including a full list of Shader properties, see the [Unlit Shader documentation](unlit-shader.md) and [Unlit master stack](unlit-master-stack-reference.md). @@ -96,13 +96,13 @@ With the **Shadow Matte** option, you can have the surface receive shadow withou ### StackLit Shader - + The StackLit Shader is a higher quality than the Lit Shader, but more resource intensive. This Shader coats surfaces more accurately than the Lit Shader, and, unlike the Lit Shader, allows you to use multiple Material features like anisotropy, subsurface scattering iridescence, and hazy parametrization at the same time. For more information, including a full list of Shader properties, see the [Stacklit master stack](stacklit-master-stack-reference.md) ### Hair Shader - + The Hair Shader is purpose-built to accurately render realistic and stylized hair in your Unity Project. You can use the following modes: - Physically based: Uses the Marschner lighting model with multiple scattering to improve the realism of light-colored hair. @@ -112,13 +112,13 @@ For more information, including a full list of Shader properties, see the [Hair ### Fabric Shader - + The Fabric Shader allows you to render realistic fabric Materials in HDRP. You can use the cotton wool or silk lighting model to create a wide variety of fabrics. For more information, including a full list of Shader properties, see [Create a fabric material](create-a-fabric-material.md). ### Eye Shader - + The Eye Shader allows you to render realistic eye Materials in HDRP. The Eye shader can use the following material types: - Eye: Uses a low resource-intensity method to calculate caustics. @@ -130,13 +130,13 @@ For more information, including a full list of Shader properties, see the [Eye S ### AxF Shader - + The AxF Shader supports the [X-Rite AxF](https://www.xrite.com/axf) measured Material format. The AxF importer, available in [Unity Enterprise for Product Lifecylce](https://unity.com/products/unity-enterprise-product-lifecycle), automatically populates an AxF Material when it imports AxF Assets. For more information, including a full list of Shader properties, see the [AxF Shader documentation](AxF-material-inspector-reference.md). ### Decals - + Use Decals to apply a separate texture to surfaces in your Scene. To apply a decal to a surface, you can either use the [Decal Projector component](decal-projector-reference.md) to project the decal onto the surface, or assign the decal shader directly to a Mesh and then place the Mesh on the surface. @@ -146,17 +146,17 @@ For more information, see [Decals](decals.md). ### Terrain Shader - + The Terrain Lit Shader is compatible with the built-in terrain system and supports up to eight layers in a single draw call. This Shader uses the same lighting model as the Lit Shader. For more information, including the full list of Shader properties, see the [Terrain Lit Shader documentation](terrain-lit-material.md). ### Compute Thickness - + Compute Thickness is a screen-space pass that calculates the accumulated [thickness](Compute-Thickness.md) of objects in a specific Layer. HDRP calculates the optical path and overlap count, which you can use with [Subsurface Scattering](skin-and-diffusive-surfaces-subsurface-scattering.md) and [Refraction](Override-Screen-Space-Refraction.md). You can also use the overlap count to calculate compute thickness on non-closed or flat geometry like vegetation. Use the [HD Sample Buffer](https://docs.unity3d.com/Packages/com.unity.shadergraph@latest/index.html?preview=1&subfolder=/manual/HD-Sample-Buffer-Node.html) node to sample the thickness in a Shader Graph. ### Volumetric Materials - + In HDRP, you can control the density of fog in an area to create a Volumetric fog effect. Use a [local volumetric fog](create-a-local-fog-effect.md) volume override to set a 3D Mask texture or a shader graph that controls the fog color and the density. @@ -168,7 +168,7 @@ The Visual Effect Graph supports volumetric outputs, like the [Volume (Cone)](ht ### Light types - + The HDRP light types use [physical light units](#PLU) to help you light your Scene in the most realistic way possible. To assist you in creating physically accurate lights, the [Light component](Light-Component.md) Inspector includes icons alongside the **Intensity** and **Temperature** properties. Each icon displays the real-world light source that the value of each property currently represents. Each icon is also a button which you can click to access a list of preset values that match real-world light sources. For lights to behave properly when using PLU, you need to respect HDRP unit convention (1 Unity unit equals 1 meter). The HDRP light types are: @@ -205,7 +205,7 @@ For more information, including the full list of light properties, see the [Ligh ### Rendering Layers - + Rendering Layers are Layer Masks that you specify for Lights, Decals and Meshes. Lights only illuminate Meshes that are on the same Rendering Layer. You can also use Rendering Layers in the shadow map settings to decouple shadows from lighting. For more information on Rendering Layers, see the [Rendering Layers documentation](Rendering-Layers.md). @@ -213,20 +213,16 @@ You can use Rendering layers in the shadow map dropdown to control which GameObj ### IES Profiles and light cookies - + HDRP supports the Illuminating Engineering Society's (IES) file format for describing the distribution of light from a light source. HDRP supports the IES profile for Point, Spot (Cone, Pyramid, and Box), and rectangular Area [Lights](Light-Component.md). You can also mix the IES profile with [cookies](https://docs.unity3d.com/Manual/Cookies.html) and even use the profile and cookie mix for [light map baking](https://docs.unity3d.com/Manual/LightMode-Baked.html). ### Light Anchor - - HDRP's [Light Anchor component](light-anchor.md) allows you to manipulate a light from the Main Camera view. ### Light Explorer - - HDRP adds options to the [Light Explorer](https://docs.unity3d.com/Manual/LightingExplorer.html) that you can use to select and edit the following light sources: - Directional lights - Point lights @@ -238,32 +234,32 @@ HDRP adds options to the [Light Explorer](https://docs.unity3d.com/Manual/Lighti ### Lens Flare, data-driven - + Use HDRP's data-driven Lens Flare system provides a [lens flare asset](shared/lens-flare/lens-flare-asset.md) and a [lens flare component](shared/lens-flare/lens-flare-component.md) that you can attach to any GameObject. You can control each element of a Lens Flare individually. ### Lens Flare, Screen Space - + HDRP generates the Screen Space Lens Flare effect from screen information to create multiple types of flares based on the [Bloom](Post-Processing-Bloom.md) texture. This is useful for view-dependent bright spots (like specular reflection and overexposed areas) that don't have a defined position in world space. ### Reflection probes - + HDRP supports cubemap reflections that take surface smoothness into account. HDRP cubemap reflection optionally supports a fake distance based roughness. This helps you produce realistic reflections in your Scene in real time. You can control the reflection probe resolution for each probe. For more information, see [introduction to Reflection Probes](Reflection-Probes-Intro.md) ### Planar reflection probe - + HDRP supports Planar reflection probes that take surface smoothness into account. This allows you to create effects that mimic a shiny mirror or a wet floor. HDRP includes accurate filtering for planar reflection that's close to being physically based. For more information, see [Planar Reflection Probe](Planar-Reflection-Probe.md). ### Screen-space reflection and refraction - + HDRP provides a screen-space solution for reflection and refraction. It uses the depth and color buffer of the screen to help simulate the path that light travels to the Camera and uses this to calculate accurate reflection and refraction. You can use this feature for transparent materials too, such as windows or water. For more information, see [screen-space reflection](Override-Screen-Space-Reflection.md) and [screen-space refraction](Override-Screen-Space-Refraction.md). To see how to setup refractive materials and understand the limitations of Screen Space Refraction, download the [Material Sample](HDRP-Sample-Content.md#material-samples) from the Package Manager window and open the **Transparency** scenes. @@ -280,7 +276,7 @@ HDRP includes a [screen space ambient occlusion](Override-Ambient-Occlusion.md) Screen space ambient occlusion in HDRP can apply a direction to indirect specular lighting. To improve the specular occlusion approximation, you can use a texture that contains bent normal information that corresponds to the light direction. ### Adaptive Probe Volumes - + demo, with a woman sitting playing chess in a large ornate room.](Images/HDRPFeatures-APV.png) Adaptive Probe Volumes (APV) is a probe-based global illumination system that automatically places light probes based on the geometry density in your scene. APV features include: - Per-pixel probe selection and lighting. @@ -294,7 +290,7 @@ For more information, see [APV](probevolumes.md). ### Screen-space global illumination - + HDRP supports screen-space global illumination (SSGI). SSGI is an algorithm that accesses the indirect diffuse lighting that the environment generates. It works in the same way as the [Screen Space Reflection](Override-Screen-Space-Reflection.md) in that it uses ray marching to calculate the result. @@ -311,8 +307,6 @@ HDRP allows you to calculate exposure using several methods. This includes: ##### Histogram exposure - - HDRP's exposure implementation computes a histogram of the image which allows you to select high and low percentile values to discard. Discarding outlying values in the shadows or highlights helps to calculate a more stable exposure. For more information, see [Exposure](Override-Exposure.md). ##### Metering mode @@ -321,13 +315,13 @@ HDRP's exposure implementation includes a metering mask. This includes a texture ### Emission - + HDRP Materials support light [emission](lit-material-inspector-reference.md#EmissionInputs), which allows you to make a Material into a self-illuminated visible source of light. Global illumination takes emission into account and you can use [physical light units](#PLU) to set the intensity based on real-world lights. ### Shadows - + HDRP uses multiple methods to calculate shadows: @@ -355,7 +349,7 @@ To apply a tint to the shadow or the penumbra of the shadow: ### Ray tracing - + You can use ray tracing as an alternative to some screen space effects, shadowing techniques, and Mesh rendering techniques: @@ -379,7 +373,7 @@ You can use ray tracing as an alternative to some screen space effects, shadowin ### Sky - + In HDRP, you set up the sky inside a [Volume](understand-volumes.md), so you can change sky settings, or even the type of sky itself, depending on the position of the Camera in the Scene. HDRP allows you to separate the visual sky from the sky that you use for environment lighting. HDRP includes the following built-in sky types for you to use in your Unity Project: @@ -391,7 +385,7 @@ HDRP is able to handle multiple skies seen by different Cameras. #### Backplate - + A backplate projects the bottom part of a [HDRI Sky](create-an-hdri-sky.md) onto a plane in one of the following shapes: - **Rectangle** @@ -403,7 +397,7 @@ To match the scale of the GameObjects in your Scene, change the Backplate's **Sc ### Cloud Layer - + In HDRP, you set up cloud layers inside a [Volume](Volumes.md), so you can change clouds settings, or even the type of clouds itself, depending on the position of the Camera in the Scene. HDRP allows you to separate the clouds in the visual sky from the clouds that you use for environment lighting. HDRP includes the following built-in cloud type for you to use in your Unity Project: @@ -411,13 +405,13 @@ In HDRP, you set up cloud layers inside a [Volume](Volumes.md), so you can chang ### Volumetric Clouds - + You can use a [Volume](understand-volumes.md) component to create volumetric clouds. Volumetric clouds physically exist inside a scene, HDRP does not project them on the HDRI sky. A camera can fly through volumetric clouds and volumetric clouds have accurate interactions with the sky, sun and fog. Volumetric clouds cast shadows on themselves and the ground using a Beer shadow map. For more information, refer to [Volumetric Clouds](create-realistic-clouds-volumetric-clouds.md). ### Fog - + In HDRP, you set up fog inside a [Volume](understand-volumes.md) which means you can change fog settings or the fog type depending on the position of the Camera in the Scene. You can set the color of the fog yourself or use the color of the sky. HDRP fog affects Materials with both opaque and transparent surfaces. HDRP implements an exponential [fog](fog.md) with optional volumetric effects. @@ -425,7 +419,7 @@ In HDRP, you set up fog inside a [Volume](understand-volumes.md) which means you ### Water Surface - + Use HDRP's water system to create and control realistic water surfaces. HDRP's water system includes the following features: - Multiple presets. @@ -446,13 +440,13 @@ For more information, refer to [Water system](water.md). ### Post-processing - + HDRP includes its own purpose-built implementation for post-processing to produce exceptionally high-quality graphics. You can use post-processing to apply full-screen filters and effects to the Camera to drastically improve the visuals of your Unity Project with little set-up time. For an overview on HDRP post-processing, see the [post-processing documentation](Post-Processing-Main.md). ### HDR Display Output - + You can output a HDRP scene to high dynamic range (HDR) displays and customize the output in the following ways: @@ -464,13 +458,13 @@ For more information see the [High Dynamic Range Output documentation](HDR-Outpu ### Accumulation motion blur - + HDRP includes a recording API that you can use to render effects like high-quality accumulation motion blur. This technique combines information from multiple intermediate sub-frames to create a converged frame. Use this API to extract the converged frame and perform further processing or save it to disk. For information about this feature, and some example scripts, see [Multiframe rendering and accumulation](Accumulation.md). ### Anti-Aliasing - + HDRP includes the following [antialiasing](Anti-Aliasing.md) methods to help you remove aliasing effects with performance and quality in mind: @@ -485,28 +479,24 @@ HDRP uses a physically based Camera system that works seamlessly with the other ### Custom Post-processing - + HDRP allows you to add your own custom post processes integrated with the volume framework. You can inject them after opaque and sky object, before the [temporal antialiasing](Anti-Aliasing.md#TAA) pass, before built-in post processes or after built-in post processes. For more information, see the [Custom Post-processing documentation](Custom-Post-Process.md). ### Custom Passes - - Use a Custom Pass to inject shaders and C# scripts at certain points inside the render pipeline. You can use a Custom Pass to draw objects, override the rendering properties of objects in your scene, perform fullscreen passes and read some camera buffers like depth, color, normal or motion vectors. You can also use this Camera override to render some GameObjects with a different field of view, like arms in a first-person application. For more information, see [Custom Pass](Custom-Pass.md). Use the [Custom Pass API](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest?subfolder=/api/UnityEngine.Rendering.HighDefinition.CustomPassUtils.html) to render GameObjects from another point of view, like a disabled camera, within the rendering of your main Camera. You can use this API to render `Depth`, `Normal`, and `Tangent` into an `RTHandle`. ### High Quality Line Rendering - + High Quality Line Rendering allows you to render hair, wires, and other line-based geometry with high quality anti-aliasing and transparency. For more information, refer to [High Quality Line Rendering](Override-High-Quality-Lines.md). ### Custom Pass AOV Export - - This feature allows you to export arbitrary data from custom pass injection points using an extension of the Arbitrary Output Variables (AOV) API in HDRP. An example use-case is for exporting “Object IDs” that are rendered with a custom pass. For information about the feature and example scripts, see the [AOV documentation](AOVs.md). ### Fullscreen Shader Graph @@ -515,7 +505,7 @@ Use the Fullscreen Shader Graph to create custom post process and fullscreen cus ### Custom Render Texture in Shader Graph - + In HDRP, you can use [Custom Render Textures](https://docs.unity3d.com/Manual/class-CustomRenderTexture.html) as a Shader Graph target to create static or dynamic textures. Custom Render Textures support multiple texture dimensions. For example, you can use 3D textures with Local Volumetric Fog, and Cubemaps in the HDRI sky. @@ -526,7 +516,7 @@ You can also create complex effects like dynamic ripples and snow deformation wn Use the [Canvas ShaderGraph](canvas-material.md) to create custom [UGUI user interface elements](https://docs.unity3d.com/Packages/com.unity.ugui@1.0/manual/UICanvas.html). ### Graphics Compositor - + Use the Graphics Compositor to compose images and videos with 3D content into a final frame in real-time, without an external compositing tool. @@ -544,7 +534,7 @@ For information, see [HDRP Compositor](graphics-compositor.md). ### Path-traced depth of field - + HDRP includes a depth of field mode for producing path-traced images with high-quality defocus blur. This mode can use multiple layers of transparency and doesn't produce any artifacts. However, path tracing can cause some noise. To fix noise artefacts, increase the sample count or using an external denoising tool. For more information about, see [Depth-of-field](Post-Processing-Depth-of-Field.md). @@ -554,13 +544,13 @@ HDRP includes a recording API which you can use to render converged path-traced ### Path-traced sub-surface scattering - + Path tracing supports subsurface scattering (SSS), using a random walk approach. To use it, enable path tracing and set up SSS in the same way as you would for HDRP materials. For information on SSS in HDRP, see [subsurface scattering](skin-and-diffusive-surfaces-subsurface-scattering.md). ### Path-traced fog - + Path tracing in HDRP supports anisotropic fog absorption. To use this feature enable path tracing and set up fog in HDRP. For information, refer to [fog](fog.md). @@ -570,8 +560,6 @@ Path tracing works with [decals](decals.md). For more information, refer to [Und ### Materials support - - Path tracing can render the following rasterization engine [Materials](#Material): - Lit @@ -585,7 +573,7 @@ When you enable path tracing, objects that use non-HDRP Materials won't appear i ### Denoising support - + HDRP supports denoising for frames that use path tracing. You can choose from the following denoising libraries: - Optix Denoiser. @@ -597,19 +585,17 @@ HDRP supports denoising for frames that use path tracing. You can choose from th ### Color checker - + Use the Color Checker tool to check the calibration of lighting and post processing. To open the color checker tool, go to **GameObject** > **Rendering** > **Color Checker Tool**. HDRP doesn't save any changes you make in the color checker. ### Light placement tool - - Use the Light Placement Tool to look through a light and use the camera movement controls to move the light around the scene. To enter this mode select a light GameObject and select the Light Placement Tool button in the Tools Panel. For more information, refer to [Light placement tool](lights-placement-tool.md) ### LookDev - + The LookDev is a viewer that allows you to import and display Assets in a consistent lighting environment. Use the LookDev window to validate outsourced Assets or to showcase your own created Asset with HDRP. For more information on the LookDev, including a description of how to use it, see the [LookDev documentation](test-and-debug-materials-in-different-lighting-conditions-look-dev.md). ### Render Pipeline Wizard diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Sample-Content.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Sample-Content.md index fef1813e34c..6c1161871bd 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Sample-Content.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/HDRP-Sample-Content.md @@ -6,7 +6,7 @@ A Sample is a set of Assets that you can import into your Project and use as a b To find these Samples: -1. Go to **Window** > **Package Manager**, and select **High Definition RP** from the package list. +1. Go to **Window** > **Package Management** > **Package Manager**, and select **High Definition RP** from the package list. 2. In the main window that shows the package's details, find the **Samples** section. 3. To import a Sample into your Project, click the **Import into Project** button. This creates a **Samples** folder in your Project and imports the Sample you selected into it. This is also where Unity imports any future Samples into. @@ -28,7 +28,7 @@ This Sample includes various examples of lit and unlit particle effects. ## Material samples - + This Sample includes various examples of Materials. It includes Materials that use the [Lit Shader](lit-material.md), [Fabric Master Stack](fabric-master-stack-reference.md), [Hair Master Stack](hair-master-stack-reference.md), [Eye Shader](eye-master-stack-reference.md) and [Decal Master Stack](decal-master-stack-reference.md). The included Materials use effects such as subsurface scattering, displacement, and anisotropy. The **MaterialSamples** Scene requires Text Mesh Pro to display the text explanations. @@ -38,14 +38,14 @@ In the **Eye** Scene, the eye examples use a carefully designed mesh with a part ## Transparent samples - + In the Transparency scene, the examples contain information on how to setup properly transparents in your projects using different rendering methods (Rasterization, Ray Tracing, Path Tracing). To take advantage of all the content of this section, a GPU that supports [Ray Tracing](Ray-Tracing-Getting-Started.md) is needed. ## Lens Flare samples - + The [Lens Flare](shared/lens-flare/lens-flare-component.md) samples include the following examples that you can use in your project: - Lens Flare Assets. @@ -56,7 +56,6 @@ The [Lens Flare](shared/lens-flare/lens-flare-component.md) samples include the ## Volumetric samples - The volumetric samples include a scene that contains multiple examples of [volumetric fog](create-a-local-fog-effect.md). This scene includes the following: - 3D textures. @@ -64,7 +63,7 @@ The volumetric samples include a scene that contains multiple examples of [volum - Fog Volume Shader Graph examples. ## Fullscreen samples - + This sample includes examples on how to create a [Fullscreen Shader](create-a-fullscreen-material.md) and use it with a Custom Pass, Custom Post Process and Custom Render Target. The sample scene includes prefabs for the following effects: @@ -74,7 +73,7 @@ This sample includes examples on how to create a [Fullscreen Shader](create-a-fu ## Water samples - + The Water samples contain the following scenes you can use to learn about HDRP's [Water](water.md) features: @@ -86,7 +85,7 @@ The Water samples contain the following scenes you can use to learn about HDRP's ## Environment samples - + This sample puts multiple environment effects together in the same scene with different lighting conditions. The scene includes examples focusing on the following effects: diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/IES-Importer.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/IES-Importer.md index f0240ece106..ad0b332f612 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/IES-Importer.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/IES-Importer.md @@ -2,8 +2,6 @@ The High Definition Render Pipeline (HDRP) includes an importer to handle the .ies file format. When you add an [IES profile](IES-Profile.md) to your project, the IES importer Inspector provides information and customization options for the internally used textures. - - When you apply the import settings, the importer generates a [Light](Light-Component.md) Prefab as a sub-asset of the IED profile. You can drag the Prefab into the Scene view or Hierarchy to create an instance of a Light that uses the IES profile. ### Properties diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/IES-Profile.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/IES-Profile.md index 52b9d088342..04079a82426 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/IES-Profile.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/IES-Profile.md @@ -2,7 +2,7 @@ IES profiles describe how light spreads for a given direction. They are similar to [light cookies](https://docs.unity3d.com/Manual/Cookies.html) in that they use a multiplier mask to achieve this goal. The Unity IES profile supports Point, Spot (Cone, Pyramid, Box), and Area (Rectangular) [Lights](Light-Component.md). - + The main benefit of using IES profiles over cookies is that light manufacturers provide the profiles. This means that they are physically accurate to the real-world light they represent and also artists do not need to dedicate time authoring them. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/3d-texture-mask-sample.webp b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/3d-texture-mask-sample.webp deleted file mode 100644 index 8f14ce4f4de..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/3d-texture-mask-sample.webp and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Area_Materials.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Area_Materials.png deleted file mode 100644 index edb4211daa0..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Area_Materials.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/ContactShadowLightComponent.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/ContactShadowLightComponent.png deleted file mode 100644 index fc510c9fe3f..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/ContactShadowLightComponent.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Exposure_Histogram.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Exposure_Histogram.png deleted file mode 100644 index 5e79f6802aa..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Exposure_Histogram.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/FS_SampleTex2DArray.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/FS_SampleTex2DArray.png deleted file mode 100644 index 3fff9be2bf7..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/FS_SampleTex2DArray.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/FidelityFX-Menu.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/FidelityFX-Menu.png deleted file mode 100644 index 38938f77323..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/FidelityFX-Menu.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPFeatures-CustomPass.gif b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPFeatures-CustomPass.gif deleted file mode 100644 index 62e72392886..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/HDRPFeatures-CustomPass.gif and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/HDSampleBuffer.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/HDSampleBuffer.png deleted file mode 100644 index 42f7f619f25..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/HDSampleBuffer.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/IESImporter1.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/IESImporter1.png deleted file mode 100644 index 6e90fee7e6d..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/IESImporter1.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/LightExplorer.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/LightExplorer.png deleted file mode 100644 index 1051157ae64..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/LightExplorer.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/LightPlacementTool.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/LightPlacementTool.png deleted file mode 100644 index f9cdebde618..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/LightPlacementTool.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingFilmGrain1.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingFilmGrain1.png deleted file mode 100644 index 91c3be7c84d..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingFilmGrain1.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingPaniniProjection1.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingPaniniProjection1.png deleted file mode 100644 index 8b846505d85..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingPaniniProjection1.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingPropagatingNaNsRenderDoc.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingPropagatingNaNsRenderDoc.png deleted file mode 100644 index 5bc2e0501b0..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingPropagatingNaNsRenderDoc.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingShadowsMidtonesHighlights1.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingShadowsMidtonesHighlights1.png deleted file mode 100644 index 2fc2ac87a64..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingShadowsMidtonesHighlights1.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingSplitToning1.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingSplitToning1.png deleted file mode 100644 index 606a3505e58..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingSplitToning1.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingWhiteBalance1.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingWhiteBalance1.png deleted file mode 100644 index ee776368763..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Post-processingWhiteBalance1.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Shadows1.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Shadows1.png deleted file mode 100644 index a5c98a79aef..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/Shadows1.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/SpecularOcclusion.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/SpecularOcclusion.png deleted file mode 100644 index 09292819719..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/SpecularOcclusion.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/UseMipBias.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/UseMipBias.png deleted file mode 100644 index a4b18e2e3de..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/UseMipBias.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/about-blending-modes.webp b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/about-blending-modes.webp deleted file mode 100644 index 5cff49c8633..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/about-blending-modes.webp and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/cloudy-sample.webp b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/cloudy-sample.webp deleted file mode 100644 index 105627ccf23..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/cloudy-sample.webp and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/environment-plane-settings.jpg b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/environment-plane-settings.jpg deleted file mode 100644 index 618b2938bab..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/environment-plane-settings.jpg and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/foggy-orb-and-light-sample.webp b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/foggy-orb-and-light-sample.webp deleted file mode 100644 index 376ac79afeb..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/foggy-orb-and-light-sample.webp and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/fumes-sample.webp b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/fumes-sample.webp deleted file mode 100644 index c393039b8f1..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/fumes-sample.webp and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/ghost-beast.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/ghost-beast.png deleted file mode 100644 index 7df7f6f2371..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/ghost-beast.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/gpu-occlusion-culling-ux.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/gpu-occlusion-culling-ux.png deleted file mode 100644 index 5e8961322c1..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/gpu-occlusion-culling-ux.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/ground-smoke-prefab-sample.webp b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/ground-smoke-prefab-sample.webp deleted file mode 100644 index 6fdf63202fa..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/ground-smoke-prefab-sample.webp and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/procedural-noise-fog-sample.webp b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/procedural-noise-fog-sample.webp deleted file mode 100644 index 61ddf66e268..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/procedural-noise-fog-sample.webp and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/samples-materials.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/samples-materials.png deleted file mode 100644 index 845b9093e53..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/samples-materials.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lensflare-ring.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lensflare-ring.png deleted file mode 100644 index a0d7757d38f..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/shared/lens-flare/lensflare-ring.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/stp-comparison.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/stp-comparison.png deleted file mode 100644 index 92fbd5ac96c..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/stp-comparison.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/stp-upscaler-ux.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/stp-upscaler-ux.png deleted file mode 100644 index 840084b3de8..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/stp-upscaler-ux.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/visualenvironment-renderingspace.png b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/visualenvironment-renderingspace.png deleted file mode 100644 index 5c1abfd746b..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/visualenvironment-renderingspace.png and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/volumetric-heart-sample.webp b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/volumetric-heart-sample.webp deleted file mode 100644 index a3b0c2ed5db..00000000000 Binary files a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Images/volumetric-heart-sample.webp and /dev/null differ diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/LUT-Authoring-Photoshop.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/LUT-Authoring-Photoshop.md index 22eb8c6ff26..e4150c5cf68 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/LUT-Authoring-Photoshop.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/LUT-Authoring-Photoshop.md @@ -23,7 +23,7 @@ Export the current [Camera](hdrp-camera-component-reference.md)'s view to a log- After you export the EXR file, transform the data from the format that Unity uses (Alexa LogC El.1000) to Linear RGB space, so that external software can use it. To do this, HDRP provides a set of ready-to-use transform LUTs. To get them: -1. Open the Package Manager window (menu: **Window** > **Package Manager**). +1. Open the Package Manager window (menu: **Window** > **Package Management** > **Package Manager**). 2. Select **High Definition RP** from the list of packages on the left. 3. In the **Samples** section, select **Import into Project** next to **Additional Post-processing Data**. 4. This imports the LUTs into Assets/HDRP Sample Content/Post-processing/Cube LUTs/. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/LUT-Authoring-Resolve.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/LUT-Authoring-Resolve.md index 5a2c67d720d..c8615a98eec 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/LUT-Authoring-Resolve.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/LUT-Authoring-Resolve.md @@ -23,7 +23,7 @@ Export the current [Camera](hdrp-camera-component-reference.md)'s view to a log- After you export the EXR file, transform the data from the format that Unity uses (Alexa LogC El.1000) to Linear RGB space, so that external software can use it. To do this, HDRP provides a set of ready-to-use transform LUTs. To get them: -1. Open the Package Manager window (menu: **Window > Package Manager**). +1. Open the Package Manager window (menu: **Window** > **Package Management** > **Package Manager**). 2. Select **High Definition RP** from the list of packages on the left. 3. In the **Samples** section, select **Import into Project** next to **Additional Post-processing Data**. 4. This imports the LUTs into Assets/HDRP Sample Content/Post-processing/Cube LUTs/. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Light-Component.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Light-Component.md index 1f9c4d3077e..6ed657b6865 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Light-Component.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Light-Component.md @@ -2,7 +2,7 @@ Use the Light component to create light sources in your [Scene](https://docs.unity3d.com/Manual/CreatingScenes.html). The Light component controls the shape, color, and intensity of the light. It also controls whether or not the Light casts shadows in your Scene, and more advanced settings. - + ## Create Lights diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Mask-Map-and-Detail-Map.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Mask-Map-and-Detail-Map.md index 87261c9b382..01a7714da8b 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Mask-Map-and-Detail-Map.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Mask-Map-and-Detail-Map.md @@ -26,7 +26,7 @@ To create a mask map, create a linear composited map in a photo editor, using th The following example image demonstrates the individual components of a full mask map. - + @@ -45,7 +45,7 @@ To create a detail map, create a linear composited map in a photo editor, using The following example image demonstrates the individual components of a full detail map. - + ### Desaturated albedo (red channel) @@ -53,7 +53,7 @@ The red channel represents the albedo variation. It makes the underlying materia The image below shows the impact of the detail albedo on the final color. HDRP calculates color interpolation in sRGB space. - + ### Smoothness (blue channel) @@ -61,8 +61,8 @@ The blue channel represents the smoothness variation and HDRP calculates it the The image below shows the impact of the detail smoothness on the final color. - + The following example shows the same gradient detail map as above, used by three Lit materials with different smoothness values. - + diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Material-Type.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Material-Type.md index e67490f389f..5d64aec6bc8 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Material-Type.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Material-Type.md @@ -11,7 +11,7 @@ The **Material Type** property allows you to give your Material a type, which al | **Specular Color** | Applies the Specular Color workflow to the Material. Use this **Material Type** to create Materials with a coloured specular highlight. This is similar to the [built-in Specular Shader](https://docs.unity3d.com/Manual/StandardShaderMaterialParameterSpecular.html). | | **Translucent** | Applies the Translucent workflow to the Material. Use this **Material Type**, and a thickness map, to simulate a translucent object, such as a plant leaf. In contrast to **Subsurface Scattering** Materials, **Translucent** Materials do not blur light that transmits through the Material. | - + ## Properties diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Menu-Items.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Menu-Items.md index 033b60a08e0..0fbfa4cb7be 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Menu-Items.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Menu-Items.md @@ -21,6 +21,8 @@ This section includes all the menu items under the **Edit > Rendering > Renderin This section includes all the menu items under the **Edit > Rendering > Materials** menu fold-out. +For more information, refer to [Convert materials and shaders](convert-from-built-in-convert-materials-and-shaders.md). + | **Item** | **Description** | |-------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Generate Material Resources** | Generate look-up table resources for all HDRP Materials. The generated resources will be placed in the directory **Assets/HDRPDefaultResources/Generated**. | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Diffusion-Profile.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Diffusion-Profile.md index 0887d6e17e4..a298604ce70 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Diffusion-Profile.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Diffusion-Profile.md @@ -13,8 +13,6 @@ To add a **Diffusion Profile List** to a Volume: ## Properties - - [!include[](snippets/Volume-Override-Enable-Properties.md)] | **Property** | **Description** | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Micro-Shadows.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Micro-Shadows.md index 08f2193adc2..83b9a762734 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Micro-Shadows.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Micro-Shadows.md @@ -6,7 +6,7 @@ HDRP uses the details from the normal map, the ambient occlusion map, and specul In this image, the different layers of details in the Material shadow each other. - + Micro shadows at 0.85 opacity on a mossy ground material viewed from the top. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Screen-Space-Refraction.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Screen-Space-Refraction.md index efc30f774dd..0c58e032397 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Screen-Space-Refraction.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Override-Screen-Space-Refraction.md @@ -15,7 +15,7 @@ To use this setting, you must enable it on a [Volume](understand-volumes.md), as 1. In the Scene or Hierarchy view, select a GameObject that contains a Volume component. 2. In the Inspector for this object, select **Add Override** > **Lighting** > **Screen Space Refraction**. -
+
In the refractive cube on the left of the screen, **Screen Weight Distance** affects the edges of the screen where HDRP fades from using the color buffer to using Reflection Probes. ## Properties diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Path-Tracing-Example.cs b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Path-Tracing-Example.cs new file mode 100644 index 00000000000..3d82073a245 --- /dev/null +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Path-Tracing-Example.cs @@ -0,0 +1,57 @@ +using UnityEngine; +using UnityEngine.Rendering; +using UnityEngine.Rendering.HighDefinition; + +// Class to modify or add a Volume Override from a script +public class ModifyVolumeComponent : MonoBehaviour +{ + public VolumeProfile volumeProfile; // Set this in the inspector + + // Start is called once before the first execution of Update after the MonoBehaviour is created + void Start() + { + // Check that a Volume Profile is set in the Inspector + if (volumeProfile != null) + { + // Get or create the path tracing Volume Override in the Volume Profile + GetOrCreateComponent(volumeProfile, out PathTracing pathTracingComponent); + + // Make sure that the Volume Override is active + pathTracingComponent.active = true; + + // Enable the path tracing effect + pathTracingComponent.enable.value = true; + + // Override the state of the enable field + pathTracingComponent.enable.overrideState = true; + + // Set the value for the maximumDepth field + pathTracingComponent.maximumDepth.value = 4; + + // Override the state of the maximumDepth field + pathTracingComponent.maximumDepth.overrideState = true; + } + } + + // Get a Volume Override from a Volume Profile. Create it if it doesn't exist + private static void GetOrCreateComponent
• **Off**: Select this option to disable depth of field.
• **Physical Camera**: Select this option to use the physical [Camera](hdrp-camera-component-reference.md) to set focusing properties for the depth of field effect. For information on what Camera properties affect depth of field, see [Physical Camera settings](#PhysicalCameraSettings).
• **Manual Ranges**: Select this option to use custom values to set the near and far range of the depth of field effect. | -| **Focus Distance Mode** | Use the drop-down to select where the focus distance is specified.
• **Volume**: Reads the focus distance from the Volume.
• **Camera**: Reads the focus distance from the physical camera.
This property only appears when you select **Physical Camera** from the **Focus Mode** drop-down. | +|-|-| +| **Focus Mode** | Use the drop-down to select the mode that HDRP uses to set the focus for the depth of field effect. The options are:
- **Off**: Select this option to disable depth of field.
- **Physical Camera**: Select this option to use the physical [Camera](hdrp-camera-component-reference.md) to set focusing properties for the depth of field effect. For more information about what Camera properties affect depth of field, refer to [Physical Camera settings](#PhysicalCameraSettings).
- **Manual Ranges**: Select this option to use custom values to set the near and far range of the depth of field effect.
- **Volume**: Reads the focus distance from the Volume.
- **Camera**: Reads the focus distance from the physical camera.
This property only appears when you select **Volume** from the **Distance Mode** drop-down. | ### Near Blur @@ -52,12 +52,12 @@ Here is a list of the physical [Camera](hdrp-camera-component-reference.md) prop | **Blades Count** | This determines the shape of the bokeh. For more information on the effect this property has, see the example below. | | **Curvature** | Determines how much of the blades are visible. Use this to change the roundness of bokeh in the blur. For more information on the effect this property has, see the example below. | -This example shows how the **Blade Count** and **Curvature** properties affect the shape of the bokeh: + -* On the left side, there is a five blade iris that's slightly open; producing a pentagonal bokeh. -* On the right side, there is a five blade iris that's wide open; producing a circular bokeh. +This example shows how the **Blade Count** and **Curvature** properties affect the shape of the bokeh: - +* On the left side, there is a five blade iris that's slightly open, producing a pentagonal bokeh. +* On the right side, there is a five blade iris that's wide open, producing a circular bokeh. ## Path-traced depth of field @@ -67,4 +67,4 @@ Path-traced depth of field produces images without any artifacts, apart from noi HDRP computes path-traced depth of field at full resolution and ignores any quality settings from the Volume. - + diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Film-Grain.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Film-Grain.md index 031c2f97e4c..55bd102f059 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Film-Grain.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Film-Grain.md @@ -13,8 +13,6 @@ The Film Grain effect simulates the random optical texture of photographic film, ## Properties - - | **Property** | **Description** | | ------------- | ------------------------------------------------------------ | | **Type** | Use the drop-down to select the type of grain to use. You can select from a list of presets that HDRP includes, or select **Custom** to provide your own grain Texture. | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Main.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Main.md index d993c49c8ad..ed64fc4af5b 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Main.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Main.md @@ -8,8 +8,8 @@ Post-processing effects in HDRP use the [Volume](understand-volumes.md) framewor The images below display a Scene with and without HDRP post-processing. - + Without post-processing. - + With post-processing. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Panini-Projection.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Panini-Projection.md index f6d31c9823e..a78340e5f73 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Panini-Projection.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Panini-Projection.md @@ -15,8 +15,6 @@ For more information about panini projection, see PanoTools’ wiki documentatio ## Properties - - | **Property** | **Description** | | --------------- | ------------------------------------------------------------ | | **Distance** | Use the slider to set the strength of the distortion. | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Propagating-NaNs.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Propagating-NaNs.md index 0b3f1cc5055..b13ea80a0ee 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Propagating-NaNs.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Propagating-NaNs.md @@ -18,13 +18,13 @@ A commonly reported issue in HDRP is that [bloom](Post-Processing-Bloom.md) gene For example, see a NaN caused by a material issue that spreads to the whole scene when HDRP calculates bloom: - + - + - + - + A similar issue occurs when HDRP generates color pyramids for use by features such as [screen-space reflection](Override-Screen-Space-Reflection.md), [screen-space refraction](Override-Screen-Space-Refraction.md), and distortion. @@ -57,9 +57,6 @@ After you capture a frame, RenderDoc can display pixels with a Nan or Inf value 1. In the Texture Viewer, open the **Overlay** drop-down. 2. Select **Nan or Inf/-ve Display**. - - - If the Nan or Inf values are still difficult to find: 1. Look at the bloom dispatches to see where bloom propagates the Nan or Inf pixels from. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Shadows-Midtones-Highlights.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Shadows-Midtones-Highlights.md index f29971137bc..8df8f634438 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Shadows-Midtones-Highlights.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Shadows-Midtones-Highlights.md @@ -13,8 +13,6 @@ The **Shadows Midtones Highlights** effect separately controls the shadows, midt ## Properties - - | **Property** | **Description** | | -------------- | ------------------------------------------------------------ | | **Shadows** | Use this to control the shadows. Use the trackball to select the color HDRP should shift the hue of the shadows to. Use the slider to offset the color lightness of the trackball color. | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Split-Toning.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Split-Toning.md index efd0ad51a63..e2814023d5d 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Split-Toning.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-Split-Toning.md @@ -15,8 +15,6 @@ This effect tints different areas of the image based on luminance values, to hel When you adjust the color in the color picker for each property, you should only adjust the **Hue** and **Saturation**. **Value** also changes the overall image brightness. - - | **Property** | **Description** | | -------------- | ------------------------------------------------------------ | | **Shadows** | Use the color picker to select the color that HDRP uses for tinting shadows. | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-White-Balance.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-White-Balance.md index 68a99d0a738..bc3de908af3 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-White-Balance.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Post-Processing-White-Balance.md @@ -13,8 +13,6 @@ The White Balance component applies a white balance effect that removes unrealis ## Properties - - | **Property** | **Description** | | --------------- | ------------------------------------------------------------ | | **Temperature** | Use the slider to set the white balance to a custom color temperature. Higher values result in a warmer color temperature and lower values result in a colder color temperature. See [Wikipedia: Color balance](https://en.wikipedia.org/wiki/Color_balance) for more information about color temperature. | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Contact-Shadows.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Contact-Shadows.md index e15d5faf8a8..8a4d3965c84 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Contact-Shadows.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Contact-Shadows.md @@ -2,17 +2,14 @@ Ray-Traced Contact Shadows is a ray tracing feature in the High Definition Render Pipeline (HDRP). It's an alternative to HDRP's [Contact Shadow](Override-Contact-Shadows.md) technique that uses a more accurate ray-traced solution that can use off-screen data. - +
+A stone temple scene without contact shadows. Foliage and dark corners have few shadows. -**Without Contact shadows** +
+A stone temple scene with contact shadows. Foliage and dark corners have more shadows. - - -**Contact shadows** - - - -**Ray-traced contact shadows** +
+A stone temple scene with ray-traced contact shadows. Foliage and dark corners have even more shadows. For information about ray tracing in HDRP, and how to set up your HDRP Project to support ray tracing, see [Getting started with ray tracing](Ray-Tracing-Getting-Started.md). @@ -27,5 +24,3 @@ This feature is an alternative to the [Contact Shadows](Override-Contact-Shadows 3. HDRP calculates ray-traced contact shadows on a per-light basis. This means you need to enable it for each light. 4. Select a [Light](Light-Component.md) and, in the Inspector, go to **Shadows > Contact Shadows** and tick the **Enable** checkbox. This exposes the **Ray Tracing** property. 5. Enable the **Ray Tracing** checkbox. - - diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Shadows.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Shadows.md index 844eaa469be..ae7bc9b52a9 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Shadows.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Shadows.md @@ -41,29 +41,29 @@ If a light is has **Shadowmask Mode** set to **Shadowmask**, then ray traced sha Ray-traced shadows offer an alternative to the cascade shadow map that Directional Lights use for opaque GameObjects. - + -**Directional Light cascade shadow map** +Directional Light cascade shadow map - + -**Ray-traced Directional Light shadows (Sun Angle = 0)** +Ray-traced Directional Light shadows (Sun Angle = 0) - + -**Ray-traced Directional Light shadows (Sun Angle = 0.53, the angle of the Sun as seen from Earth)** +Ray-traced Directional Light shadows (Sun Angle = 0.53, the angle of the Sun as seen from Earth) Ray-traced shadows allow for transparent and transmissive GameObjects, lit by Directional Lights, to cast colored shadows. **Note**: When you use a Directional Light with a transmissive GameObject, HDRP displays rasterized shadows on the reverse side of the GameObject. - + -**Ray-traced Directional Light shadows with colored shadows** +Ray-traced Directional Light shadows with colored shadows - + -**Ray-traced Directional Light shadows without colored shadows** +Ray-traced Directional Light shadows without colored shadows ### Properties @@ -81,27 +81,27 @@ Ray-traced shadows allow for transparent and transmissive GameObjects, lit by Di Ray-traced shadows offer an alternative to the shadow map that Point and Spot Lights use for opaque GameObjects. HDRP still evaluates the lighting of a Point Light as coming from a single point in space (the light is [punctual](Glossary.md#punctual-lights)), but it evaluates the shadowing as if the light was coming from the surface of a sphere. On the other side, HDRP evaluates the lighting of a Spot Light as coming from a single point in space, but it evaluates the shadowing as if the light was coming from the surface of a cone. - + -**Point Light shadow map** +Point Light shadow map - + -**Ray-traced Point Light shadows (Radius = 0.001m)** +Ray-traced Point Light shadows (Radius = 0.001m) - + -**Ray-traced Point Light shadows (radius = 0.5m)** +Ray-traced Point Light shadows (radius = 0.5m) Ray-traced shadows offer the possibility of semi-transparent shadows for Point Lights cast by transparent and transmissive GameObjects. - + -**Ray-traced Point Light shadows with semi-transparent shadows** +Ray-traced Point Light shadows with semi-transparent shadows - + -**Ray-traced Point Light shadows without semi-transparent shadows** +Ray-traced Point Light shadows without semi-transparent shadows ### Properties @@ -120,11 +120,11 @@ Ray-traced shadows offer the possibility of semi-transparent shadows for Point L Ray-traced shadows offer an alternative to the [exponential variance shadow map](Glossary.md#ExponentialVarianceShadowMap) that Rectangle Lights use for opaque GameObjects. - -**Rectangle Light shadow map** + +Rectangle Light shadow map - -**Ray-traced Rectangle Light shadows** + +Ray-traced Rectangle Light shadows **Note**: When rendering in [deferred mode](Forward-And-Deferred-Rendering.md), HDRP provides accurate ray-traced area light shadows for the [Lit](lit-material.md) shader. When HDRP renders for any other shader, or for the Lit shader in forward mode, it uses an approximation to calculate ray-traced shadows for area lights. This approximation is not perfectly accurate, but does produce plausible results. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Subsurface-Scattering.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Subsurface-Scattering.md index ec3161f2a3e..8ceda085788 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Subsurface-Scattering.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Traced-Subsurface-Scattering.md @@ -2,9 +2,9 @@ Ray-Traced Subsurface Scattering is a ray tracing feature in the High Definition Render Pipeline (HDRP). It is an alternative, more accurate, ray-traced solution to [Subsurface-Scattering](skin-and-diffusive-surfaces-subsurface-scattering.md) that can make use of off screen data. - + -**Perry head rendered with ray traced subsurface scattering** +A head rendered with ray traced subsurface scattering. ## Using ray traced subsurface scattering diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Tracing-Getting-Started.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Tracing-Getting-Started.md index acd737dc55f..95df44b565b 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Tracing-Getting-Started.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Ray-Tracing-Getting-Started.md @@ -123,15 +123,15 @@ To make HDRP calculate ray tracing effects for [Cameras](hdrp-camera-component-r To enable ray tracing by default: -1. Open the Project Settings window (menu: **Edit > Project Settings**), then select the HDRP Default Settings tab. -2. Select Camera from the Default Frame Settings For drop-down. -3. In the **Rendering** section, enable **Ray Tracing**. +1. From the main menu, select **Edit** > **Project Settings**. +2. In the **Project Settings** window, go to the **Pipeline Specific Settings** section, then select the **HDRP** tab. +3. Under **Frame Settings (Default Values)** > **Camera** > **Rendering**, enable **Ray Tracing**. -To enable ray tracing for a specific Camera: +To enable ray tracing for a specific camera: -1. Click on the Camera in the Scene or Hierarchy to view it in the Inspector. -2. In the **General** section, enable **Custom Frame Settings**. This exposes Frame Settings just for this Camera. -3. in the **Rendering** section, enable **Ray Tracing**. +1. Select the camera in the scene or **Hierarchy** window to view it in the **Inspector** window. +2. In the **Rendering** section, enable **Custom Frame Settings**. This exposes frame settings for this camera only. +3. Use the foldout (triangle) to expand **Rendering**, then enable **Ray Tracing**. #### Build settings @@ -200,7 +200,6 @@ HDRP ray tracing in Unity isn't compatible with the following features: - Vertex animation, for example wind deformation of vegetation. - [Decals](decals.md). - Ray tracing is not compatible with the detail meshes and trees in the [Terrain system](https://docs.unity3d.com/Manual/script-Terrain.html). It is compatible with terrain geometry. To include detailed meshes and trees in ray traced reflections, use [mixed tracing](Override-Screen-Space-Reflection.md#mixed-tracing). -- Box-shaped spot lights. - Volumetric [fog](create-a-local-fog-effect.md). - [Tessellation](Tessellation.md). - Per-pixel displacement techniques such as parallax occlusion mapping, depth offset, and non-terrain height maps. @@ -209,6 +208,9 @@ HDRP ray tracing in Unity isn't compatible with the following features: - [Orthographic projection](hdrp-camera-component-reference.md). If you enable orthographic projection mode, you might experience rendering problems with transparent materials, volumetrics, and planar reflections. - Ray Traced and Screen Space effects. These don't appear recursively in [Ray Traced Reflections](Ray-Traced-Reflections.md), [Ray Traced Global Illumination](Ray-Traced-Global-Illumination.md) or [Recursive Ray Tracing](Ray-Tracing-Recursive-Rendering.md). This means, for example, you can't see [Screen Space Global Illumination](Override-Screen-Space-GI.md) in [ray-traced reflections](Ray-Traced-Reflections.md). - Fully accurate shadow culling. You might see missing shadows in ray-traced effects. You can use **Extend Shadow Culling** to improve accuracy. See [Ray Tracing Settings](Ray-Tracing-Settings.md) for more information. +- Data-Oriented Technology Stack (DOTS) +- Entity Component System (ECS) +- Water #### Reflection Probes diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Reflection-Probe.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Reflection-Probe.md index b5bda4e0cb7..65198ce07fe 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Reflection-Probe.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Reflection-Probe.md @@ -86,7 +86,7 @@ You can use Scene view gizmos to visually customize specific properties. | **Gizmo** | **Property** | **Description** | | ------------------------------------------------------------ | ----------------------------------- | ------------------------------------------------------------ | -|  | **Influence Volume boundary**. | Provides Scene view handles that allow you to resize the boundaries of the [Influence Volume](#InfluenceVolume), which defines the area this Reflection Probe affects reflective Materials. Edits the **Box Size** or **Radius** value, depending on the **Shape** you select. | -|  | **Blend Distance boundary**. | Provides Scene view handles that allows you to alter the inward distance from the **Box Size** or **Radius** at which this Reflection Probe blends with other Reflection Probes. Its behavior depends on the [workflow mode](#Workflows) you are using. It scales all sides equally in **Normal** mode, scales just the side with the handle you control in **Advanced** mode. | -|  | **Blend Normal Distance boundary**. | Provides Scene view handles that allow you to resize the boundary where pixels with a normal pointing away from the **Capture Position** don’t receive any influence from this Probe. | -|  | **Capture Position**. | Changes the behavior of the Move Tool so that it alters the **Capture Position** property, rather than the **Position** of the **Transform**. | +|  | **Influence Volume boundary**. | Provides Scene view handles that allow you to resize the boundaries of the [Influence Volume](#InfluenceVolume), which defines the area this Reflection Probe affects reflective Materials. Edits the **Box Size** or **Radius** value, depending on the **Shape** you select. | +|  | **Blend Distance boundary**. | Provides Scene view handles that allows you to alter the inward distance from the **Box Size** or **Radius** at which this Reflection Probe blends with other Reflection Probes. Its behavior depends on the [workflow mode](#Workflows) you are using. It scales all sides equally in **Normal** mode, scales just the side with the handle you control in **Advanced** mode. | +|  | **Blend Normal Distance boundary**. | Provides Scene view handles that allow you to resize the boundary where pixels with a normal pointing away from the **Capture Position** don’t receive any influence from this Probe. | +|  | **Capture Position**. | Changes the behavior of the Move Tool so that it alters the **Capture Position** property, rather than the **Position** of the **Transform**. | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Reflection-Probes-Intro.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Reflection-Probes-Intro.md index 2ea362da080..041cba7a2dc 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Reflection-Probes-Intro.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Reflection-Probes-Intro.md @@ -7,7 +7,7 @@ The High Definition Render Pipeline (HDRP) allows you to use two different Refle - [Reflection Probes](Reflection-Probe.md) captures a view of its surroundings in all directions and stores the result as a cubemap, similar to the Reflection Probe in built-in render pipeline. - [Planar Reflection Probes](Planar-Reflection-Probe.md) captures a view in a direction calculated from a reflection of the Camera’s position and rotation, then stores the result in a 2D RenderTexture. By default, the reflected Camera calculates its field of view by setting the center of its projection to the Probe’s **Mirror Position**, and then expands it until it includes the Probe’s **Influence Volume**, as shown here: - + For more information about how to use the reflection probe, see [Use reflection probes](Reflection-Probe-Usage.md). diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Render-Pipeline-Wizard.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Render-Pipeline-Wizard.md index 608cfa21aa8..f39f5927414 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Render-Pipeline-Wizard.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Render-Pipeline-Wizard.md @@ -32,10 +32,8 @@ Each configuration is separated into two scopes: - **Global:** Changes the configuration settings in the Unity Editor, [HDRP graphics settings](Default-Settings-Window.md), or [HDRP Asset](HDRP-Asset.md) - **Current Quality:** Changes the configuration settings in the [HDRP Asset](HDRP-Asset.md) set in [Quality settings](quality-settings.md). If no asset is assigned in the **Quality** settings, this mode uses the [HDRP Asset](HDRP-Asset.md) set in the [Graphics settings window](Default-Settings-Window.md). - - ### HDRP - + This section provides you with configuration options to help you make your Unity Project use HDRP.  @@ -62,10 +60,8 @@ This section provides you with configuration options to help you make your Unity | **Assigned - Quality** | Checks to make sure you have assigned either an [HDRP Asset](HDRP-Asset.md) or null to the **Quality Settings** field corresponding to the currently used quality (menu: **Edit** > **Project Settings** > **Quality**).
If the value is null, all **Current Quality** related configuration will be the one from the [HDRP Asset](HDRP-Asset.md) used in **Global**.
Select the **Fix** button to nullify the field. | | **SRP Batcher** | Checks to make sure that [Scriptable Render Pipeline Batcher](xref:um-srp-batcher) is enabled.
Select the **Fix** button to enable it in the used HDRP Asset. | - - ### HDRP + VR - + This section provides extra configuration options to help you set up your HDRP Project to support virtual reality. If you can't find an option in this section of the documentation, refer to the [HDRP section](#HDRPTab) options. This is only supported on Windows OS. You can adjust the extra configuration options in the **Global** scope.  @@ -107,10 +103,8 @@ This section provides extra configuration options to help you set up your HDRP P - - ### HDRP + DXR - + This section provides extra configuration options to help you set up your HDRP Project to support ray tracing. If you can't find an option in this section of the documentation, refer to the [HDRP tab](#HDRPTab) options. This is only supported on Windows OS.  diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Rendering-Layers.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Rendering-Layers.md index b1a2d7f9475..20ccc91d1ea 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Rendering-Layers.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Rendering-Layers.md @@ -5,7 +5,7 @@ The High Definition Render Pipeline (HDRP) allows you to use Rendering Layers, w A Renderer can support up to 32 rendering layers, but all HDRP effects using Rendering Layers only support the first 16 layers. On the image below, you can see usage of Rendering Layers with Lights to only affect some of the meshes. - + Rendering Layers are also supported on decal projectors, and can be sampled from the ShaderGraph to implement custom effects. @@ -63,17 +63,15 @@ By default, in the UI for Lights, Decals, Mesh Renderers or Terrain, Rendering L Using [cookies](https://docs.unity3d.com/Manual/Cookies.html) for light fixtures can sometimes have a negative visual effect on a bulb, such as self-shadowing or transmission contribution. You can use Light Layers to make a bulb Mesh not receive any light from the Light’s cookie, and instead receive light from a separate small Point Light. +
The Light cookie incorrectly affects the transmission of this bulb’s geometry. - - +
Assigning the bulb’s Mesh Renderer to a specific Rendering Layer means that the Light cookie no longer affects the bulb’s Mesh Renderer. - - +
To restore the transmission effect, create a Point Light and assign it to the same Rendering Layer as the bulb’s Mesh Renderer. Now this Point Light only affects the bulb’s Mesh Renderer and does not contribute to the rest of the Scene Lighting. - For more information on this process, see Pierre Donzallaz’s [expert guide](https://pydonzallaz.files.wordpress.com/2019/02/create-high-quality-light-fixtures-in-unity.pdf) on creating high quality light fixtures in Unity. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Shadows-in-HDRP.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Shadows-in-HDRP.md index a3f7322ff12..3488bc431bb 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Shadows-in-HDRP.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Shadows-in-HDRP.md @@ -72,9 +72,7 @@ In HDRP, each individual Light component controls its own shadow biasing using t - **Slope-Scale Depth Bias** - **Normal Bias** -Find these settings under the **Shadows** section. If some property fields are missing, enable [additional properties](expose-all-additional-properties.md) to display them. For details on how each property controls the shadow biasing, see the [Light documentation](Light-Component.md). - - +Find these settings under the **Shadows** section in the **Light** Inspector. If some property fields are missing, enable [additional properties](expose-all-additional-properties.md) to display them. For details on how each property controls the shadow biasing, see the [Light documentation](Light-Component.md). Using high shadow bias values may result in light "leaking" through Meshes. This is where there is a visible gap between the shadow and its caster and leads to shadow shapes that don't accurately represent their casters. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Stencil-Usage.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Stencil-Usage.md index caf23eddd1e..5d11da1e02d 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/Stencil-Usage.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/Stencil-Usage.md @@ -8,8 +8,6 @@ HDRP reserves specific bits for features such as subsurface scattering, SSR, rec During HDRP rendering, a "Clear Stencil Buffer" pass occurs just before starting to render transparent objects, and it doesn't modify user bits. The only instance where user bits are cleared is at the start of rendering when the depth buffer is cleared. - - ## Free Stencil Bits Within the stencil buffer during rendering, bits 6 and 7 remain untouched by HDRP code. Any other bits are HDRP reserved and may be cleared or overwritten at any moment during the frame. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/TableOfContents.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/TableOfContents.md index 97c93cbd8ec..d6ddc9f63a7 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/TableOfContents.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/TableOfContents.md @@ -198,7 +198,6 @@ * [Create a local fog effect](create-a-local-fog-effect.md) * [Create a Fog Volume shader](create-a-fog-volume-shader.md) * [Volumetric fog samples](VolumetricSamplesDescriptions.md) - * [Set up a volumetric sample scene](set-up-the-volumetric-sample-scene.md) * [Troubleshoot fog](troubleshoot-fog.md) * [Water](water.md) * [Use the water system in your Project](water-use-the-water-system-in-your-project.md) @@ -239,7 +238,7 @@ * [Use the Rendering Debugger](use-the-rendering-debugger.md) * [Add controls to the Rendering Debugger](add-controls-to-the-rendering-debugger.md) * [Rendering and post-processing](rendering-and-post-processing.md) - * [Understand execution order](rendering-execution-order.md) + * [Execution order reference](rendering-execution-order.md) * [Understand post-processing](Post-Processing-Main.md) * [Anti-aliasing](Anti-Aliasing.md) * [Dynamic resolution](Dynamic-Resolution.md) @@ -308,7 +307,6 @@ * [Customize the High Definition Render Pipeline (HDRP)](render-graph.md) * [Test and debug rendering and post-processing](rendering-troubleshoot.md) * [Troubleshoot a custom pass](Custom-Pass-Troubleshooting.md) - * [View a custom pass in the Frame Debugger](Custom-Pass-Frame-Debugger.md) * [Troubleshoot a custom post-processing effect](rendering-troubleshoot-custom-post-processes.md) * [Understand and fix Not a Number (NAN) and Infinite (Inf) values](Post-Processing-Propagating-NaNs.md) * [Known issues](Known-Issues.md) diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/VolumetricSamplesDescriptions.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/VolumetricSamplesDescriptions.md index fbb5ce8fa2e..a6968047ec8 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/VolumetricSamplesDescriptions.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/VolumetricSamplesDescriptions.md @@ -5,7 +5,7 @@ in Unity to enhance your fog effects with **3D Textures** or **Shader Graphs**. It also covers various blending modes and quality settings to optimize the visual quality and performance of your fog effects. - + Learn how to configure the Local Volumetric Fog component, use different blending modes, and explore a variety of sample effects like 3D texture masks, @@ -27,6 +27,8 @@ issue, you can keep the **Screen Resolution Percentage** low as a tradeoff. ## Sample effects +To set up a volumetric sample scene, select **Window** > **Package manager** > **High Definition RP** > **Samples**, then import **Volumetric Samples**. Each sample is a prefab in the `Assets/Samples/High Definition RP/[HDRP version number]/Volumetric samples` folder. + ### 3D texture mask This Local Volumetric Fog uses the **Texture Mask Mode**. It requires a **3D diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/add-swell-agitation-or-ripples.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/add-swell-agitation-or-ripples.md index fd359130751..3de9df3ba50 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/add-swell-agitation-or-ripples.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/add-swell-agitation-or-ripples.md @@ -23,18 +23,8 @@ To add a Water Mask: 1. In the Water Volume Inspector window, drag the texture to the **Water Mask** property. -
-
- |
-
-
- |
-
| -In this example, the red channel has a gradient that reduces the first and second simulation bands. The noise on the green channel reduces ripples. For more information, refer to the Water Mask property description. - | -|
•**Texture**: Applies a 3D texture to the fog volume.
•**Material**: Applies a Material to the fog which updates every frame. You can use this to create dynamic fog effects. | | **Blending Mode** | Determines how this fog volume blends with existing fog in the scene:
•**Overwrite**: Replaces existing fog in the volume area with this fog volume.
•**Additive**: Adds the color and density of this fog volume to other fog in the scene. This is the default value.
•**Multiply**: Multiplies the color and density of this fog volume with other fog in the scene. You can use this to create effects relative to a specific fog density.
•**Min**: Determines the minimum density value of this fog volume and the scene fog inside its bounding box. For example, a value of 0 appears to remove fog in a certain area.
•**Max**: Determines the maximum density value of this fog volume and the scene fog inside its bounding box.
| | **Priority** | Determined the order in which HDRP blends fog volumes. HDRP renders the lowest priority volume first and the highest priority last. | +| **Scale Mode** | Specifies the scaling mode to apply to the Local Volumetric Fog Volume. Invariant uses only the size of the volume. Inherit From Hierarchy multiplies the size and the transform scale. | | **Size** | Controls the dimensions of the Volume. | | **Per Axis Control** | Controls the blend distance based on each axis. | | **Blend Distance** | Blend Distance fades from this fog volume's level to the fog level outside it.
This value indicates the absolute distance from the edge of the Volume bounds, defined by the Size property, where the fade starts.
Unity clamps this value between 0 and half of the lowest axis value in the Size property.
If you use the **Normal** tab, you can alter a single float value named Blend Distance, which gives a uniform fade in every direction. If you open the **Advanced** tab, you can use two fades per axis, one for each direction. For example, on the X-axis you could have one for left-to-right and one for right-to-left.
A value of 0 hides the fade, and a value of 1 creates a fade. | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/path-tracing-limitations.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/path-tracing-limitations.md index cc773124a4f..17b6a069939 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/path-tracing-limitations.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/path-tracing-limitations.md @@ -24,6 +24,7 @@ HDRP path tracing in Unity currently has the following limitations: - MSAA. - [Graphics.DrawMesh](https://docs.unity3d.com/ScriptReference/Graphics.DrawMesh.html) or [Graphics.RenderMesh](https://docs.unity3d.com/2022.1/Documentation/ScriptReference/Graphics.RenderMesh.html), because rasterization and ray tracing are different ways of generating an image. - [Streaming Virtual Texturing](https://docs.unity3d.com/Documentation/Manual/svt-streaming-virtual-texturing.html). + - Vertex animation, for example wind deformation of vegetation. ### Unsupported shader graph nodes for path tracing diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-adjustment-volume-component-reference.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-adjustment-volume-component-reference.md index c9c660983f7..2e5421e7e5a 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-adjustment-volume-component-reference.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-adjustment-volume-component-reference.md @@ -6,93 +6,18 @@ Refer to the following for more information about using the Probe Adjustment Vol - [Fix issues with Adaptive Probe Volumes](probevolumes-fixissues.md) -
| Property | -Description | -|
|---|---|---|
| Influence Volume | -||
| Shape | -Set the shape of the Adjustment Volume to either Box or Sphere. | -|
| Size | -Set the size of the Adjustment Volume. This property only appears if you set Shape to Box. | -|
| Radius | -Set the radius of the Adjustment Volume. This property only appears if you set Shape to Sphere. | -|
| Mode | -
- Select how to override probes inside the Adjustment Volume. -
|
- |
| Dilation Validity Threshold | -
- Override the ratio of backfaces a probe samples before HDRP considers it invalid. This option only appears if you set Mode to Override Validity Threshold, and you enable Additional Properties. - |
- |
| Virtual Offset Rotation | -
- Set the rotation angle for the Virtual Offset vector on all probes in the Adjustment Volume. This option only appears if you set Mode to Apply Virtual Offset. - |
- |
| Virtual Offset Distance | -
- Set how far HDRP pushes probes along the Virtual Offset Rotation vector. This option only appears if you set Mode to Apply Virtual Offset. - |
- |
| Geometry Bias | -
- Sets how far HDRP pushes a probe's capture point out of geometry after one of its sampling rays hits geometry. This option only appears if you set Mode to Override Virtual Offset Settings. - |
- |
| Ray Origin Bias | -Override the distance between a probe's center and the point HDRP uses to determine the origin of that probe's sampling ray. This can be used to push rays beyond nearby geometry if the geometry causes issues. This option appears only if you set Mode to Override Virtual Offset Settings. - |
- |
| Intensity Scale | -
- Change the brightness of all probes covered by the Probe Volumes Adjustment Volume component. Use this sparingly, because changing the intensity of probe data can lead to inconsistencies in the lighting. This option only appears if you set Mode to Intensity Scale. - |
- |
| Preview Probe Adjustments | -
- Preview the effect of the adjustments in the Scene view and the Rendering Debugger. - |
- |
| Bake Probe Volumes | -
- Bake the Adaptive Probe Volumes with the adjustments. - |
- |
- **Shape**: Set the shape of the Adjustment Volume to either **Box** or **Sphere**.
- **Size**: Set the size of the Adjustment Volume. This property only appears if you set **Shape** to **Box**.
- **Radius**: Set the radius of the Adjustment Volume. This property only appears if you set **Shape** to **Sphere**.
- **Invalidate Probes:** Mark selected probes as invalid. Refer to [How light probe validity works](probevolumes-fixissues.md#how-light-probe-validity-works) for more information.
- **Override Validity Threshold:** Override the threshold HDRP uses to determine whether Light Probes are marked as invalid. Refer to [Adjust Dilation](probevolumes-fixissues.md#adjust-dilation) for more information.
- **Apply Virtual Offset:** Change the position Light Probes use when sampling the lighting in the scene during baking. Refer to [Adjust Virtual Offset](probevolumes-fixissues.md#adjust-virtual-offset) for more information.
- **Override Virtual Offset Settings:** Override the biases HDRP uses during baking to determine when Light Probes use Virtual Offset, and calculate sampling positions. Refer to [Adjust Virtual Offset](probevolumes-fixissues.md#adjust-virtual-offset) for more information.
- **Intensity Scale:** Override the intensity of probes to brighten or darken affected areas.
- **Override Sky Direction:** Override the directions Unity uses to sample the ambient probe, if you enable [sky occlusion](probevolumes-skyocclusion.md).
- **Override Sample Count:** Override the number of samples Unity uses for Adaptive Probe Volumes.
+
The car model is made up of separate GameObjects. The left scene uses Light Probe Groups, which use per-object lighting, so each part of the car samples a single blended probe value. The right scene uses Adaptive Probe Volumes, which use per-pixel lighting, so each part of the car samples its nearest probes. This image uses the ArchVizPRO Photostudio HDRP asset from the Unity Asset Store. 
diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-fixissues.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-fixissues.md index 16eee27c819..90766a7a973 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-fixissues.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-fixissues.md @@ -14,11 +14,11 @@ HDRP uses the following techniques to minimise incorrect lighting data from Ligh You can check which Light Probes are invalid using the [Rendering Debugger](rendering-debugger-window-reference.md#ProbeVolume). -
-In the Scene on the left, Virtual Offset isn't active and dark bands are visible. In the Scene on the right, Virtual Offset is active. +
+In the scene on the left, Virtual Offset isn't active so dark bands are visible. In the scene on the right, Virtual Offset is active so there are no dark bands. -
-In the Scene on the left, Dilation isn't active and some areas are too dark. In the Scene on the right, Dilation is active. +
+In the scene on the left, Dilation isn't active so some areas are too dark. In the scene on the right, Dilation is active so the areas are no longer dark. ## Fix dark blotches or streaks @@ -39,7 +39,7 @@ You can also disable Virtual Offset for a Baking Set. Virtual Offset only affect ### Adjust Dilation -You can configure **Probe Dilation Settings** in the [Adaptive Probe Volumes panel](probevolumes-lighting-panel-reference.md) in the Lighting window). This changes how HDRP calculates the validity of Light Probes, and how invalid Light Probes use lighting data from nearby valid Light Probes. +You can configure **Probe Dilation Settings** in the [Adaptive Probe Volumes panel](probevolumes-lighting-panel-reference.md) in the Lighting window. This changes how HDRP calculates the validity of Light Probes, and how invalid Light Probes use lighting data from nearby valid Light Probes. You can adjust the following: @@ -56,9 +56,8 @@ You can also disable Dilation for a Baking Set. Dilation only affects baking tim Light leaks are areas that are too light or dark, often in the corners of a wall or ceiling. -
-A light leak. -
+
+A wall with light leaks, where one side of the wall is too light and one side of the wall is too dark. Light leaks often occur when geometry receives light from a Light Probe that isn't visible to the geometry, for example because the Light Probe is on the other side of a wall. Adaptive Probe Volumes use regular grids of Light Probes, so Light Probes might not follow walls or be at the boundary between different lighting areas. @@ -151,9 +150,8 @@ Refer to [Probe Adjustment Volume component reference](probevolumes-adjustment-v Seams are artefacts that appear when one lighting condition transitions immediately into another. Seams are caused when two adjacent bricks have different Light Probe densities. Refer to [bricks](probevolumes-concept.md#how-probe-volumes-work) for more information. -
-Two seams. -
+
+Two seams on a wall which show the sharp changes in lighting conditions between light and dark. URP fixes seams automatically. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-skyocclusion.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-skyocclusion.md index 0124c58c3b5..dfd4a3bc593 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-skyocclusion.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-skyocclusion.md @@ -15,6 +15,12 @@ At runtime, when a static or dynamic GameObject samples an Adaptive Probe Volume - A sky color from the ambient probe, which updates when the sky color changes. - The sky occlusion value, which is static. +## Limitations + +When Unity calculates sky occlusion values, Unity treats the surfaces of GameObjects as opaque and a gray color. As a result, transparent or translucent GameObjects like windows or leaves bounce light away instead of transmitting it through. Also, dark-colored walls reflect the same amount of light as light-colored walls. To minimize lighting issues, disable **Contribute GI** in the [**Static Editor Flags** property](xref:um-static-objects) for transparent or translucent GameObjects. + +To override the gray color Unity uses, go to **Sky Occlusion Settings** in the [Adaptive Probe Volumes panel](probevolumes-lighting-panel-reference.html#sky-occlusion-settings) and adjust **Albedo Override**. + ## Enable sky occlusion First, enable the GPU lightmapper. Unity doesn't support sky occlusion if you use **Progressive CPU** instead. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-streaming.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-streaming.md index ece305d9a54..bbdfa985b21 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-streaming.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/probevolumes-streaming.md @@ -32,7 +32,7 @@ The smallest section HDRP loads and uses is a cell, which is the same size as th To view the cells in an Adaptive Probe Volume, or debug streaming, use the [Rendering Debugger](rendering-debugger-window-reference.md#probe-volume-panel). -
+
The Rendering Debugger with **Display Cells** enabled. ## Load APV data from AssetBundles or Addressables diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/raytracing-troubleshooting.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/raytracing-troubleshooting.md index 6e79d2e5e05..4cc87068da3 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/raytracing-troubleshooting.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/raytracing-troubleshooting.md @@ -44,8 +44,8 @@ You might notice the following symptoms when shadows from directional lights are - The lighting feels flat or unrealistic, especially in large outdoor scenes with sunlight. ### Cause @@ -69,8 +69,8 @@ The following symptoms indicate missing shadows from punctual lights: - Light leaks occur in areas where shadows are meant to be cast by nearby objects. ### Cause @@ -126,8 +126,8 @@ The following symptoms might occur when an indirect specular light leaks: - Reflections seem disconnected from nearby objects or appear out of place. ### Cause @@ -176,9 +176,9 @@ The following symptoms can indicate indirect diffuse light leaks: ### Cause @@ -207,9 +207,9 @@ Fog light leaks have the following symptoms: ### Cause diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/reference-screen-space-reflection.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/reference-screen-space-reflection.md index febbc9ce467..51359e00b8d 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/reference-screen-space-reflection.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/reference-screen-space-reflection.md @@ -2,6 +2,11 @@ [!include[](snippets/Volume-Override-Enable-Properties.md)] +For more information, refer to the following: + +- [Use the screen space reflection (SSR) override](override-screen-space-reflection.md) +- [Understand reflection in HDRP](reflection-understand.md) + ### Screen-space | **Property** | **Description** | diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/refraction-models.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/refraction-models.md index 27f67be8952..d11b075b2e2 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/refraction-models.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/refraction-models.md @@ -11,7 +11,7 @@ If you use this model, HDRP does the following [during the refraction process](O 2. HDRP uses a sphere to approximate the object's shape, and the diameter of the sphere to determine how far the light travels inside. 3. When the light leaves the object, HDRP uses the sphere's surface normal as part of calculating the second refraction. This determines how much the light bends back. -
+
How HDRP calculates the refracted light for three example pixels, if you use a **Refraction Thickness Map** to set different widths for different pixels on an object. The solid orange lines are vectors that represent the direction of light from the camera to a pixel. The white circles represent spheres that approximate the object's thickness. The solid blue lines are surface normals. To control the diameter of the spheres: @@ -21,10 +21,10 @@ To control the diameter of the spheres: If you use the sphere refraction model with a spherical object, the Scene you see through the object might be upside-down. -
+
The light rays bend a lot when they exit the object, so they cross over and hit the opposite end of the tree. -
+
The view through a refractive sphere is upside-down. ## Planar refraction model @@ -42,7 +42,7 @@ If you use this model, HDRP does the following [during the refraction process](O 2. HDRP uses a parallel plane to approximate the exit surface (this is a 'planar projection'), and the distance between the object's surface and the plane to determine how far the light travels inside. 3. When the light leaves the object, HDRP bends the light back so it has the same direction as the light that entered the object. -
+
How HDRP calculates the refracted light for three example pixels, if you use a **Refraction Thickness Map** to set different widths for different pixels on an object. The solid orange lines are vectors that represent the direction of light from the camera to a pixel. The dotted blue lines represent parallel planes approximating the object's thickness. The solid blue lines are surface normals. To control the distance between the planes: @@ -52,10 +52,10 @@ To control the distance between the planes: Set the thickness to the approximate width of the object. The bigger the width, the more visible the refraction effect. -
+
With a thicker object, the light is offset by a greater amount. -
+
Objects with increasing thickness, showing how the light is increasingly deformed. ## Thin refraction model diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-and-post-processing.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-and-post-processing.md index e5bd1fced6f..b2e7215b017 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-and-post-processing.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-and-post-processing.md @@ -4,7 +4,7 @@ Control how the High Definition Render Pipeline (HDRP) renders a scene and apply |Page|Description| |-|-| -|[Understand execution order](rendering-execution-order.md)|Learn the order in which HDRP executes render passes.| +|[Execution order reference](rendering-execution-order.md)|Learn the order in which HDRP executes render passes.| |[Understand post-processing](Post-Processing-Main.md)|Learn how HDRP performs post-processing.| |[Anti-aliasing](Anti-Aliasing.md)|Use an antialiasing method to reduce the appearance of jagged edges.| |[Dynamic resolution](Dynamic-Resolution.md)|Change the screen resolution automatically to maintain a stable frame rate.| diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-debugger-window-reference.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-debugger-window-reference.md index 7cd61d6725d..0b3bb1b5be1 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-debugger-window-reference.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-debugger-window-reference.md @@ -648,12 +648,15 @@ The **Color monitors** are a set of industry-standard monitors to help artists c | **Size** | The size ratio of the color monitors. | | **Property** | **Description** | -| ----------------- | ------------------------------------------------------------ | -| **Clear Render Targets at creation** | Enable the checkbox to make the Render Graph system clear render targets the first time it uses them | -| **Disable Pass Culling** | Enable the checkbox to render passes which have no impact on the final render. | -| **Immediate Mode** | Enable the checkbox to make the Render Graph system evaluate passes immediately after it creates them. | -| **Log Frame Information** | Press the button to log in the Console informations about the passes rendered during a frame. | -| **Log Resources** | Press the button to log in the Console the list of resources used when rendering a frame. | +| --- | --- | +| **Clear Render Targets At Creation** | Clears render textures the first time the render graph system uses them. | +| **Clear Render Targets When Freed** | Clears render textures when they're no longer used by render graph. | +| **Disable Pass Culling** | Disables HDRP culling render passes that have no impact on the final render. | +| **Disable Pass Merging** | Disables HDRP merging render passes. | +| **Immediate Mode** | Enables the render graph system evaluating passes immediately after it creates them. | +| **Enable Logging** | Enables logging to the **Console** window. | +| **Log Frame Information** | Logs how HDRP uses the resources during the frame, in the **Console** window. | +| **Log Resources** | Logs the resources HDRP uses during the frame, in the **Console** window. | The **NVIDIA device debug view** is a panel that displays a list of the current feature states of NVIDIA Deep Learning Super Sampling (DLSS). Each row represents an active screen in which DLSS is running. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-execution-order.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-execution-order.md index bb94eb05881..8f4f69374de 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-execution-order.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-execution-order.md @@ -1,35 +1,135 @@ -# Understand execution order +# Execution order reference -The following diagram shows the order in which the High Definition Render Pipeline (HDRP) executes render passes. +The High Definition Render Pipeline (HDRP) executes render passes using the following stages: -For more information about injection points, refer to [injection points](Custom-Pass-Injection-Points.md). +1. Prepass +2. Prepare LightLoop data +3. Opaque and sky +4. Transparent +5. Post-processing +6. Overlay gizmos - +## Prepass stage + +HDRP executes the prepass stage in the following order: + +1. Before Rendering - custom pass injection point +2. Prepass - depth, normal/smoothness, motion vectors +3. PreRenderSky/Cloud +4. DBuffer - no emissive decal +5. GBuffer +6. After Depth and Normal - custom pass injection point +7. Depth pyramid +8. Camera motion vectors + +## Prepare Lightloop data stage + +1. Shadows or cached shadows, or an [optional async pass](#optional-async-stage) +2. Screen space shadows +3. Generate MaxZPass + + +### Optional async pass + +The optional async pass calculates the following: + +- Lights list +- Screen space ambient occlusion (SSAO) +- Contact shadows +- Volume voxelization +- Screen space reflections (SSR) +- Screen space global illumination (SSGI) + +### Opaque and sky stage + +HDRP executes the opaque and sky stage in the following order: + +1. Deferred lighting +2. Forward opaques +3. Decal emissive +4. Subsurface scattering +5. Sky +6. After Opaque and Sky - custom pass injection point +7. After Opaque and Sky - custom post-processing injection point + +### Transparents stage + +HDRP executes the transparents stage in the following order: + +1. Clear stencil +2. Pre-refraction transparent depth prepass +3. Water G-buffer +4. Waterline +5. Transparent depth prepass +6. Volumetric lighting +7. Fog +8. Clouds +9. High Quality Line Rendering +10. Screen space reflections (SSR) +11. Before PreRefraction - custom pass injection point +12. Transparent pre-refraction +13. Water lighting +14. Color pyramid pre-refraction +15. Screen space multiple scattering (SSMS) +16. Before Transparent - custom pass injection point +17. Transparents +18. Low-resolution transparents +19. Combine transparents +20. Transparent PostPass +21. Transparent UI: HDR output + +## Post-processing stage + +HDRP executes the post-processing stage in the following order: + +1. Color pyramid distortion +2. Distortion +3. Before Post Process - custom pass injection point +4. After Post Process Objects +5. Exposure +6. Deep learning super sampling (DLSS) upsample - before Post +7. Before Temporal anti-aliasing (TAA) - custom post-processing injection point +8. TAA or subpixel morphological anti-aliasing (SMAA) +9. Before Postprocess - custom post-processing injection point +10. Depth of field +11. DLSS upsample - After depth of field +12. Motion blur +13. After Post Process Blurs - custom post-processing injection point +14. Panini projection +15. Lens Flare (SRP) +16. Bloom +17. Uber pass - color grading, lens distortion, chromatic effect, vignette, composite +18. After Post Process - custom post-processing injection point +19. DLSS upsample - After Post +20. Final - grain, dithering, composite, fast approximate anti-aliasing (FXAA) +21. After Post Process - custom post-processing injection point ## Post-processing effect execution order The post-processing system in HDRP applies post-processing effects in a specific order. The system also combines some effects into the same compute shader stack to minimize the number of passes. -### Execution order and effect grouping - HDRP executes post processing effects in the following order, from top to bottom. -| Post-processing passes | Compute shader stack | Final post-processing pass | -| -------------------------------------------------- | --------------------- | -------------------------- | -| NaN Killer | | | -| Anti-aliasing (TAA, SMAA) | | | -| Depth of Field | | | -| Motion Blur | | | -| Panini Projection | | | -| Bloom (Pyramid) | | | -| Color Grading (LUT Baking) | | | -| Screen Space Lens Flare (written in bloom texture) | | | -| Data driven lens flare | | | -| | Lens Distortion | | -| | Chromatic Aberration | | -| | Bloom (Apply) | | -| | Vignette | | -| | Color Grading (Apply) | | -| | | Antialiasing (FXAA) | -| | | Film Grain | -| | | 8-bit Dithering | +| **Effect** | **Execution order** | +|-|-| +| NaN remover | Post-processing pass | +| Anti-aliasing - TAA, SMAA | Post-processing pass | +| Depth of field | Post-processing pass | +| Motion blur | Post-processing pass | +| Panini projection | Post-processing pass | +| Bloom - pyramid | Post-processing pass | +| Color grading - look up table (LUT) baking | Post-processing pass | +| Screen space lens flare, written in bloom texture | Post-processing pass | +| Lens flare (SRP) | Post-processing pass | +| Lens distortion | Compute shader stack | +| Chromatic aberration | Compute shader stack | +| Apply bloom | Compute shader stack | +| Vignette | Compute shader stack | +| Apply color grading | Compute shader stack | +| Anti-aliasing - FXAA | Final post-processing pass | +| Film grain | Final post-processing pass | +| 8-bit dithering | Final post-processing pass | + +## Additional resources + +- [Injection points](Custom-Pass-Injection-Points.md) diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-troubleshoot.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-troubleshoot.md index 819a6af902a..0016702a76d 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-troubleshoot.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/rendering-troubleshoot.md @@ -5,8 +5,10 @@ Identify and fix common problems with rendering, post-processing and custom pass | Page | Description | |-|-| |[Troubleshoot a Custom Pass](Custom-Pass-Troubleshooting.md)|Fix issues with custom pass effects.| -|[View a Custom Pass in the Frame Debugger](Custom-Pass-Frame-Debugger.md)| Use the Frame Debugger to identify issues with a custom pass.| |[Troubleshoot a custom post-processing effect](rendering-troubleshoot-custom-post-processes.md)|Fix issues with custom post-processing effects.| |[Understand and fix Not a Number (NAN) and Infinite (Inf) values](Post-Processing-Propagating-NaNs.md)|Learn how to identify and remove spreading NAN and Inf values.| |[Known issues](Known-Issues.md)|Fix problems you might have with material array size and local HDRP config packages.| +## Additional resources + +- [Check or find a rendering event](xref:frame-debugger-window-event-hierarchy) diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/set-up-a-volume.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/set-up-a-volume.md index e264f54f8cc..5b587880ef8 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/set-up-a-volume.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/set-up-a-volume.md @@ -37,7 +37,7 @@ To add a volume to your scene and edit its Volume Profile, follow these steps: 2. In the **Scene** or **Hierarchy** view, select the new GameObject to view it in the Inspector. 3. In the **Volume** component, assign a Volume Profile asset. To create a new Volume Profile, select **New**. -The list of Volume Overrides that the Volume Profile contains appears below the Volume Profile asset. You can add or remove Volume Overrides and edit their properties. Refer to [Volume Overrides](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@17.0/manual/VolumeOverrides.html) for more information about changing the Volume Overrides and properties. +The list of Volume Overrides that the Volume Profile contains appears below the Volume Profile asset. You can add or remove Volume Overrides and edit their properties. Refer to [Volume Overrides](https://docs.unity3d.com/Manual/urp/VolumeOverrides.html) for more information about changing the Volume Overrides and properties. ### Example: Create a local post-processing effect diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/set-up-the-volumetric-sample-scene.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/set-up-the-volumetric-sample-scene.md deleted file mode 100644 index dc46b019537..00000000000 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/set-up-the-volumetric-sample-scene.md +++ /dev/null @@ -1,47 +0,0 @@ -# Set up a volumetric sample scene - -1. Select **Window** > **Package manager**. - -1. In the **Package manager** window, select **High Definition RP**. - -1. In the **Samples** tab, import the **Volumetric Samples**. - -1. In the **Project** window, go to **Assets** > **Samples** > **High Definition RP** > HDRP version number > **Volumetric samples** > **Scenes.** - -1. Select the **Volumetric Samples scene.** - -1. Go to **Assets** > **Samples** > **High Definition RP** > HDRP version number > **Volumetric sample**s > **Prefabs**. - -1. Drag one of the following sample prefabs in your scene: - - - -**3D Texture Mask Sample** - - - -**About Blending Modes** - - - -**Cloudy Sample** - - - -**Foggy Orb and Light Sample** - - - -**Fumes Sample** - - - -**Ground Smoke Prefab Sample** - - - -**Procedural Noise Fog Sample** - - - -**Volumetric Heart Sample** diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-caustics-in-the-water-system.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-caustics-in-the-water-system.md index a62595d6c6e..48f3183558e 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-caustics-in-the-water-system.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-caustics-in-the-water-system.md @@ -1,9 +1,6 @@ # Caustics in the water system Caustics are a consequence of light rays refracted or reflected by a curved surface and projected onto another object. -## Opacity -Water that is opaque or partially opaque due to particulates does not refract light as much as clear water. This is because water full of mud (for example) absorbs more light than it refracts. In the context of HDRP, this means that water with a lower **Absorption Distance** value has caustics that are less visible. - ## Wave size HDRP uses the **Ripples** **Simulation Band** for **Caustics** calculations by default if the **Ripples** band is active. If you wish to base caustics on larger waves in a **River** or **Ocean, Sea, or Lake** water surface, you need to adjust the **Simulation Band** setting. It may also be necessary to adjust the **Virtual Plane Distance** to ensure a plausible result. To prevent aliasing artifacts, you can increase the **Caustics Resolution**. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-create-a-current-in-the-water-system.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-create-a-current-in-the-water-system.md index 20bb6a6f6be..2576ed4ca3e 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-create-a-current-in-the-water-system.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-create-a-current-in-the-water-system.md @@ -13,7 +13,7 @@ HDRP includes the River sample scene which shows how a current map behaves. To open the River sample scene: -1. Go to **Window** > **Package Manager**. +1. Go to **Window** > **Package Management** > **Package Manager**. 2. Select **High Definition RP**. 3. In the Samples tab, import the **Environment Samples**. 4. Open the scene named **River**. diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-debug-mode.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-debug-mode.md index 4afccf381bc..3ec9bfecdfb 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-debug-mode.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-debug-mode.md @@ -8,33 +8,33 @@ The Water Mask mode displays the reduction of each simulation band. White means You can select which channel of the water mask to debug by using the **Water Mask Mode** dropdown. Note that, for saving texture space, the red channel always attenuate the first band (First swell band for oceans, Agitation for rivers, Ripples for pools), green channel, the second band (Second swell band for oceans, ripples for rivers)... etc - + ## Simulation Foam Mask The Simulation Foam Mask mode shows where the simulation foam is rendered on your water surface. - + ## Current The Current mode shows in which direction the current flows. You can select between swell or agitation and ripples to debug. Note that this mode does not take into account the chaos parameter set in the simulation section. - + ## Deformation The Deformation mode shows the deformation area and the deformation height of the water surface. - + ## Foam The Foam mode shows the foam are and where the generated foam (both foam from foam generated and simulation foam) are rendered. You can select to show Surface Foam or Deep Foam using the **Water Foam Mode**. - + diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-underwater-view.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-underwater-view.md index f00854334d4..15a2b1762af 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-underwater-view.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/water-underwater-view.md @@ -6,9 +6,21 @@ The underwater view is rendered as a full-screen post-processing effect. The vie * If volumetric fog is enabled, the underwater view is included in the volumetric buffer and rendered using volumetric lighting, supporting light shafts and light shafts from shadows. -To view non-infinite water surfaces from underwater, you have to specify a [collider](https://docs.unity3d.com/Manual/Glossary.html#Collider). You can either use the box collider HDRP automatically provides or select a box collider in the scene to use for this purpose. +## Define the underwater area -To view infinite water surfaces from underwater, you have to specify a **Volume Depth**. The **Volume Depth** property is only available in Ocean water body types, so this feature is limited to underwater views of infinite Ocean surfaces. +To change the area where the camera displays an underwater view for a non-infinite water surface, use the **Volume Bounds** setting. Follow these steps: + +1. Create a GameObject with a collider component, for example a cube with a **Box Collider** component. +2. Place the GameObject where you want the underwater view to be visible. +3. In the collider component, select **Edit Collider** to set the size of the visible underwater area. +4. Select the water GameObject. +5. In the **Inspector** window, under **Appearance**, under **Underwater**, set **Volume Bounds** to the GameObject you created. + +To set the area of the underwater view for an ocean, follow these steps: + +1. Select the ocean GameObject. +2. In the **Inspector** window, under **Appearance**, enable **Underwater**. +3. Adjust **Volume Depth**. # Water line diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/whats-new-12.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/whats-new-12.md index edb08ee45b1..9f905a6d002 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/whats-new-12.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/whats-new-12.md @@ -25,7 +25,7 @@ You can use this Vertex Block to create an additional velocity for procedural ge ### Cloud Layer System - + HDRP 12.0 introduces a cloud system that you can control through the volume framework. @@ -37,28 +37,24 @@ For detailed steps on how to create custom clouds in your scene, see [creating c HDRP now includes a Volumetric Clouds volume override which allows you to precisely control the cloud coverage in your scene. These clouds receive realistic lighting from the sun and sky. For more information, see the [Volumetric Clouds](create-realistic-clouds-volumetric-clouds.md) documentation. - + - + ### Lens Flares - + HDRP 12.0 includes a new Lens Flare system. You can attach a Lens Flare (SRP) component to any GameObject. Some Lens Flare properties only appear when you attach a Lens Flare (SRP) component to a light. Each Lens Flare has optional multiple elements that you can control individually. HDRP also provides a [new lens flare asset](shared/lens-flare/lens-flare-asset.md) and a [new lens flare component](shared/lens-flare/lens-flare-component.md) that you can attach to any GameObject. -HDRP includes a new Lens Flare sample that uses presets and Textures. You can see an example of the Textures included in this sample in the image below: - - +HDRP includes a new Lens Flare sample that uses presets and Textures. ### Light Anchor From HDRP 12.0, HDRP includes a new [Light Anchor](light-anchor.md) component. You can attach this component to any light to control the light in Main Camera view. - - ### Light List HDRP version 2021.2 includes a new setting in `ShaderConfig.cs` called `FPTLMaxLightCount`. You can use this setting to set the maximum number of lights per tile on the GPU. To increase this value, you must generate a new Shader config project. For information on how to create a new Shader config project, see [HDRP-Config-Package](). @@ -83,7 +79,7 @@ The image below displays the **Temporal Anti-Aliasing (TAA) Upscale** (A) next t For more information, see [Dynamic Resolution](Dynamic-Resolution.md) - + #### NVIDIA’s Deep Learning Super Sampling @@ -113,10 +109,6 @@ To enable **AMD’s FidelityFX Super Resolution**.: - Open the **Default Fallback Upscale Filter** drop down . - Select **FidelityFX Super Resolution**. - - - - ### Mip Bias Support This HDRP version introduces a new setting called **Use Mip Bias.** This setting improves the detail of any upscaling filters you use in your scene. @@ -128,8 +120,6 @@ To enable **Use Mip Bias**: - Expand the **Dynamic resolution** section. - Enable the **Use Mip Bias** checkbox. - - ### ClearFlag HDRP 2021.2 includes the new `ClearFlag.Stencil` function. Use this to clear all flags from a stencil. @@ -138,7 +128,7 @@ From HDRP 2021.2, `ClearFlag.Depth` does not clear stencils. ### Probe Volumes Global Illumination (Experimental) - + HDRP 12.0 introduces an experimental version of the Probe Volume system that creates pre-computed probe-based global illumination. You can use this system to place light probes automatically and create per-pixel lighting. @@ -206,7 +196,7 @@ You can also choose whether to hide or display ### Path tracing improvements - + HDRP’s path tracing now supports more materials: @@ -244,7 +234,7 @@ When you create a custom decal shader in HDRP 12.x, the accumulated normal value ### Decal normal blending - + From HDRP 12.0 you can use a new option in the [HDRP Asset](HDRP-Asset.md) (**Rendering > Decals > Additive Normal Blending**) to additively blend decal normals with the GameObject's normal map. @@ -272,10 +262,10 @@ Improved the quality of the physically-based Depth Of Field in the following way - Improved support for MSAA to remove artifacts around the edges of visible GameObjects. - + ### Physically Based Hair Shader - + HDRP 12.0 includes a new physically-based Marschner hair shader. You can use this as an alternative to the Kajiya-Kay hair shader. This new shading model allows you to quickly create a hair material that fits any lighting scenario. For more information about this new hair shader model and its parameters, see [Hair Master Stack](hair-master-stack-reference.md). @@ -306,8 +296,6 @@ HDRP 12.0 includes a built-in custom pass that you can use to generate Object ID HDRP 12.0 includes a more precise method to calculate specular occlusion based on Ambient Occlusion (AO) and Bent normals. This replaces the old method for all materials and shader graphs. - - ### Ambient Occlusion and Specular Occlusion In HDRP 12.x, the algorithm that calculates how ambient occlusion and specular occlusion contributes to direct lighting doesn’t use the multi-bounce contribution (GTAOMultiBounce). This gives a more accurate direct lighting result. @@ -323,11 +311,11 @@ HDRP 12.0 improves the quality of the [Screen Space Global Illumination (SSGI)]( SSGI off: - + SSGI on: - + ### Ray Traced Global Illumination diff --git a/Packages/com.unity.render-pipelines.high-definition/Documentation~/whats-new-17.md b/Packages/com.unity.render-pipelines.high-definition/Documentation~/whats-new-17.md index 079d59900b3..1c5d5f3b27f 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Documentation~/whats-new-17.md +++ b/Packages/com.unity.render-pipelines.high-definition/Documentation~/whats-new-17.md @@ -8,7 +8,7 @@ This page contains an overview of new features, improvements, and issues resolve Adaptive Probe Volumes can now be enhance with [Sky Occlusion](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/probevolumes-skyocclusion.html) baking. - + This add a way to perform dynamic time of day for exterior with a sun light on top of a static lighting scenario like for interior done with Adaptive Probe Volumes. @@ -17,9 +17,6 @@ This add a way to perform dynamic time of day for exterior with a sun light on t #### Fallback New user interface for upscaler fallbacks. This new user interface will help the user set their preference in case a platform or API does not support such upscaler. - - - #### AMD FidelityFX 2.1 Super Resolution for Windows Support for AMD FidelityFX 2.1 Super Resolution for Dx11, Dx12, Vulkan in any GPU vendor. The upscaler includes predefined upscaling modes and can easily be turned on in the HDRP settings by enabling the com.unity.amd internal package. This feature also includes the plugin and public API for programmability and accessibility of this effect on any scriptable object. @@ -28,13 +25,11 @@ Support for AMD FidelityFX 2.1 Super Resolution for Dx11, Dx12, Vulkan in any GP Support for the Spatial-Temporal Post-Processing (STP) upscaler has been added for all platforms. This upscaler produces higher quality visuals than the existing TAAU upscaler, but it only supports dynamic resolution when the hardware dynamic resolution mode is active. This means APIs such as DX11 are only capable of using STP when the resolution scale is forced to a fixed percentage. - - ### SpeedTree Support of SpeedTree 9 files (.st9) exported by the SpeedTree Modeler application. Speedtree is now compatible with GPU Resident Drawer introduced in this release for improve CPU performance. In addition re-designs the SpeedTreeWind & SpeedTreeWindManager implementations to support multiple SpeedTree wind technologies as well as scalable CPU performance. Performance improvements depends on number of tree instances with wind, a speed up of x5-x10 CPU can be observe on MainThread and RenderThread depends on scenario. - + scene with trees in bright autumn colors.](Images/fantasy_kingdom_environment.jpg) ### Path Tracing @@ -42,13 +37,13 @@ Support of SpeedTree 9 files (.st9) exported by the SpeedTree Modeler applicatio Disc and tube shaped area lights are now supported with path tracing. - + #### Separate Volumetric Fog denoising The HDRP path tracer now offers an option to denoise the volumetric fog effect separately from the full color output. - + ### Performance @@ -58,12 +53,10 @@ GPU Resident Drawer Leveraging the power of the [Batch Render Group API](https:/ The extra GPU Culling functionality built on top of GPU Resident drawer allows for GPU-side culling of instances that do not contribute to the final image. This can help to improve GPU performance in scenes with heavy overdraw, and does not require any additional authoring to try out. With Rendering Debugger integration. - + Enable GPU Resident Drawer and occlusion culling via checkbox on the SRP asset. - - ## Updated ### Adaptive Probe Volumes @@ -78,8 +71,6 @@ A new toggle was also added to the Probe Volume Graphics settings to disable the Planet parametrization for effects like fog, physically based sky and volumetric clouds have been moved to a shared place in the [Visual Environement override](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/visual-environment-volume-override-reference). - - #### Physically Based Sky The Physically Based sky has received a set of improvements and optimizations. @@ -88,33 +79,31 @@ The memory usage for the precomputed tables has also been reduced. Memory and pe Additionally, the PBR sky now includes an ozone layer as part of the atmosphere model. This is especially noticeable when the sun is close to the horizon. - + Finally, aerial perspective can now be enabled to simulate light absorption by particles in the atmosphere when looking at objects in the distance, such as mountains or clouds. - + #### Volumetric clouds The volumetric clouds are not clipped by the far plane anymore. Additionally, earth curvature control was removed as Planet settings are now controlled from the Visual Environement. Local Clouds option is also removed, as far plane clipping does not happen anymore. To preserve the behavior of camera not being able to go inside the clouds, you should now set the **Rendering Space** option in **Camera Space** from the Visual Environement - - #### Water system Support of GameObject transform on Water Surfaces have been improved. Infinite Oceans and surfaces with Instanced Quad geometry can now be translated and rotated, and support setting a negative scale to flip the surface. Added a Water Decal target for ShaderGraph in order to output water deformation and foam directly to the atlas, and avoid going through a CustomRenderTexture. Using the same graph also simplifies authoring when deformation and foam generation are linked. Additionally foam is now animated to follow the current direction. - + Underwater rendering now supports using the volumetric fog to rendering god rays and light shafts. - + Finally, a node has been added to the shadergraph to sample the height of the camera relative to the water surface. It can be used to create water drips and droplets on the camera. Refer to the underwater scene from the water samples in the package manager to see it in action. - + #### Volumetric Fog @@ -131,8 +120,6 @@ They are now more consistent and coherent across the different samples. There is more sharing between pipelines and packages and have dependencies in samples themselves. More explanations, links, files are included to better understand what is presented. - - ### Lens Flare Lens Flares are now have improved XR support. @@ -142,29 +129,23 @@ Additionally, a new ring procedural shape have been added as well as few other f - Support for radial gradient for procedural shapes. - Support for light override to be able to have multiple flares affected by one light. - - ### Hair Improve the workflow for width of a line with the High Quality Line Rendering Feature. Users are now able to express the width in centimeter units on a per-vertex basis. - + Character using per-vertex width values for peach fuzz with uniform width of 0.01cm - + Also, a new rendering LOD mode based on screen coverage of a hair asset have been added to culls strands based on some kind of heuristic. The screen coverage LOD mode allows an artist to define an animation curve, where the x-axis is the ratio between the screen space bounding-box of the hair instance to the viewport. The y-axis is the percentage of strands to render based on this ratio. - - ### Area Lights Area light now used a "pillow" windowing function that is used for range attenuation of both rectangular and line lights. Both area (with cookie) and line lights now works correctly with every material type including Water, Hair, Fabric shaders, dual lobe SSS. In addition this version reduce the amount of CPU memory used to store LTC tables. - - ### Path Tracing #### Include for Path Tracing checkbox diff --git a/Packages/com.unity.render-pipelines.high-definition/Editor/BuildProcessors/HDRPPreprocessShaders.cs b/Packages/com.unity.render-pipelines.high-definition/Editor/BuildProcessors/HDRPPreprocessShaders.cs index d4d4cb8dff7..5449cf26c0c 100644 --- a/Packages/com.unity.render-pipelines.high-definition/Editor/BuildProcessors/HDRPPreprocessShaders.cs +++ b/Packages/com.unity.render-pipelines.high-definition/Editor/BuildProcessors/HDRPPreprocessShaders.cs @@ -296,7 +296,8 @@ protected override bool DoShadersStripper(HDRenderPipelineAsset hdrpAsset, Shade bool useBicubicLightmapSampling = false; if (GraphicsSettings.TryGetRenderPipelineSettings
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.HighDefinition;
+ ///
+ /// public static class URPDefaultVolumeProfileHelper
+ /// {
+ /// public static VolumeProfile volumeProfile
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<URPDefaultVolumeProfileSettings>();
+ /// if (gs == null) //not in HDRP
+ /// return null;
+ /// return gs.volumeProfile;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.HighDefinition;
+ ///
+ /// public static class HDRPLookDevVolumeProfileHelper
+ /// {
+ /// public static VolumeProfile volumeProfile
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<LookDevVolumeProfileSettings>();
+ /// if (gs == null) //not in HDRP or in a Player
+ /// return null;
+ /// return gs.volumeProfile;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// Volumes defaultVolumes = Volumes.NewDefault();
+ ///
+ ///
+ /// // Example of usage:
+ /// if (UsesQualitySettings())
+ /// {
+ /// // Adjust parameters based on quality settings
+ /// }
+ ///
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.Universal;
+ ///
+ /// public static class URPUniversalRendererDebugShadersHelper
+ /// {
+ /// public static Shader replacementPS
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<UniversalRenderPipelineDebugShaders>();
+ /// if (gs == null) //not in URP or not in development build
+ /// return null;
+ /// return gs.debugReplacementPS;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.Universal;
+ ///
+ /// public static class URPUniversalRendererRuntimeShadersHelper
+ /// {
+ /// public static Shader blit
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<UniversalRenderPipelineRuntimeShaders>();
+ /// if (gs == null) //not in URP
+ /// return null;
+ /// return gs.coreBlitPS;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.Universal;
+ ///
+ /// public static class URPUniversalRendererRuntimeTexturesHelper
+ /// {
+ /// public static Texture blueNoise
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<UniversalRenderPipelineRuntimeTextures>();
+ /// if (gs == null) //not in URP
+ /// return null;
+ /// return gs.blueNoise64LTex;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.Universal;
+ ///
+ /// public static class URPUniversalRendererRuntimeXRResourcesHelper
+ /// {
+ /// public static Shader motionVector
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<UniversalRenderPipelineRuntimeXRResources>();
+ /// if (gs == null) //not in URP or XR not enabled
+ /// return null;
+ /// return gs.xrMotionVector;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.Universal;
+ ///
+ /// public static class URPUniversalRendererResourcesHelper
+ /// {
+ /// public static Shader motionVector
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<UniversalRendererResources>();
+ /// if (gs == null) //not in URP or not with UniversalRenderer
+ /// return null;
+ /// return gs.cameraMotionVector;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.Universal;
+ ///
+ /// public static class URPRenderGraphHelper
+ /// {
+ /// public static bool enabled
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<RenderGraphSettings>();
+ /// if (gs == null) //not in URP
+ /// return false;
+ /// return !gs.enableRenderCompatibilityMode;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.Universal;
+ ///
+ /// public static class URPDefaultVolumeProfileHelper
+ /// {
+ /// public static VolumeProfile volumeProfile
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<URPDefaultVolumeProfileSettings>();
+ /// if (gs == null) //not in URP
+ /// return null;
+ /// return gs.volumeProfile;
+ /// }
+ /// }
+ /// }
+ ///
+ ///
+ /// // Get the current version of the volume profile settings
+ /// int currentVersion = GraphicsSettings.GetRenderPipelineSettings<URPDefaultVolumeProfileSettings>().version;
+ ///
+ ///
+ /// // Set the default volume profile to a new profile
+ /// var urpDefaultVolumeProfileSettings = GraphicsSettings.GetRenderPipelineSettings<URPDefaultVolumeProfileSettings>();
+ /// urpDefaultVolumeProfileSettings.volumeProfile = newVolumeProfile;
+ ///
+ ///
+ /// using UnityEngine.Rendering;
+ /// using UnityEngine.Rendering.Universal;
+ ///
+ /// public static class URPShaderStrippingHelper
+ /// {
+ /// public static bool enabled
+ /// {
+ /// get
+ /// {
+ /// var gs = GraphicsSettings.GetRenderPipelineSettings<URPShaderStrippingSetting>();
+ /// if (gs == null) //not in URP or in a Player
+ /// return false;
+ /// return gs.stripUnusedVariants;
+ /// }
+ /// }
+ /// }
+ ///
+ /// Shader Graph supports three targets: the [Universal Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@12.0/manual/index.html), the [High Definition Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@12.0/manual/index.html), and [Built-In Render Pipeline](https://docs.unity3d.com/2020.3/Documentation/Manual/render-pipelines.html). Target-specific settings appear below the standard setting options. The displayed Target-specific settings change according to which Targets you select. | +| Active Targets | A list that contains the Targets you've selected. You can add or remove entries using the Add (**+**) and Remove (**-**) buttons.
Shader Graph supports three targets: the [Universal Render Pipeline](https://docs.unity3d.com/Manual/urp/urp-introduction.html), the [High Definition Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@12.0/manual/index.html), and [Built-In Render Pipeline](https://docs.unity3d.com/2020.3/Documentation/Manual/render-pipelines). Target-specific settings appear below the standard setting options. The displayed Target-specific settings change according to which Targets you select. | diff --git a/Packages/com.unity.shadergraph/Documentation~/Graph-Target.md b/Packages/com.unity.shadergraph/Documentation~/Graph-Target.md index 63b2305a31a..652b6b20eb4 100644 --- a/Packages/com.unity.shadergraph/Documentation~/Graph-Target.md +++ b/Packages/com.unity.shadergraph/Documentation~/Graph-Target.md @@ -10,7 +10,7 @@ Target Settings are specific to each Target, and can vary between assets dependi Typically, each Target you select generates a valid subshader from the graph. For example, a Shader Graph asset with both URP and HDRP Targets will generate two subshaders. When you use a graph that targets multiple render pipelines, you must reimport the Shader Graph asset if you change the active render pipeline. This updates the Material Inspector for any Materials that use your graph. -Shader Graph supports three targets: the [Universal Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@12.0/manual/index.html), the [High Definition Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@12.0/manual/index.html), and the [Built-In Render Pipeline](https://docs.unity3d.com/2020.3/Documentation/Manual/render-pipelines.html). +Shader Graph supports three targets: the [Universal Render Pipeline](https://docs.unity3d.com/Manual/urp/urp-introduction.html), the [High Definition Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@12.0/manual/index.html), and the [Built-In Render Pipeline](https://docs.unity3d.com/2020.3/Documentation/Manual/render-pipelines). Not all blocks are compatible with all targets. If a block in your graph becomes inactive when you choose a target, that block is not compatible with that target. diff --git a/Packages/com.unity.shadergraph/Documentation~/Position-Node.md b/Packages/com.unity.shadergraph/Documentation~/Position-Node.md index 116449a0274..5982556c6cc 100644 --- a/Packages/com.unity.shadergraph/Documentation~/Position-Node.md +++ b/Packages/com.unity.shadergraph/Documentation~/Position-Node.md @@ -21,7 +21,7 @@ The Position Node provides drop-down options for both **World** and **Absolute W The [High Definition Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest/index.html) uses [Camera Relative](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest?preview=1&subfolder=/manual/Camera-Relative-Rendering.html) as its default world space. -The [Universal Render Pipeline](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest/index.html) uses **Absolute World** as its default world space. +The [Universal Render Pipeline](https://docs.unity3d.com/Manual/urp/urp-introduction.html) uses **Absolute World** as its default world space. ### Upgrading from previous versions If you use a Position Node in **World** space on a graph authored in Shader Graph version 6.7.0 or earlier, it automatically upgrades the selection to **Absolute World**. This ensures that the calculations on your graph remain accurate to your expectations, since the **World** output might change. diff --git a/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Production-Ready-Decal.md b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Production-Ready-Decal.md index bcd3e81a8ee..ac30f503e25 100644 --- a/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Production-Ready-Decal.md +++ b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Production-Ready-Decal.md @@ -1,7 +1,7 @@ # Decals Decals allow you to apply local material modifications to specific places in the world. You might think of things like applying graffiti tags to a wall or scattering fallen leaves below a tree. But decals can be used for a lot more. In these examples, we see decals making things look wet, making surfaces appear to have flowing water across them, projecting water caustics, and blending specific materials onto other objects. -Decals are available to use in both HDRP and URP, but they need to be enabled in both render pipelines. To use decals, refer to the documentation in both [HDRP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/decals.html) and [URP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@17.0/manual/renderer-feature-decal.html). +Decals are available to use in both HDRP and URP, but they need to be enabled in both render pipelines. To use decals, refer to the documentation in both [HDRP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/decals.html) and [URP](https://docs.unity3d.com/Manual/urp/renderer-feature-decal.html). #### Material Projection This decal uses triplanar projection to project a material in 3D space. It projects materials correctly onto any mesh that intersects the decal volume. It can be used to apply terrain materials on to other objects like rocks so that they blend in better with the terrain. diff --git a/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Production-Ready-Detail.md b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Production-Ready-Detail.md index 59de6ba7216..1e454e51a9c 100644 --- a/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Production-Ready-Detail.md +++ b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-Production-Ready-Detail.md @@ -54,7 +54,7 @@ This custom GUI script enables the small texture thumbnails and other features i ## Decals Decals allow you to apply local material modifications to specific places in the world. You might think of things like applying graffiti tags to a wall or scattering fallen leaves below a tree. But decals can be used for a lot more. In these examples, we see decals making things look wet, making surfaces appear to have flowing water across them, projecting water caustics, and blending specific materials onto other objects. -Decals are available to use in both HDRP and URP, but they need to be enabled in both render pipelines. To use decals, see the documentation in both [HDRP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/decals.html) and [URP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@17.0/manual/renderer-feature-decal.html). +Decals are available to use in both HDRP and URP, but they need to be enabled in both render pipelines. To use decals, see the documentation in both [HDRP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@17.0/manual/decals.html) and [URP](https://docs.unity3d.com/Manual/urp/renderer-feature-decal.html). #### Material Projection This decal uses triplanar projection to project a material in 3D space. It projects materials correctly onto any mesh that intersects the decal volume. It can be used to apply terrain materials on to other objects like rocks so that they blend in better with the terrain. diff --git a/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Custom-UI-components.md b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Custom-UI-components.md new file mode 100644 index 00000000000..4cebeac35bd --- /dev/null +++ b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Custom-UI-components.md @@ -0,0 +1,13 @@ +# Custom UI components + +The sample contains a few custom UI components to reproduce the behavior of some elements such as buttons, toggles and sliders, passing data to the material assigned. +You can add these components from the main menu **Component** > **UI** > **Shader Graph Samples**. + +| Component | Description | +|:------------|:-------------------| +| **RectTransform Size** | Passes the gameObject's RectTransform's size to the graphic's material, as a _RectTransformSize Vector2 property. This is then fetched in a Shader Graph or Subgraph by using the RectTransform Size custom node (see below).| +| **Button** | Reproduces the behavior of a UI Button component. The button state is fetched in a Shader Graph or Subgraph by using the Selectable State custom node (see below). | +| **Toggle** | Reproduces the behavior of a UI Toggle component. The toggle 'on' state is fetched in a Shader Graph or Subgraph by using the Toggle State custom node (see below). Its state as a selectable is fetched in a Shader Graph or Subgraph by using the Selectable State custom node (see below).| +| **Meter** | A passive meter to be used as a progress indicator or gauge. It passes a normalized value to the Graphics material as a float "_MeterValue" property. Use the MeterValue node to fetch the value in a Shader Graph or Subgraph.| +| **RangeBar** | A passive range bar to be used as a progress bar, or in combination with a Range Slider.| +| **Slider** | A custom slider, handling drag events. Its value is fetched in a Shader Graph or Subgraph by using the Slider Value custom node (see below). Its state as a selectable is fetched in a Shader Graph or Subgraph by using the Selectable State custom node (see below).| \ No newline at end of file diff --git a/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Custom-nodes.md b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Custom-nodes.md new file mode 100644 index 00000000000..0eb3908039a --- /dev/null +++ b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Custom-nodes.md @@ -0,0 +1,26 @@ +# Custom nodes + +The sample contains a few custom shader graph nodes to facilitate the setup. +The custom nodes are broken into two categories: +- **Inline Properties** - These nodes automatically add a hidden property to the shader graph and fetch its value. +- **Branch** - These nodes enable branching on the value of specific inputs such as a Button state. + +## Inline Property Nodes +These nodes automatically add a hidden property to the shader graph and fetch its value. +You can also just manually add the property to the shader graph, but these custom nodes let you nest them in subgraphs. + +| Node | Description | +|:---------------|:-------------------| +| **RectTransform Size** | Adds a _RectTransformSize Vector2 hidden property to the graph and outputs its value. This is fed by the RectTransformSize component required by some subgraphs to perform aspect ratio based math. +| **Selectable State** | Adds a _State float hidden property to the graph and outputs its value. This is fed by the Selectable components (CustomButton, CustomToggle and Slider). The value represents the mutually exclusive state such as: **0 - Normal**, **1 - Highlighted**, **2 - Pressed**, **3 - Selected**, **4 - Disabled** | +| **Toggle State** | Adds a _isOn Boolean hidden property to the graph and outputs its value. This is fed by the CustomToggle component. | +| **Meter Value** | Adds a _MeterValue float hidden property to the graph and outputs its value. This is fed by the Meter component and allows creating progress, health or other indicators. | +| **Slider Value** | Adds a _SliderValue Vector3 hidden property to the graph and outputs its value as: **Value** - The normalized Slider Value as float. **Direction** - The normalized Slider Direction as Vector2. This is fed by the Slider component and allows creating sliders of which the direction and value can be set from the component. | +| **Range Bar** | Adds a _RangeBar Vector4 hidden property to the graph and outputs its value as: **Min** - The normalized Slider Min Value as float. **Max** - The normalized Slider Max Value as float. **Direction** - The normalized Slider Direction as Vector2. This is fed by the RangeBar component and allows creating range bars of which the direction and min/max values can be set from the component. | + +## Branch Nodes +These nodes let you branch on the value of specific inputs such as a Button state. +The motivation behind making them custom nodes rather than subgraphs lies in the ability to feature dynamic ports. + +### SelectableBranch +This node lets you branch depending on the state of a Selectable element such as a CustomButton. \ No newline at end of file diff --git a/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Examples.md b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Examples.md new file mode 100644 index 00000000000..54bd2f1a785 --- /dev/null +++ b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Examples.md @@ -0,0 +1,222 @@ +# Examples +These example shaders are built using the subgraph nodes. They show how the subgraph nodes work and how you can combine them to create backgrounds, buttons, and meters. + +## Backgrounds +The background examples are shaders that you can assign to Canvas Image objects that serve as backgrounds for other UI elements. + +### 80sSunset +This example combines the LinearTime, Perspective, Move, SquareTiles, Bars, and AntiAliasing nodes to generate a perspective grid that scrolls into the distance. + +Library Subgraph Nodes used in this example: +- Perspective +- LinearTime +- Move +- SquareTiles +- LinearGradient +- Bars +- AntiAliasing +- Gradients + +### Animated Clouds +This example combines animated procedural noise to create interesting dynamic patterns. + +### Blurred Hexagon +This example uses the SceneColorBlurred node to create a blurred version of the scene behind the user interface. It also uses the HexagonTiles node to generate a hexagon grid pattern. You can use the HexagonDisolve parameter to shrink and grow the size of the hexagons, which makes the pattern appear to dissolve. + +Library Subgraph Nodes used in this example: +- SceneColorBlurred +- HexagonTiles + +### Halftone +This example uses the Halftone node to convert the rendered scene behind the UI elements into a halftone pattern. It converts each of the three channels (red, green, and blue) into a halftone dot pattern, then recombines them to create the final image. + +Library Subgraph Nodes used in this example: +- Halftone + +### LavaLamp +This is an illustration of how distorted circle shapes can be animated to move around in random directions, and how signed distance field shapes can be blended together using the Smooth output of the SDFUnite node to merge the shapes. + +Library Subgraph Nodes used in this example: +- SineTime +- Move +- Circle +- SDFUnite + +### Pixelation +This example shows how to use the PosterizeUV node to quantize the UV coordinates used to sample the scene. The result is a version of the scene that appears to be made of larger pixels. + +Library Subgraph Nodes used in this sample: +- PosterizeUV + +### RoundedRectangleBubble +This example shows how to create a rounded frame as a background, including an outline and a drop shadow, for other UI elements. To maintain the correct aspect ratio of the rounded corners in this shader, connect the exposed WidthHeight parameter of this shader to the UI Image element’s Width and Height parameters. You can do this with the ImageSize script. Refer to [How to make shapes that adapt to the aspect ratio of the UI element](Shader-Graph-Sample-UGUI-Shaders-How-tos-aspect-ratio.md) for details on how to accomplish this. + +Library Subgraph Nodes used in this sample: +- Scale +- LinearGradient +- Move +- Rectangle + +### TechGrid +This example uses the SquareTiles node to generate a grid pattern and the AnimatedClouds node to create a smooth noise. These effects together create a nice tech grid for a background. + +Library Subgraph Nodes used in this sample: +- AnimatedClouds +- SquareTiles + +### WarpedGradient +This example shows how to warp UV coordinates with procedural noise and then use those warped coordinates to generate a deformed and blurry circle. It also darkens the corners of the screen using the Vignette node. + +Library Subgraph Nodes used in this sample: +- Move +- Circle +- Vignette + +## Buttons + +These examples show how to create buttons of various visual styles. Each button has exposed parameters that control the button’s visual states - selected, pressed, and active. In the example scene, you can take a look at how these material parameters are connected to the button’s state events to drive the appearance of the button. + +Many shape elements of the buttons use the AntiAliasing node which converts SDFs and gradients to perfectly anti-aliased shapes, regardless of scale or camera position. For more details on how to accomplish this, refer to [How to create a resolution-independent shape](Shader-Graph-Sample-UGUI-Shaders-How-tos-Res-indepenent.md). + +### AquaButton +This example shows how to create an aqua-style button and includes a specular highlight, gradient shading, a fresnel outline, and a colored drop shadow. It adjusts to the aspect ratio of the button object it’s assigned to using the WidthHeight parameter. In the sample scene, notice that this material parameter is connected to the UI object’s width and height values using the ImageSize script. + +Library Subgraph Nodes used in this sample: +- Move +- AspectRatio +- AnimatedSheen +- Pill + +### SciFiButton +This example uses multiple circular elements and illustrates how multiple elements can be combined with subtract, maximum, lerp, and multiply. + +Library Subgraph Nodes used in this sample: +- Circle +- CircleSegments +- AntiAliasing +- Scale +- PlayerIcon + +### SciFiButton2 +This button example is similar to the Tech Grid background. It uses the SquareTiles node to create a grid and the AnimatedClouds node to create a smooth noise background. It also illustrates the use of the Tilt node to turn the rectangle shape into a parallelogram. + +Library Subgraph Nodes used in this sample: +- AspectRatio +- LinearTime +- CircleSegments +- Rectangle +- AntiAliasing +- AnimatedSheen +- SquareTiles + +### SimpleButton +This is an example of how you can create a simple button with a smooth gradient color, a drop shadow, and Selected, Pressed, and Active states. + +Library Subgraph Nodes used in this sample: +- Move +- Scale +- LinearGradient +- Rectangle +- AntiAliasing + +## Indicators + +These UI elements indicate things to the player visually such as health level, ammo count, shield power, etc. All of them have an exposed material parameter called “Health” that drives the level of the meter. Using a script, you can connect this parameter to any value in your project to indicate its level to the player. + +### AquaMeter +The style of this meter matches the AquaButton example - but instead of exposing button states, it has a controllable fill meter. + +Library Subgraph Nodes used in this sample: +- AspectRatio +- Pill +- AntiAliasing +- HistogramScan + +### DialMeter +This example uses polar coordinates to create a circular-shaped meter. It also uses drop-shadows on both the inner circle and the outer shape. The player icon at the center could be replaced with a texture sample or another SDF shape. + +Library Subgraph Nodes used in this sample: +- AspectRatio +- Pill +- AntiAliasing +- HistogramScan + +### FantasyMeter +This example could be used as a health or mana indicator for a fantasy game. It uses the SphereGradient node to generate fake lighting and reflections based on a procedurally-generated sphere shape. The sphere defaults to being filled with red liquid, but you can easily change the color to anything you like by using the exposed Color parameter. + +Library Subgraph Nodes used in this sample: +- LinearGradient +- PosterizeGradient +- Hash11 +- LinearTime +- GridTiles +- Move +- Circle +- HistogramScan +- Waves +- AntiAliasing +- Gradients +- SphereGradient + +### SciFiMeter +This meter could be used to indicate ammo or shield level in a sci-fi-themed game. The cool thing about this one is that it starts to shake when the indicator gets low - to emphasize the urgency of low ammo or shields. + +Library Subgraph Nodes used in this sample: +- Shake +- AspectRatio +- Tilt +- Rectangle +- AntiAliasing +- WindowBlinds +- PosterizeGradient +- HistogramScan + +## Progress Bars + + +### FancyLoading +This is a circle that’s made of circles. Each circle starts large and then gets smaller over time and the effect is offset so it happens in a wave pattern. The larger circle pattern also appears to move and change perspective over time as if it were tilting around in a 3D space. These effects are all achieved by chaining together various nodes from the Subgraph Library. + +Library Subgraph Nodes used in this sample: +- SineTime +- Perspective +- Scale +- Move +- LinearTime +- GridTiles +- Circle +- AntiAliasing + +### GradientBar +This is a pill-shaped bar that fills up as the progress parameter increases from zero to one. The aspect ratio adapts if it’s correctly connected to the width and height parameters of the Canvas Image element it’s assigned to. + +Library Subgraph Nodes used in this sample: +- Move +- Pill +- AntiAliasing +- Invert +- LinearGradient +- Scale +- Gradients + +### ProgressCircle +This is a round dial that fills up in a circle shape as the progress parameter increases from zero to one. The start color and end color are exposed as parameters and can be adjusted to create different looks. + +Library Subgraph Nodes used in this sample: +- Invert +- PosterizeGradient +- HistogramScan +- Circle +- AntiAliasing +- CircleSegments + +### SimpleLoading +This is a circle made of pill-shaped elements that fade from white to black over time. Each element fades in a wave-like pattern that appears to go around the circle. This type of animation is very commonly used as a loading indicator. + +Library Subgraph Nodes used in this sample: +- Tilt +- Scale +- LinearTime +- GridTiles +- Pill +- AntiAliasing \ No newline at end of file diff --git a/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Getting-Started.md b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Getting-Started.md new file mode 100644 index 00000000000..6502f581dfe --- /dev/null +++ b/Packages/com.unity.shadergraph/Documentation~/Shader-Graph-Sample-UGUI-Shaders-Getting-Started.md @@ -0,0 +1,22 @@ +# Getting Started +After you import the sample from the Package Manager open this scene: + + - `Assets\Samples\Shader Graph\
| Property | URP Lit | URP Unlit | Built-In Render Pipeline |
| Workflow Mode | See the URP documentation for the Lit URP Shader. | Not applicable. | Not applicable. |
| Workflow Mode | See the URP documentation for the Lit URP Shader. | Not applicable. | Not applicable. |
| Receive Shadows | |||
| Cast Shadows | This property is only exposed if Allow Material Override is enabled for this Shader Graph. Enable this property to make it possible for a GameObject using this shader to cast shadows onto itself and other GameObjects. This corresponds to the SubShader Tag ForceNoShadowCasting. | Not applicable. | |
| Surface Type | See the URP documentation for the Lit and Unlit Shaders. | In the Built-In Render Pipeline, this feature has the same behavior as in URP. Consult the URP documentation. | |
| Surface Type | See the URP documentation for the Lit and Unlit Shaders. | In the Built-In Render Pipeline, this feature has the same behavior as in URP. Consult the URP documentation. | |
| Render Face | In the Built-In Render Pipeline, this feature has the same behavior as in URP. Consult the URP documentation. | ||