Streamingle_URP/Assets/NiloToonURP/Runtime/RendererFeatures/Passes/NiloToonAverageShadowTestRTPass.cs

using System;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Experimental.Rendering;
using UnityEngine.Rendering;
using UnityEngine.Rendering.Universal;
#if UNITY_6000_0_OR_NEWER
using UnityEngine.Rendering.RenderGraphModule;
#endif

#if UNITY_2021 || UNITY_2022
// On old Unity versions, alias our code's GraphicsFormatUsage to FormatUsage
using GraphicsFormatUsage = UnityEngine.Experimental.Rendering.FormatUsage;
#else
using GraphicsFormatUsage = UnityEngine.Experimental.Rendering.GraphicsFormatUsage;
#endif

namespace NiloToon.NiloToonURP
{
    public class NiloToonAverageShadowTestRTPass : ScriptableRenderPass
    {
        // singleton
        public static NiloToonAverageShadowTestRTPass Instance => _instance;
        static NiloToonAverageShadowTestRTPass _instance;

        [Serializable]
        public class Settings
        {
            [Revertible]
            [Tooltip(   "If you want NiloToon character to receive URP shadow map in an extremely soft and blurry way(a special URP shadow sampling that is blurry across the whole character, darken the character uniformly), turn this on.\n" +
                        "When turned on, character won't receive main directional light's direct lighting when occluded by URP's shadow casters (e.g. character completely under a bridge, where the bridge is casting URP shadow).\n\n" +
                        "Default is OFF, since some users don't want this kind of shadow ON by default when character is completely indoor")]
            [OverrideDisplayName("Enable?")]
            public bool enableAverageShadow = false;
        }

        public Settings settings;

        // for most game type, 128 is a big enough number, but still not affecting performance
        // maximum 127 active nilotoon characters can be inside the same scene(including any active character in scene, no camera culling), the last slot is reserved for camera's anime postprocess 
        const int MAX_SHADOW_SLOT_COUNT = 128;

        Material material;
        float[] shaderDataArray;

#if UNITY_2022_2_OR_NEWER
        RTHandle shadowTestResultRTH;
#else
        RenderTargetHandle shadowTestResultRTH;
#endif

        static readonly int _SphereShadowMapRT_SID = Shader.PropertyToID("_SphereShadowMapRT");

        public NiloToonAverageShadowTestRTPass(NiloToonRendererFeatureSettings allSettings)
        {
            this.settings = allSettings.sphereShadowTestSettings;

#if !UNITY_2022_2_OR_NEWER
            shadowTestResultRTH.Init("_NiloToonAverageShadowMapRT");
#endif

            shaderDataArray = new float[MAX_SHADOW_SLOT_COUNT * 4]; // each slot has 4 data, total of 128 slots. (default with (0,0,0,0))

            _instance = this;

            base.profilingSampler = new ProfilingSampler(nameof(NiloToonAverageShadowTestRTPass));
        }
#if !UNITY_6000_4_OR_NEWER
        // This method is called before executing the render pass.
        // It can be used to configure render targets and their clear state. Also to create temporary render target textures.
        // When empty this render pass will render to the active camera render target.
        // You should never call CommandBuffer.SetRenderTarget. Instead call <c>ConfigureTarget</c> and <c>ConfigureClear</c>.
        // The render pipeline will ensure target setup and clearing happens in a performant manner.
#if UNITY_6000_0_OR_NEWER
        [Obsolete]
#endif
        public override void OnCameraSetup(CommandBuffer cmd, ref RenderingData renderingData)
        {
            // [possible optimization note]
            // in URP12(Unity2021.3), even there is no shadow caster to draw, URP will still allocate and clear a small 1x1 RT, used as shadowmap
            // see URP12 -> MainLightShadowCasterPass.cs's SetupForEmptyRendering().

            GetRTDescriptor(out var renderTextureDescriptor);

            // we need each pixel providing a per character average shadow attenuation value when sampling, so FilterMode is Point
#if UNITY_2022_2_OR_NEWER
            RenderingUtils.ReAllocateIfNeeded(ref shadowTestResultRTH, renderTextureDescriptor, FilterMode.Point, TextureWrapMode.Clamp, name: "_NiloToonAverageShadowMapRT");
            cmd.SetGlobalTexture(shadowTestResultRTH.name, shadowTestResultRTH.nameID);
#else
            cmd.GetTemporaryRT(shadowTestResultRTH.id, renderTextureDescriptor, FilterMode.Point);
            cmd.SetGlobalTexture(_SphereShadowMapRT_SID, shadowTestResultRTH.Identifier());
#endif
            // still need to clear RT to white even average shadow is not enabled 
            // (in character shader we removed average shadow's multi_compile to save memory & build time/size, so character shader is always sampling this RT)
#if UNITY_2022_2_OR_NEWER
            ConfigureTarget(shadowTestResultRTH);
#else
            ConfigureTarget(shadowTestResultRTH.Identifier());
#endif
            ConfigureClear(ClearFlag.Color, Color.white); // default white = default no shadow
        }
#endif
        
