Universal converter / upgrader framework

com.unity.render-pipelines.core/Editor/MaterialUpgrader.cs

@@ -270,8 +270,17 @@ public void RenameKeywordToFloat(string oldName, string newName, float setVal, f
             m_KeywordFloatRename.Add(new KeywordFloatRename { keyword = oldName, property = newName, setVal = setVal, unsetVal = unsetVal });
         }
 
+        /// <summary>
+        /// Checking if the passed in value is a path to a Material.
+        /// </summary>
+        /// <param name="path">Path to test.</param>
+        /// <return>Returns true if the passed in value is a path to a material.</return>
         static bool IsMaterialPath(string path)
         {
+            if (string.IsNullOrEmpty(path))
+            {
+                throw new ArgumentNullException(nameof(path));
+            }
             return path.EndsWith(".mat", StringComparison.OrdinalIgnoreCase);
         }
 
@@ -299,7 +308,13 @@ static void SaveAssetsAndFreeMemory()
             AssetDatabase.Refresh();
         }
 
-        private static bool ShouldUpgradeShader(Material material, HashSet<string> shaderNamesToIgnore)
+        /// <summary>
+        /// Checking if the passed in value is a path to a Material.
+        /// </summary>
+        /// <param name="material">Material to check.</param>
+        /// <param name="shaderNamesToIgnore">HashSet of strings to ignore.</param>
+        /// <return>Returns true if the passed in material's shader is not in the passed in ignore list.</return>
+        static bool ShouldUpgradeShader(Material material, HashSet<string> shaderNamesToIgnore)
         {
             if (material == null)
                 return false;
@@ -392,15 +407,44 @@ public static void Upgrade(Material material, MaterialUpgrader upgrader, Upgrade
         /// <param name="flags">Material Upgrader flags.</param>
         public static void Upgrade(Material material, List<MaterialUpgrader> upgraders, UpgradeFlags flags)
         {
-            if (material == null)
+            string message = String.Empty;
+            if (Upgrade(material, upgraders, flags, ref message))
                 return;
 
+            if (!string.IsNullOrEmpty(message))
+            {
+                Debug.Log(message);
+            }
+        }
+
+        /// <summary>
+        /// Upgrade a material.
+        /// </summary>
+        /// <param name="material">Material to upgrade.</param>
+        /// <param name="upgraders">List of Material upgraders.</param>
+        /// <param name="flags">Material upgrader flags.</param>
+        /// <param name="message">Error message to be outputted when no material upgraders are suitable for given material if the flags <see cref="UpgradeFlags.LogMessageWhenNoUpgraderFound"/> is used.</param>
+        /// <return>Returns true if the upgrader was found for the passed in material.</return>
+        public static bool Upgrade(Material material, List<MaterialUpgrader> upgraders, UpgradeFlags flags, ref string message)
+        {
+            if (material == null)
+                return false;
+
             var upgrader = GetUpgrader(upgraders, material);
 
             if (upgrader != null)
+            {
                 upgrader.Upgrade(material, flags);
-            else if ((flags & UpgradeFlags.LogMessageWhenNoUpgraderFound) == UpgradeFlags.LogMessageWhenNoUpgraderFound)
-                Debug.Log(string.Format("{0} material was not upgraded. There's no upgrader to convert {1} shader to selected pipeline", material.name, material.shader.name));
+                return true;
+            }
+            if ((flags & UpgradeFlags.LogMessageWhenNoUpgraderFound) == UpgradeFlags.LogMessageWhenNoUpgraderFound)
+            {
+                message =
+                    $"{material.name} material was not upgraded. There's no upgrader to convert {material.shader.name} shader to selected pipeline";
+                return false;
+            }
+
+            return true;
         }
 
         /// <summary>

com.unity.render-pipelines.universal/Editor/BuiltInToURPConverterContainer.cs

@@ -0,0 +1,8 @@
+namespace UnityEditor.Rendering.Universal
+{
+    internal sealed class BuiltInToURPConverterContainer : RenderPipelineConverterContainer
+    {
+        public override string name => "Built-in to URP";
+        public override string info => "The Render Pipeline Conversion Wizard is meant to help Convert projects from built-in to Universal Render Pipeline.";
+    }
+}

com.unity.render-pipelines.universal/Editor/Converter/ConverterItemDescriptor.cs

@@ -0,0 +1,22 @@
+namespace UnityEditor.Rendering
+{
+    /// <summary>
+    /// A structure holding the information for each Item that needs to be Converted.
+    /// Name = The Name of the asset that is being converted.
+    /// Info = Information that can be used to store some data. This will also be shown in the UI.
+    /// WarningMessage = If there are some issues with the converter that we already know about.
+    ///     Example: If we know it is a custom shader, we can not convert it so we add the information here.
+    /// HelpLink = Link to the documentation of how to convert this asset. Useful if the conversion failed or if we know we can not convert this asset automatically.
+    /// </summary>
+    public struct ConverterItemDescriptor
+    {
+        /// <summary> Name of the asset being converted. This will be shown in the UI. </summary>
+        public string name;
+        /// <summary> Information that can be used to store some data. This will also be shown in the UI. </summary>
+        public string info;
+        /// <summary> If there are some issues with the converter that we already know about during init phase. This will be added as a tooltip on the warning icon. </summary>
+        public string warningMessage;
+        /// <summary> Link to the documentation of how to convert this asset. Useful if the conversion failed or if we know we can not convert this asset automatically. </summary>
+        public string helpLink;
+    }
+}

com.unity.render-pipelines.universal/Editor/Converter/ConverterItemInfo.cs

@@ -0,0 +1,16 @@
+namespace UnityEditor.Rendering
+{
+    /// <summary>
+    /// A structure holding the information for each Item that needs to be Converted.
+    /// Descriptor = The ConverterItemDescriptor this item contain.
+    /// Index = The index for this item in the list of converter items.
+    /// </summary>
+    public struct ConverterItemInfo
+    {
+        /// <summary> The ConverterItemDescriptor this item contain. </summary>
+        public ConverterItemDescriptor descriptor { get; internal set; }
+
+        /// <summary> The index for this item in the list of converter items. </summary>
+        public int index { get; internal set; }
+    }
+}

com.unity.render-pipelines.universal/Editor/Converter/FailedItem.cs

@@ -0,0 +1,9 @@
+namespace UnityEditor.Rendering
+{
+    // Storing the index and message of the failed item so that we can show that in the UI.
+    internal struct FailedItem
+    {
+        public int index;
+        public string message;
+    }
+}

com.unity.render-pipelines.universal/Editor/Converter/InitializeConverterContext.cs

@@ -0,0 +1,26 @@
+using System.Collections.Generic;
+
+namespace UnityEditor.Rendering
+{
+    /// <summary>
+    /// A structure needed for the initialization step of the converter.
+    /// Stores data to be visible in the UI.
+    /// </summary>
+    public struct InitializeConverterContext
+    {
+        /// <summary>
+        /// Stores the list of ConverterItemDescriptor that will be filled in during the initialization step.
+        /// </summary>
+        internal List<ConverterItemDescriptor> items;
+
+        /// <summary>
+        /// Add to the list of assets to be converted.
+        /// This will be used to display information to the user in the UI.
+        /// </summary>
+        /// <param name="item">The item to add to the list items to convert</param>
+        public void AddAssetToConvert(ConverterItemDescriptor item)
+        {
+            items.Add(item);
+        }
+    }
+}

com.unity.render-pipelines.universal/Editor/Converter/RenderPipelineConverter.cs

@@ -0,0 +1,50 @@
+using System;
+
+namespace UnityEditor.Rendering.Universal
+{
+    // Might need to change this name before making it public
+    internal abstract class RenderPipelineConverter
+    {
+        /// <summary>
+        /// Name of the converter.
+        /// </summary>
+        public abstract string name { get; }
+
+        /// <summary>
+        /// The information when hovering over the converter.
+        /// </summary>
+        public abstract string info { get; }
+
+        /// <summary>
+        /// A check if the converter is enabled or not. Can be used to do a check if prerequisites are met to have it enabled or disabled.
+        /// </summary>
+        public virtual bool IsEnabled => true;
+
+        /// <summary>
+        /// This method getting triggered when clicking the listview item in the UI.
+        /// </summary>
+        public virtual void OnClicked(int index)
+        {
+        }
+
+        // This is so that we can have different segment in our UI, example Unity converters, your custom converters etc..
+        // This is not implemented yet
+        public virtual string category { get; }
+
+        // This is in which drop down item the converter belongs to.
+        // Not properly implemented yet
+        public abstract Type conversion { get; }
+
+        /// <summary>
+        /// This runs when initializing the converter. To gather data for the UI and also for the converter if needed.
+        /// </summary>
+        /// <param name="context">The context that will be used to initialize data for the converter.</param>
+        public abstract void OnInitialize(InitializeConverterContext context);
+
+        /// <summary>
+        /// The method that will be run when converting the assets.
+        /// </summary>
+        /// <param name="context">The context that will be used when executing converter.</param>
+        public abstract void OnRun(ref RunItemContext context);
+    }
+}

com.unity.render-pipelines.universal/Editor/Converter/RenderPipelineConverterContainer.cs

@@ -0,0 +1,20 @@
+namespace UnityEditor.Rendering
+{
+    /// <summary>
+    /// A class to contain converters. This is for a common set of converters.
+    /// For example: Converters that is for Built-in to URP would have it's own container.
+    /// </summary>
+    internal abstract class RenderPipelineConverterContainer
+    {
+        /// <summary>
+        /// The name of the Container. This will show up int the UI.
+        /// </summary>
+        public abstract string name { get; }
+
+        /// <summary>
+        /// The information for this container.
+        /// This will be shown in the UI to tell the user some information about the converters that this container are targeting.
+        /// </summary>
+        public abstract string info { get; }
+    }
+}