Unity CommandBuffer 测试自定义替换渲染

这里做记录用。。。

为了制作其他的一些效果,不得不拿 CommandBuffer 实验一些功能。

这里的替换渲染类似:Camera.RenderWithShader/SetReplacementShaderUnity - RenderWithShader, SetReplacementShader, ResetReplacementShader 测试

先准备好脚本

Code

CSharp

using System;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Rendering;
using static CmdBuff_ReplacementRender;
// jave.lin 2020.04.13 - CommandBuffer Replace Render
public class CmdReplaceScript : MonoBehaviour
{
    public bool enabledReplace = true;
    public Camera cam;
    public Shader replaceShader;
    private RenderTexture rt;

    [SerializeField] private CmdBuff_ReplacementRender replacementCmdBuff;

    private void Start()
    {
        replacementCmdBuff = new CmdBuff_ReplacementRender(cam, replaceShader);
    }
    private void OnPreRender()
    {
        if (rt == null || rt.width != Screen.width || rt.height != Screen.height)
        {
            if (rt) RenderTexture.ReleaseTemporary(rt);
            rt = RenderTexture.GetTemporary(Screen.width, Screen.height);
            rt.name = "replaceShaderRT";
        }
        if (enabledReplace) replacementCmdBuff.Update(null, CameraEvent.AfterImageEffects);
        else replacementCmdBuff.Clear();
    }

    private void OnDestroy()
    {
        if (rt) RenderTexture.ReleaseTemporary(rt);
        if (replacementCmdBuff != null)
        {
            replacementCmdBuff.Destroy();
            replacementCmdBuff = null;
        }
    }
}
// jave.lin 2020.04.13 - CmdBuff_ReplacementRender
[Serializable]
public class CmdBuff_ReplacementRender
{
    public enum ReplaceType // 替换类型
    {
        CheckType, CheckTypeAndValue, IngoreType_ForAll
    }

    public enum ReplaceTag // 要替换的tag
    {
        CustomType, All
    }

    private static void GetRenders(CmdBuff_ReplacementRender replacement, List<Renderer> replaceList, List<Renderer> sourceList)
    {
        var checkTag = replacement.replaceTag.ToString();
        var checkValue = replacement.replaceType == ReplaceType.CheckTypeAndValue ? replacement.replaceMat.GetTag(checkTag, false) : string.Empty;

        var renderArr = GameObject.FindObjectsOfType<Renderer>();

        if (replacement.replaceType == ReplaceType.IngoreType_ForAll)
        {
            replaceList.AddRange(renderArr);
        }
        else if (replacement.replaceType == ReplaceType.CheckType)
        {
            foreach (var item in renderArr)
            {
                if (!string.IsNullOrEmpty(item.sharedMaterial.GetTag(checkTag, false)))
                {
                    replaceList.Add(item);
                }
                else
                {
                    sourceList.Add(item);
                }
            }
        }
        else if (replacement.replaceType == ReplaceType.CheckTypeAndValue)
        {
            foreach (var item in renderArr)
            {
                if (item.sharedMaterial.GetTag(checkTag, false) == checkValue)
                {
                    replaceList.Add(item);
                }
                else
                {
                    sourceList.Add(item);
                }
            }
        }
    }

    public ReplaceType replaceType;
    public ReplaceTag replaceTag;
    public bool DrawSrcRender = true;

    private Camera cam;
    private CommandBuffer cmdBuff;
    private Shader replaceShader;
    [SerializeField] private Material replaceMat;

    private CameraEvent lastCamEvent;

    [SerializeField] private List<Renderer> replaceList = new List<Renderer>();
    [SerializeField] private List<Renderer> sourceList = new List<Renderer>();

    public CmdBuff_ReplacementRender(Camera cam, Shader replaceShader = null)
    {
        this.cam = cam;
        this.replaceShader = replaceShader;
        this.replaceMat = new Material(this.replaceShader);
    }

    public void Clear()
    {
        if (cmdBuff != null) cmdBuff.Clear();
    }

