Merge pull request #8063 from Unity-Technologies/internal/master

Internal/master

Author: UnityAljosha

Packages/com.unity.render-pipelines.core/Documentation~/TableOfContents.md

@@ -19,7 +19,9 @@
   * [Add custom graphics settings](add-custom-graphics-settings.md)
   * [Get custom graphics settings](get-custom-graphics-settings.md)
   * [Include or excude a setting in your build](choose-whether-unity-includes-a-graphics-setting-in-your-build.md)
-* [Synchronizing shader code and C#](generating-shader-includes.md)
+* [Shaders](shaders.md)
+  * [Use shader methods from the SRP Core shader library](built-in-shader-methods.md)
+  * [Synchronizing shader code and C#](generating-shader-includes.md)
 * [Look Dev](Look-Dev.md)
   * [Environment Library](Look-Dev-Environment-Library.md)
 * [Rendering Debugger](Rendering-Debugger.md)

Packages/com.unity.render-pipelines.core/Documentation~/built-in-shader-methods.md

@@ -0,0 +1,60 @@
+# Use shader methods from the SRP Core shader library
+
+SRP Core has a library of High-Level Shader Language (HLSL) shader files that contain helper methods. You can import these files into your custom shader files and use the helper methods.
+
+To use the following methods, add `#include "Packages/com.unity.render-pipelines.core/ShaderLibrary/SpaceTransforms.hlsl"` inside the `HLSLPROGRAM` in your shader file.
+
+### Get matrices
+
+| **Method** | **Syntax** | **Description** |
+|-|-|-|
+| `CreateTangentToWorld` | `real3x3 CreateTangentToWorld(real3 normal, real3 tangent, real flipSign)` | Returns the matrix that converts tangents to world space. |
+| `GetObjectToWorldMatrix()` | `float4x4 GetObjectToWorldMatrix()` | Returns the matrix that converts positions in object space to world space. |
+| `GetViewToHClipMatrix()` | `float4x4 GetViewToHClipMatrix()` | Returns the matrix that converts positions in view space to clip space. |
+| `GetViewToWorldMatrix()` | `float4x4 GetViewToWorldMatrix()` | Returns the matrix that converts positions in view space to world space. |
+| `GetWorldToHClipMatrix()` | `float4x4 GetWorldToHClipMatrix()` | Returns the matrix that converts positions in world space to clip space. |
+| `GetWorldToObjectMatrix()` | `float4x4 GetWorldToObjectMatrix()` | Returns the matrix that converts positions in world space to object space. |
+| `GetWorldToViewMatrix()` | `float4x4 GetWorldToViewMatrix()` | Returns the matrix that converts positions in world space to view space. |
+
+### Transform positions
+
+| **Method** | **Syntax** | **Description** |
+|-|-|-|
+| `TransformObjectToHClip` | `float4 TransformObjectToHClip(float3 positionInObjectSpace)` | Converts a position in object space to clip space. |
+| `TransformObjectToWorld` | `float3 TransformObjectToWorld(float3 positionInObjectSpace)` | Converts a position in object space to world space. |
+| `TransformViewToWorld` | `float3 TransformViewToWorld(float3 positionInViewSpace)` | Converts a position in view space to world space. |
+| `TransformWorldToHClip` | `float4 TransformWorldToHClip(float3 positionInWorldSpace)` | Converts a position in world space to clip space. |
+| `TransformWorldToObject` | `float3 TransformWorldToObject(float3 positionInWorldSpace)` | Converts a position in world space to object space. |
+| `TransformWorldToView` | `float3 TransformWorldToView(float3 positionInWorldSpace)` | Converts a position in world space to view space. |
+| `TransformWViewToHClip` | `float4 TransformWViewToHClip(float3 positionInViewSpace)` | Converts a position in view space to clip space. |
+
+### Transform directions
+
+| **Method** | **Syntax** | **Description** |
+|-|-|-|
+| `TransformObjectToTangent` | `real3 TransformObjectToTangent(real3 directionInObjectSpace, real3x3 tangentToWorldMatrix)` | Converts a direction in object space to tangent space, using a tangent-to-world matrix. |
+| `TransformObjectToWorldDir` | `float3 TransformObjectToWorldDir(float3 directionInObjectSpace, bool normalize = true)` | Converts a direction in object space to world space. |
+| `TransformTangentToObject` | `real3 TransformTangentToObject(real3 dirTS, real3x3 tangentToWorldMatrix)` | Converts a direction in tangent space to object space, using a tangent-to-world matrix. |
+| `TransformTangentToWorldDir` | `real3 TransformTangentToWorldDir(real3 directionInWorldSpace, real3x3 tangentToWorldMatrix, bool normalize = false)` | Converts a direction in tangent space to world space, using a tangent-to-world matrix. |
+| `TransformViewToWorldDir` | `real3 TransformViewToWorldDir(real3 directionInViewSpace, bool normalize = false)` | Converts a direction in view space to world space. |
+| `TransformWorldToHClipDir` | `real3 TransformWorldToHClipDir(real3 directionInWorldSpace, bool normalize = false)` | Converts a direction in world space to clip space. |
+| `TransformWorldToObjectDir` | `float3 TransformWorldToObjectDir(float3 directionInWorldSpace, bool normalize = true)` | Converts a direction in world space to object space. |
+| `TransformWorldToTangentDir` | `real3 TransformWorldToTangentDir(real3 directionInWorldSpace, real3x3 tangentToWorldMatrix, bool normalize = false)` | Converts a direction in world space to tangent space, using a tangent-to-world matrix. |
+| `TransformWorldToViewDir` | `real3 TransformWorldToViewDir(real3 directionInWorldSpace, bool normalize = false)` | Converts a direction in world space to view space. |
+
+### Transform surface normals
+
+| **Method** | **Syntax** | **Description** |
+|-|-|-|
+| `TransformObjectToWorldNormal` | `float3 TransformObjectToWorldNormal(float3 normalInObjctSpace, bool normalize = true)` | Converts a normal in object space to world space. |
+| `TransformTangentToWorld` | `float3 TransformTangentToWorld(float3 normalInTangentSpace, real3x3 tangentToWorldMatrix, bool normalize = false)` | Converts a normal in tangent space to world space, using a tangent-to-world matrix. |
+| `TransformViewToWorldNormal` | `real3 TransformViewToWorldNormal(real3 normalInViewSpace, bool normalize = false)` | Converts a normal in view space to world space. |
+| `TransformWorldToObjectNormal` | `float3 TransformWorldToObjectNormal(float3 normalInWorldSpace, bool normalize = true)` | Converts a normal in world space to object space. |
+| `TransformWorldToTangent` | `float3 TransformWorldToTangent(float3 normalInWorldSpace, real3x3 tangentToWorldMatrix, bool normalize = true)` | Converts a normal in world space to tangent space using a tangent-to-world matrix. |
+| `TransformWorldToViewNormal` | `real3 TransformWorldToViewNormal(real3 normalInWorldSpace, bool normalize = false)` | Converts a normal in world space to view space. |
+
+## Additional resources
+
+- [HLSL in Unity](https://docs.unity3d.com/Manual/SL-ShaderPrograms.html)
+
+

Packages/com.unity.render-pipelines.core/Documentation~/shaders.md

@@ -0,0 +1,12 @@
+# Shaders
+
+Work with shader code in the Scriptable Render Pipeline (SRP).
+
+|**Page**|**Description**|
+|-|-|
+|[Use shader methods from the SRP Core shader library](built-in-shader-methods.md)|SRP Core has a library of High-Level Shader Language (HLSL) shader files that contain helper methods. You can import these files into your custom shader files and use the helper methods.|
+|[Synchronizing shader code and C#](generating-shader-includes.md)|Generate HLSL code based on C# structs to synchronize data and constants between shaders and C#.|
+
+## Additional resources
+
+- [HLSL in Unity](https://docs.unity3d.com/Manual/SL-ShaderPrograms.html)

Packages/com.unity.render-pipelines.core/Editor/AdditionalPropertiesState.cs

@@ -22,7 +22,7 @@ void RepaintAll()
 
         /// <summary>Get or set the state given the mask.</summary>
         /// <param name="mask">The filtering mask</param>
-        /// <returns>True: All flagged area are expended</returns>
+        /// <value>True: All flagged area are expended</value>
         public bool this[TState mask]
         {
             get => GetAdditionalPropertiesState(mask);
@@ -67,6 +67,10 @@ internal AnimFloat GetAnimation(TState mask)
             return anim;
         }
 
+        /// <summary>
+        /// Resets the animation associated with the given mask to a default state with the animated value set to 1.0 and the target value set to 0.0.
+        /// </summary>
+        /// <param name="mask">The state mask used to retrieve the associated animation.</param>
         protected internal void ResetAnimation(TState mask)
         {
             AnimFloat anim = GetAnimation(mask);
@@ -100,6 +104,9 @@ public void UnregisterEditor(Editor editor)
     public class AdditionalPropertiesState<TState, TTarget> : AdditionalPropertiesStateBase<TState>
         where TState : struct, IConvertible
     {
+        /// <summary>
+        /// Stores the expanded or collapsed state of each section defined by <typeparamref name="TState"/>.
+        /// </summary>
         protected internal EditorPrefBoolFlags<TState> m_State;
 
 

Packages/com.unity.render-pipelines.core/Editor/Analytics/AnalyticsUtils.cs

@@ -231,6 +231,7 @@ static string[] ToStringArray(Dictionary<string, string> diff)
         /// <param name="current">The current object to obtain the fields and values.</param>
         /// <param name="compareAndSimplifyWithDefault">If a comparison against the default value must be done.</param>
         /// <returns>The nested columns in form of {key.nestedKey : value} </returns>
+        /// <exception cref="ArgumentNullException">Throws an exception if current parameter is null.</exception>
         public static string[] ToNestedColumn<T>([DisallowNull] this T current, bool compareAndSimplifyWithDefault = false)
             where T : new()
         {
@@ -269,6 +270,7 @@ public static string[] ToNestedColumn<T>([DisallowNull] this T current, bool com
         /// <param name="current">The current object to obtain the fields and values.</param>
         /// <param name="defaultInstance">The default instance to compare values</param>
         /// <returns>The nested columns in form of {key.nestedKey : value} </returns>
+        /// <exception cref="ArgumentNullException">Throws an exception if the current or defaultInstance parameters are null.</exception>
         public static string[] ToNestedColumn<T>([DisallowNull] this T current, T defaultInstance)
         {
             if (current == null)
@@ -293,7 +295,7 @@ public static string[] ToNestedColumn<T>([DisallowNull] this T current, T defaul
         /// <param name="defaultObject">The default object</param>
         /// <param name="compareAndSimplifyWithDefault">If a comparison against the default value must be done.</param>
         /// <returns>The nested columns in form of {key.nestedKey : value} </returns>
-        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="ArgumentNullException">Throws an exception if the current parameter is null.</exception>
         public static string[] ToNestedColumnWithDefault<T>([DisallowNull] this T current, [DisallowNull] T defaultObject, bool compareAndSimplifyWithDefault = false)
         {
             if (current == null)

Packages/com.unity.render-pipelines.core/Editor/Camera/CameraUI.Environment.Drawers.cs

@@ -1,6 +1,5 @@
 namespace UnityEditor.Rendering
 {
-    /// <summary> Camera UI Shared Properties among SRP</summary>
     public static partial class CameraUI
     {
         /// <summary>

Packages/com.unity.render-pipelines.core/Editor/Camera/CameraUI.Environment.Skin.cs

@@ -2,12 +2,8 @@
 
 namespace UnityEditor.Rendering
 {
-    /// <summary> Camera UI Shared Properties among SRP</summary>
     public static partial class CameraUI
     {
-        /// <summary>
-        /// Environment section
-        /// </summary>
         public static partial class Environment
         {
             /// <summary>

Packages/com.unity.render-pipelines.core/Editor/Camera/CameraUI.Output.Drawers.cs

@@ -2,7 +2,6 @@
 
 namespace UnityEditor.Rendering
 {
-    /// <summary> Camera UI Shared Properties among SRP</summary>
     public static partial class CameraUI
     {
         /// <summary>

Packages/com.unity.render-pipelines.core/Editor/Camera/CameraUI.Output.Skin.cs

@@ -2,12 +2,8 @@
 
 namespace UnityEditor.Rendering
 {
-    /// <summary> Camera UI Shared Properties among SRP</summary>
     public static partial class CameraUI
     {
-        /// <summary>
-        /// Output section
-        /// </summary>
         public static partial class Output
         {
             /// <summary>

Packages/com.unity.render-pipelines.core/Editor/Camera/CameraUI.PhysicalCamera.Drawers.cs

@@ -4,10 +4,6 @@
 
 namespace UnityEditor.Rendering
 {
-
-    using CED = CoreEditorDrawer<ISerializedCamera>;
-
-    /// <summary> Camera UI Shared Properties among SRP</summary>
     public static partial class CameraUI
     {
         /// <summary>