        private static void GetRTDescriptor(out RenderTextureDescriptor renderTextureDescriptor)
        {
            // here we can't do this optimization, since character shader will LOAD texture using uv = (index,0),
            // this texture must be 128x1
            int RTwidth = MAX_SHADOW_SLOT_COUNT;

            // RT width: use MAX_SHADOW_SLOT_COUNT as RT width, each pixel represent 1 NiloToon character's average shadow(the last pixel is camera's average shadow)
            // RT height: RT height is 1
            // RTFormat: RT format is RFloat, because we want to store a 0~1 average shadowAttenuation value
            // don't need depthbuffer/stencil/mipmap
            renderTextureDescriptor = new RenderTextureDescriptor(RTwidth, 1, RenderTextureFormat.RFloat, 0, 1);

            // it is linear(non color) data
            renderTextureDescriptor.sRGB = false;

            renderTextureDescriptor.depthBufferBits = 0;
            renderTextureDescriptor.depthStencilFormat = GraphicsFormat.None;
            
            // Some Samsung phones didn't support GraphicsFormat.R16_UNorm, so we need to do a full fallback chain
            // Devices that can't support R16_UNorm = Galaxy S8, S7, and S21
            if(SystemInfo.IsFormatSupported(GraphicsFormat.R16_UNorm,GraphicsFormatUsage.Render))
            {
                renderTextureDescriptor.graphicsFormat = GraphicsFormat.R16_UNorm;
            }
            else if (SystemInfo.IsFormatSupported(GraphicsFormat.R8_UNorm, GraphicsFormatUsage.Render))
            {
                renderTextureDescriptor.graphicsFormat = GraphicsFormat.R8_UNorm;
            }
            else if (SystemInfo.IsFormatSupported(GraphicsFormat.R8G8B8A8_UNorm, GraphicsFormatUsage.Render))
            {
                renderTextureDescriptor.graphicsFormat = GraphicsFormat.R8G8B8A8_UNorm;
            }
        }

#if !UNITY_6000_4_OR_NEWER
        // Here you can implement the rendering logic.
        // Use <c>ScriptableRenderContext</c> to issue drawing commands or execute command buffers
        // https://docs.unity3d.com/ScriptReference/Rendering.ScriptableRenderContext.html
        // You don't have to call ScriptableRenderContext.submit, the render pipeline will call it at specific points in the pipeline.
#if UNITY_6000_0_OR_NEWER
        [Obsolete]
#endif
        public override void Execute(ScriptableRenderContext context, ref RenderingData renderingData)
        {
            if (!shouldRenderRT(renderingData.cameraData.camera)) return;

            renderPerCharacterAverageShadowAtlaRT(context, renderingData);
        }
#endif
        // Cleanup any allocated resources that were created during the execution of this render pass.
        public override void OnCameraCleanup(CommandBuffer cmd)
        {
#if !UNITY_2022_2_OR_NEWER
            cmd.ReleaseTemporaryRT(shadowTestResultRTH.id);
#endif
        }

#if UNITY_2022_2_OR_NEWER
        public void Dispose()
        {
            shadowTestResultRTH?.Release();
        }
#endif
        bool shouldRenderRT(Camera camera)
        {
            // TODO:
            // WebGL is not safe to run big foploop in shader
            // remove this when the problem is solved
#if UNITY_WEBGL
            return false;
#else
            if (camera.cameraType == CameraType.Preview)
                return false;

            var shadowControlVolumeEffect = VolumeManager.instance.stack.GetComponent<NiloToonShadowControlVolume>();

            // in NiloToon 0.11.1, we changed the merge method from simple override to a "&&" merge, so renderer feature can force disable all average shadow even if volume has overridden and enabled it.
            bool enableAverageShadow = shadowControlVolumeEffect.enableCharAverageShadow.value && settings.enableAverageShadow;
            return enableAverageShadow;
#endif
        }
        private void renderPerCharacterAverageShadowAtlaRT(ScriptableRenderContext context, RenderingData renderingData)
        {
            if (!InitMaterialIfNeeded()) return;
            
            // NOTE: Do NOT mix ProfilingScope with named CommandBuffers i.e. CommandBufferPool.Get("name").
            // Currently there's an issue which results in mismatched markers.
            CommandBuffer cmd = CommandBufferPool.Get();
            using (new ProfilingScope(cmd, base.profilingSampler))
            {
                /*
                Note : should always ExecuteCommandBuffer at least once before using
                ScriptableRenderContext functions (e.g. DrawRenderers) even if you
                don't queue any commands! This makes sure the frame debugger displays
                everything under the correct title.
                */
                // https://www.cyanilux.com/tutorials/custom-renderer-features/?fbclid=IwAR27j2f3VVo0IIYDa32Dh76G9KPYzwb8j1J5LllpSnLXJiGf_UHrQ_lDtKg
                context.ExecuteCommandBuffer(cmd);
                cmd.Clear();
                
                UpdateShaderDataArray(renderingData.cameraData.camera);

                CMDSetGlobalParam(cmd);

#if UNITY_2022_2_OR_NEWER
                Blitter.BlitTexture(cmd, shadowTestResultRTH, shadowTestResultRTH, RenderBufferLoadAction.DontCare, RenderBufferStoreAction.Store, material, 0);
#else
                cmd.Blit(null, shadowTestResultRTH.Identifier(), material);
#endif
            }
            
            // must write these line after using{} finished, to ensure profiler and frame debugger display correctness
            context.ExecuteCommandBuffer(cmd);
            cmd.Clear();
            CommandBufferPool.Release(cmd);
        }