    public void Update(RenderTexture rt, CameraEvent camEvent)
    {
        if (this.lastCamEvent != camEvent)
        {
            if (cmdBuff != null)
            {
                cam.RemoveCommandBuffer(this.lastCamEvent, cmdBuff);
                cmdBuff.name = $"{camEvent} - Draw Replace";
                cam.AddCommandBuffer(camEvent, cmdBuff);
            }
            this.lastCamEvent = camEvent;
        }
        if (cmdBuff == null)
        {
            cmdBuff = new CommandBuffer();
            cmdBuff.name = $"{this.lastCamEvent} - Draw Replace";
            cam.AddCommandBuffer(this.lastCamEvent, cmdBuff);
        }
        cmdBuff.Clear();
        if (rt) cmdBuff.SetRenderTarget(rt);
        else cmdBuff.SetRenderTarget(cam.targetTexture);
        cmdBuff.ClearRenderTarget(true, true, Color.white);

        replaceList.Clear();
        sourceList.Clear();
        // 如果GetRenders处理了:
        // - Camera.cullMask 的筛选
        // - Renderer.sortingLayerID 的排序
        // - Material.queueID 的排序
        // - 等等其他相关的排序,那么就和Camera.RenderWithShader或是SetReplacementShader差不多了
        GetRenders(this, replaceList, sourceList);
        if (DrawSrcRender)
        {
            foreach (var r in sourceList)
            {
                cmdBuff.DrawRenderer(r, r.sharedMaterial);
            }
        }
        foreach (var r in replaceList)
        {
            cmdBuff.DrawRenderer(r, replaceMat);
        }
    }
    public void Destroy()
    {
        if (cmdBuff != null && cam != null)
        {
            cam.RemoveCommandBuffer(this.lastCamEvent, cmdBuff);
            cmdBuff = null;
            cam = null;
        }
        if (replaceList != null)
        {
            replaceList.Clear();
            replaceList = null;
        }
    }
}

Shader

Common.cginc

// jave.lin 2020.04.13
#include "UnityCG.cginc"
#include"Lighting.cginc"
struct appdata {
    float4 vertex : POSITION;
    float3 normal : NORMAL;
};
struct v2f {
    float4 vertex : SV_POSITION;
    float3 worldNormal : TEXCOORD0;
    float3 worldPos : TEXCOORD1;
};
fixed4 _MainColor;
fixed4 _XRayColor;
fixed4 _XRayRimColor;
v2f vert (appdata v) {
    v2f o;
    o.vertex = UnityObjectToClipPos(v.vertex);
    o.worldNormal = UnityObjectToWorldNormal(v.normal);
    o.worldPos = mul(unity_ObjectToWorld, v.vertex);
    return o;
}
fixed4 frag_common(v2f i, fixed4 tintColor) {
    i.worldNormal = normalize(i.worldNormal);
    //viewDir后面高光用
    half3 viewDir = normalize(_WorldSpaceCameraPos.xyz - i.worldPos);
    half3 lightDir = normalize(_WorldSpaceLightPos0.xyz);
    // ambient
    fixed3 ambient = UNITY_LIGHTMODEL_AMBIENT.rgb;
    // diffuse
    fixed LdotN = dot(lightDir, i.worldNormal);
    fixed diffuse = max(0, LdotN);
    // specular
    fixed specular = 0;
    if (LdotN > 0) {
        half3 hDir = normalize(viewDir + lightDir);
        fixed HdotN = max(0, dot(hDir, i.worldNormal));
        specular = pow(HdotN, 64);
    }
    fixed4 combinedCol = 0;
    combinedCol.xyz = ambient + 
            diffuse * _LightColor0.rgb * tintColor.rgb +
            specular * _LightColor0.rgb;
    combinedCol.a = tintColor.a;
    return combinedCol;
}
fixed4 frag (v2f i) : SV_Target {
    return frag_common(i, _MainColor);
}
fixed4 frag_replace (v2f i) : SV_Target {
    return frag_common(i, _XRayColor);
}
fixed4 frag_xray (v2f i) : SV_Target {

    fixed4 result = frag_common(i, _XRayColor);
    // rim
    half3 viewDir = normalize(_WorldSpaceCameraPos.xyz - i.worldPos);
    float VdotN = 1 - max(0, dot(i.worldNormal, viewDir));
    result.xyz = lerp(result.xyz, _XRayRimColor.rgb, VdotN);

    return result;
}
fixed4 frag_replace1(v2f i ) : SV_Target {
    return frag_common(i, lerp(_MainColor, _XRayColor, abs(sin(_Time.w))));
}

A.shader

// jave.lin 2020.04.13
Shader "Custom/A" {
    Properties {
        _MainColor ("Color", Color) = (1,0,0,1)
    }
    SubShader {
        Tags { "CustomType"="A" "All"="1" }
        Pass {
            CGPROGRAM
            #include "Common.cginc"
            #pragma vertex vert
            #pragma fragment frag
            ENDCG
        }
    }
}

B.shader

// jave.lin 2020.04.13
Shader "Custom/B" {
    Properties {
        _MainColor ("Color", Color) = (0,1,0,1)
    }
    SubShader {
        Tags { "CustomType"="B" "All"="1" }
        Pass {
            CGPROGRAM
            #include "Common.cginc"
            #pragma vertex vert
            #pragma fragment frag
            ENDCG
        }
    }
}

C.shader

// jave.lin 2020.04.13
Shader "Custom/C" {
    Properties {
        _MainColor ("Color", Color) = (0,0,1,1)
    }
    SubShader {
        Pass {
            CGPROGRAM
            #include "Common.cginc"
            #pragma vertex vert
            #pragma fragment frag
            ENDCG
        }
    }
}

ReplaceShader.shader

// jave.lin 2020.04.13
Shader "Custom/ReplaceShader" {
    Properties {
        _MainColor ("Color", Color) = (1,1,0,1)
        _XRayColor ("XRayColor", Color) = (0, 1, 1, 0.5)
        _XRayRimColor ("XRayRimColor", Color) = (1, 0, 0, 1)
    }

    SubShader {
        Tags { "CustomType"="B" "All"="1" }
        Blend SrcAlpha OneMinusSrcAlpha
        Pass { // front
            ZWrite Off
            ZTest Greater
            CGPROGRAM
            #include "Common.cginc"
            #pragma vertex vert
            #pragma fragment frag_xray
            ENDCG
        }
        Pass { // front
            ZWrite Off
            CGPROGRAM
            #include "Common.cginc"
            #pragma vertex vert
            #pragma fragment frag_replace
            ENDCG
        }
    }
}

ReplaceShader2.shader

// jave.lin 2020.04.13
Shader "Custom/ReplaceShader2" {
    Properties {
        _MainColor ("Color", Color) = (1,1,0,1)
        _XRayColor ("XRayColor", Color) = (0, 1, 1, 0.5)
        _XRayRimColor ("XRayRimColor", Color) = (1, 0, 0, 1)
    }

    SubShader {
        Tags { "CustomType"="B" "All"="1" }
        Blend SrcAlpha OneMinusSrcAlpha
        Pass { // front
            ZWrite Off
            ZTest Greater
            CGPROGRAM
            #include "Common.cginc"
            #pragma vertex vert
            #pragma fragment frag_xray
            ENDCG
        }
        Pass { // front
            ZWrite Off
            CGPROGRAM
            #include "Common.cginc"
            #pragma vertex vert
            #pragma fragment frag_replace1
            ENDCG
        }
    }
}

运行效果

在这里插入图片描述
其中

public enum ReplaceType // 替换类型
{
    CheckType, CheckTypeAndValue, IngoreType_ForAll
}

有三种类型

  • CheckType 只要有对应的 tag在,不论之是什么,都可以替换
  • CheckTypeAndValue 要有对应tag同时,要需要值与替换shader的是一致才替换
  • IngoreType_ForAll 不换检测类似,对所有对象都替换

相比之下,Unity内置的Camera.RenderWithShader接口只能处理 tagvalue 都相同才能替换。

总结