        private void CMDSetGlobalParam(CommandBuffer cmd)
        {
            var shadowControlVolumeEffect = VolumeManager.instance.stack.GetComponent<NiloToonShadowControlVolume>();

            cmd.SetGlobalFloatArray("_GlobalAverageShadowTestBoundingSphereDataArray", shaderDataArray); // once set, we can't change the size of array in GPU anymore, it is not Unity's fault but graphics API's design.
            cmd.SetGlobalFloat("_GlobalAverageShadowStrength", shadowControlVolumeEffect.charAverageShadowStrength.value);
        }

        private bool InitMaterialIfNeeded()
        {
            // delay CreateEngineMaterial to as late as possible, to make it safe when ReimportAll is running
            if (!material)
                material = CoreUtils.CreateEngineMaterial("Hidden/NiloToon/AverageShadowTestRT");

            // sometimes the shader is not yet compile when first time opening the project or opening the project after deleting Library folder,
            // if material is not ready, cmd.DrawMesh will produce "Invalid pass" error log, so we need to skip it.
            if (!material)
                return false;
            
            return true;
        }

        private void UpdateShaderDataArray(Camera camera)
        {
            // TODO: shadow will be wrong if number of active character in scene is more than MAX_SHADOW_SLOT_COUNT-1

            // reserve the right most slot for camera, other slots for each active character
            for (int i = 0; i < Mathf.Min(MAX_SHADOW_SLOT_COUNT - 1, NiloToonAllInOneRendererFeature.characterList.Count); i++)
            {
                NiloToonPerCharacterRenderController controller = NiloToonAllInOneRendererFeature.characterList[i];

                if (controller)
                {
                    Vector3 centerPosWS = controller.GetCharacterBoundCenter();
                    float radiusWS = controller.GetCharacterBoundRadius();

                    shaderDataArray[i * 4 + 0] = centerPosWS.x;
                    shaderDataArray[i * 4 + 1] = centerPosWS.y;
                    shaderDataArray[i * 4 + 2] = centerPosWS.z;
                    shaderDataArray[i * 4 + 3] = radiusWS;
                }
                else
                {
                    shaderDataArray[i * 4 + 3] = 0;
                }
            }

            // RT's right most slot(pixel) for camera only
            Camera cam = camera;
            Vector3 cameraPosForTesting = cam.transform.position + cam.transform.forward * (cam.nearClipPlane + 1f); // add 1 unit offset to not use cam pos as testing center directly, to avoid wrong cascade shadowmap index(avoid testing outside of camera frustrum)
            shaderDataArray[(MAX_SHADOW_SLOT_COUNT - 1) * 4 + 0] = cameraPosForTesting.x;
            shaderDataArray[(MAX_SHADOW_SLOT_COUNT - 1) * 4 + 1] = cameraPosForTesting.y;
            shaderDataArray[(MAX_SHADOW_SLOT_COUNT - 1) * 4 + 2] = cameraPosForTesting.z;
            shaderDataArray[(MAX_SHADOW_SLOT_COUNT - 1) * 4 + 3] = 0.5f; // width is 0.5 unit, to avoid testing outside of camera frustum
        }
        