如果GetRenders处理了:

  • Camera.cullMask 的筛选
  • Renderer.sortingLayerID 的排序
  • Material.queueID 的排序
  • 等等其他相关的排序

那么就和Camera.RenderWithShader或是SetReplacementShader差不多了

限制:
想让Renderer指定在其他的Camera下渲染都不行
如:CommandBuffer.DrawRenderer(Renderer, Material);中的Renderer是相对该CommadnBuffer绑定的Camera的变换关系的。

我还想用一个不启用(Active == false)的Camera来作为CommandBuffer的渲染事件来绑定又不可以,因为没有启用(Active == false)的Camera 是不会调用 CameraEvent的。

反正CommandBuffer使用起来还是会有很多限制。

所以,Unity下替换渲染妥妥的还是用回Camera来处理吧。

Project

backup : Unity_CmdBuffReplacementRender_2018.3.0f2

有个更完善的 CmdBuff_ReplacementRender 累,在之前一篇文章:Unity Shader - Custom DirectionalLight ShadowMap 自定义方向光的ShadowMap

### UnityCommandBuffer 的使用教程 #### 创建和初始化 CommandBuffer `CommandBuffer` 是用于扩展渲染管线的强大工具,可以携带一系列的渲染命令并依赖于特定的摄像机来执行这些命令。创建 `CommandBuffer` 对象时可以通过设置其名称来进行调试[^1]。 ```csharp // 创建一个新的 CommandBuffer 并命名它以便识别 CommandBuffer commandBuffer = new CommandBuffer { name = "MyCustomCommands" }; ``` #### 添加渲染指令到 CommandBuffer 通过调用不同的方法向 `CommandBuffer` 添加具体的渲染操作,比如清除目标、绘制网格等。这里展示如何清空颜色缓冲区而不影响深度缓冲区: ```csharp commandBuffer.ClearRenderTarget(true, false, Color.clear); ``` 此代码片段会告诉 GPU 清除当前帧的颜色数据而保留场景中的物体距离信息(即不改变深度测试的结果),这有助于提高性能特别是在某些特殊效果下不需要重新计算整个场景的情况下[^2]。 #### 将 CommandBuffer 注册给 Camera 或 Light 组件 为了让自定义渲染逻辑生效,需要把准备好的 `CommandBuffer` 关联至某个摄像机或光源上,在适当的时间点触发它们所包含的操作序列。 对于摄像机来说,通常是在 `OnPreCull`, `OnWillRenderObject`, 和 `OnPostRender` 这三个事件期间注册/移除相应的回调函数;而对于灯光,则可以在光照预处理阶段介入。 ```csharp Camera mainCamera; mainCamera.AddCommandBuffer(CameraEvent.BeforeForwardAlpha, commandBuffer); // 当不再需要该 CommandBuffer 时记得释放资源 void OnDestroy() { mainCamera.RemoveCommandBuffer(CameraEvent.BeforeForwardAlpha, commandBuffer); } ``` #### 执行与清理 CommandBuffer 当所有的渲染命令都被加入到了 `CommandBuffer` 后就可以让 ScriptableRenderContext 来执行其中的内容了。为了防止潜在的内存泄漏问题,应当及时清理已经完成工作的 `CommandBuffer` 实例。 ```csharp context.ExecuteCommandBuffer(commandBuffer); commandBuffer.Clear(); ``` 上述做法不仅能够有效减少不必要的开销还能保持良好的编程习惯。 #### 常见问题及其解决方案 - **内存泄露**: 如果频繁地实例化新的 `CommandBuffer` 而未妥善管理生命周期的话很容易造成内存溢出。建议尽可能重用已有的对象而不是每次都新建一个。 - **同步问题**: 在多线程环境下如果多个地方同时修改同一个 `CommandBuffer` 则可能导致竞态条件的发生。应确保访问的安全性和一致性。 - **异常处理不足**: 面对可能出现的各种意外情况如网络中断或其他外部因素干扰时未能做好充分预案会影响程序健壮性。因此有必要引入合理的错误恢复机制以维持系统稳定运行[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值