        ///////////////////////////////////////////////////////////////////////////
        ///  RG support
        ///////////////////////////////////////////////////////////////////////////
#if UNITY_6000_0_OR_NEWER
        public class PassData
        {
            public TextureHandle destTex;
        }
        public override void RecordRenderGraph(RenderGraph renderGraph, ContextContainer frameData)
        {
            // copy and edit of https://docs.unity3d.com/6000.0/Documentation/Manual/urp/render-graph-write-render-pass.html
            string passName = "NiloToonAverageShadowTestRTPass(RG)";

            // Add a raster render pass to the render graph. The PassData type parameter determines
            // the type of the passData output variable.
            using (var builder = renderGraph.AddRasterRenderPass<PassData>(passName,
                       out var passData))
            {
                // UniversalResourceData contains all the texture references used by URP,
                // including the active color and depth textures of the camera.
                var resourceData = frameData.Get<UniversalResourceData>();
                var cameraData = frameData.Get<UniversalCameraData>();
                
                if(!InitMaterialIfNeeded()) return;
                
                UpdateShaderDataArray(cameraData.camera);
                
                GetRTDescriptor(out var renderTextureDescriptor);
                
                // UniversalRenderer.CreateRenderGraphTexture is a helper method
                // that calls the RenderGraph.CreateTexture method.
                // Using a RenderTextureDescriptor instance instead of a TextureDesc instance
                // simplifies your code.
                TextureHandle destination =
                    UniversalRenderer.CreateRenderGraphTexture(renderGraph, renderTextureDescriptor,
                        "_NiloToonAverageShadowTestRT", true);

                passData.destTex = destination;
                
                // Declare that this render pass uses the temporary destination texture
                // as its color render target.
                // This is similar to cmd.SetRenderTarget prior to the RenderGraph API.
                builder.SetRenderAttachment(destination, 0);
                
                // RenderGraph automatically determines that it can remove this render pass
                // because its results, which are stored in the temporary destination texture,
                // are not used by other passes.
                // For demonstrative purposes, this sample turns off this behavior to make sure
                // that render graph executes the render pass. 
                builder.AllowPassCulling(false);
                
                builder.AllowGlobalStateModification(true);

                // Set the ExecutePass method as the rendering function that render graph calls
                // for the render pass. 
                // This sample uses a lambda expression to avoid memory allocations.
                builder.SetRenderFunc((PassData data, RasterGraphContext context) =>
                {
                    context.cmd.ClearRenderTarget(true,true,Color.white);

                    if (shouldRenderRT(cameraData.camera))
                    {
                        //CMDSetGlobalParam(context.cmd);
                        var shadowControlVolumeEffect = VolumeManager.instance.stack.GetComponent<NiloToonShadowControlVolume>();
                        var cmd = context.cmd;
                        cmd.SetGlobalFloatArray("_GlobalAverageShadowTestBoundingSphereDataArray", shaderDataArray); // once set, we can't change the size of array in GPU anymore, it is not Unity's fault but graphics API's design.
                        cmd.SetGlobalFloat("_GlobalAverageShadowStrength", shadowControlVolumeEffect.charAverageShadowStrength.value);
                    
                        // special temp fix for RG
                        // * Blitter.BlitTexture(context.cmd, data.copySourceTexture,new Vector4(1, 1, 0, 0), 0, false);
                        // * may solve this problem
                        cmd.SetGlobalVector("_BlitScaleBias", new Vector4(1, 1, 0, 0));
                        material.SetVector("_BlitScaleBias", new Vector4(1, 1, 0, 0));
                    
                        // Records a rendering command to copy, or blit, the contents of the source texture
                        // to the color render target of the render pass.
                        // The RecordRenderGraph method sets the destination texture as the render target
                        // with the UseTextureFragment method.
                        CoreUtils.DrawFullScreen(cmd, material);
                    }
                });
                
                builder.SetGlobalTextureAfterPass(destination,  Shader.PropertyToID("_NiloToonAverageShadowMapRT"));
            }
        }
#endif
    }
}