【Unity ShaderLab】URPのデフォルトシェーダーUnlitをBRP用に作り替えた

## はじめに
Unityは様々な描画環境を提供しています。その中で最も利用されていたのがUnity BRP（Built-In Render Pipeline）、通称Unity 3Dです。現在、UnityではURP（Universal Render Pipeline）やHDRP（High Definition Render Pipeline）が導入されていますが、以前はほとんどのユーザーがUnity 3Dを使用していました。

多くのプロジェクトがURPやHDRPにアップグレードされていますが、逆に描画環境をダウングレードするケースは少ないため、元々URPで使用していたマテリアルがBRPで使えなくなる場合もあります。そのような場合に、URPと似たシェーダー表現をBRPで実現する方法を紹介します。

## 前提条件
- Unity ShaderLabの構文を理解していること
- HLSLの基礎知識があること

## 対象者
- Unity BRP（Built-In Render Pipeline）内で、URP（Universal Render Pipeline）のデフォルトシェーダーを使用したい方
- ShaderLabを使用して、カスタムシェーダーを作成したい方

## 使用環境

- Unity 2022.3.17f1
- Built-In Render Pipeline（BRP）またはUnity 3Dテンプレート

## URPとBRPのUnlitシェーダーの違い
- URPのUnlitシェーダー（GUI上の見た目）

![スクリーンショット 2024-07-07 181026.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3770983/1b27f1af-25c7-689e-4f62-013cbc2f6e2d.png)

- 今回作るBRP用URP Unlitシェーダー（GUI上の見た目）

![スクリーンショット 2024-07-07 180928.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3770983/6e839800-b408-1761-6e59-dfd6f0ab64dc.png)


- URPのUnlitシェーダー（Shaderファイルの記述）

```
Shader "Universal Render Pipeline/Unlit"
{
    Properties
    {
        [MainTexture] _BaseMap("Texture", 2D) = "white" {}
        [MainColor] _BaseColor("Color", Color) = (1, 1, 1, 1)
        _Cutoff("AlphaCutout", Range(0.0, 1.0)) = 0.5

        // BlendMode
        _Surface("__surface", Float) = 0.0
        _Blend("__mode", Float) = 0.0
        _Cull("__cull", Float) = 2.0
        [ToggleUI] _AlphaClip("__clip", Float) = 0.0
        [HideInInspector] _BlendOp("__blendop", Float) = 0.0
        [HideInInspector] _SrcBlend("__src", Float) = 1.0
        [HideInInspector] _DstBlend("__dst", Float) = 0.0
        [HideInInspector] _SrcBlendAlpha("__srcA", Float) = 1.0
        [HideInInspector] _DstBlendAlpha("__dstA", Float) = 0.0
        [HideInInspector] _ZWrite("__zw", Float) = 1.0
        [HideInInspector] _AlphaToMask("__alphaToMask", Float) = 0.0

        // Editmode props
        _QueueOffset("Queue offset", Float) = 0.0

        // ObsoleteProperties
        [HideInInspector] _MainTex("BaseMap", 2D) = "white" {}
        [HideInInspector] _Color("Base Color", Color) = (0.5, 0.5, 0.5, 1)
        [HideInInspector] _SampleGI("SampleGI", float) = 0.0 // needed from bakedlit
    }

    SubShader
    {
        Tags
        {
            "RenderType" = "Opaque"
            "IgnoreProjector" = "True"
            "UniversalMaterialType" = "Unlit"
            "RenderPipeline" = "UniversalPipeline"
        }
        LOD 100

        // -------------------------------------
        // Render State Commands
        Blend [_SrcBlend][_DstBlend], [_SrcBlendAlpha][_DstBlendAlpha]
        ZWrite [_ZWrite]
        Cull [_Cull]

        Pass
        {
            Name "Unlit"

            // -------------------------------------
            // Render State Commands
            AlphaToMask[_AlphaToMask]

            HLSLPROGRAM
            #pragma target 2.0

            // -------------------------------------
            // Shader Stages
            #pragma vertex UnlitPassVertex
            #pragma fragment UnlitPassFragment

            // -------------------------------------
            // Material Keywords
            #pragma shader_feature_local_fragment _SURFACE_TYPE_TRANSPARENT
            #pragma shader_feature_local_fragment _ALPHATEST_ON
            #pragma shader_feature_local_fragment _ALPHAMODULATE_ON

            // -------------------------------------
            // Unity defined keywords
            #pragma multi_compile_fog
            #pragma multi_compile_fragment _ _SCREEN_SPACE_OCCLUSION
            #pragma multi_compile_fragment _ _DBUFFER_MRT1 _DBUFFER_MRT2 _DBUFFER_MRT3
            #pragma multi_compile _ DEBUG_DISPLAY
            #pragma multi_compile_fragment _ LOD_FADE_CROSSFADE
            #include_with_pragmas "Packages/com.unity.render-pipelines.universal/ShaderLibrary/RenderingLayers.hlsl"

            //--------------------------------------
            // GPU Instancing
            #pragma multi_compile_instancing
            #include_with_pragmas "Packages/com.unity.render-pipelines.universal/ShaderLibrary/DOTS.hlsl"

            // -------------------------------------
            // Includes
            #include "Packages/com.unity.render-pipelines.universal/Shaders/UnlitInput.hlsl"
            #include "Packages/com.unity.render-pipelines.universal/Shaders/UnlitForwardPass.hlsl"
            ENDHLSL
        }

        // Fill GBuffer data to prevent "holes", just in case someone wants to reuse GBuffer for non-lighting effects.
        // Deferred lighting is stenciled out.
        Pass
        {
            Name "GBuffer"
            Tags
            {
                "LightMode" = "UniversalGBuffer"
            }

            HLSLPROGRAM
            #pragma target 4.5

            // Deferred Rendering Path does not support the OpenGL-based graphics API:
            // Desktop OpenGL, OpenGL ES 3.0, WebGL 2.0.
            #pragma exclude_renderers gles3 glcore

            // -------------------------------------
            // Shader Stages
            #pragma vertex UnlitPassVertex
            #pragma fragment UnlitPassFragment

            // -------------------------------------
            // Material Keywords
            #pragma shader_feature_local_fragment _ALPHATEST_ON
            #pragma shader_feature_local_fragment _ALPHAMODULATE_ON

            // -------------------------------------
            // Unity defined keywords
            #pragma multi_compile_fragment _ _SCREEN_SPACE_OCCLUSION
            #pragma multi_compile_fragment _ _DBUFFER_MRT1 _DBUFFER_MRT2 _DBUFFER_MRT3
            #pragma multi_compile_fragment _ LOD_FADE_CROSSFADE
            #pragma multi_compile_fragment _ _GBUFFER_NORMALS_OCT
            #include_with_pragmas "Packages/com.unity.render-pipelines.universal/ShaderLibrary/RenderingLayers.hlsl"

            //--------------------------------------
            // GPU Instancing
            #pragma multi_compile_instancing
            #include_with_pragmas "Packages/com.unity.render-pipelines.universal/ShaderLibrary/DOTS.hlsl"

            // -------------------------------------
            // Includes
            #include "Packages/com.unity.render-pipelines.universal/Shaders/UnlitInput.hlsl"
            #include "Packages/com.unity.render-pipelines.universal/Shaders/UnlitGBufferPass.hlsl"
            ENDHLSL
        }

        Pass
        {
            Name "DepthOnly"
            Tags
            {
                "LightMode" = "DepthOnly"
            }

            // -------------------------------------
            // Render State Commands
            ZWrite On
            ColorMask R

            HLSLPROGRAM
            #pragma target 2.0

            // -------------------------------------
            // Shader Stages
            #pragma vertex DepthOnlyVertex
            #pragma fragment DepthOnlyFragment

            // -------------------------------------
            // Material Keywords
            #pragma shader_feature_local _ALPHATEST_ON

            // -------------------------------------
            // Unity defined keywords
            #pragma multi_compile_fragment _ LOD_FADE_CROSSFADE

            //--------------------------------------
            // GPU Instancing
            #pragma multi_compile_instancing
            #include_with_pragmas "Packages/com.unity.render-pipelines.universal/ShaderLibrary/DOTS.hlsl"

            // -------------------------------------
            // Includes
            #include "Packages/com.unity.render-pipelines.universal/Shaders/UnlitInput.hlsl"
            #include "Packages/com.unity.render-pipelines.universal/Shaders/DepthOnlyPass.hlsl"
            ENDHLSL
        }

        Pass
        {
            Name "DepthNormalsOnly"
            Tags
            {
                "LightMode" = "DepthNormalsOnly"
            }

            // -------------------------------------
            // Render State Commands
            ZWrite On

            HLSLPROGRAM
            #pragma target 2.0

            // -------------------------------------
            // Shader Stages
            #pragma vertex DepthNormalsVertex
            #pragma fragment DepthNormalsFragment

            // -------------------------------------
            // Material Keywords
            #pragma shader_feature_local _ALPHATEST_ON

            // -------------------------------------
            // Universal Pipeline keywords
            #pragma multi_compile_fragment _ _GBUFFER_NORMALS_OCT // forward-only variant
            #pragma multi_compile_fragment _ LOD_FADE_CROSSFADE
            #include_with_pragmas "Packages/com.unity.render-pipelines.universal/ShaderLibrary/RenderingLayers.hlsl"

            //--------------------------------------
            // GPU Instancing
            #pragma multi_compile_instancing
            #include_with_pragmas "Packages/com.unity.render-pipelines.universal/ShaderLibrary/DOTS.hlsl"

            // -------------------------------------
            // Includes
            #include "Packages/com.unity.render-pipelines.universal/Shaders/UnlitInput.hlsl"
            #include "Packages/com.unity.render-pipelines.universal/Shaders/UnlitDepthNormalsPass.hlsl"
            ENDHLSL
        }

        // This pass it not used during regular rendering, only for lightmap baking.
        Pass
        {
            Name "Meta"
            Tags
            {
                "LightMode" = "Meta"
            }

            // -------------------------------------
            // Render State Commands
            Cull Off

            HLSLPROGRAM
            #pragma target 2.0

            // -------------------------------------
            // Shader Stages
            #pragma vertex UniversalVertexMeta
            #pragma fragment UniversalFragmentMetaUnlit

            // -------------------------------------
            // Unity defined keywords
            #pragma shader_feature EDITOR_VISUALIZATION

            // -------------------------------------
            // Includes
            #include "Packages/com.unity.render-pipelines.universal/Shaders/UnlitInput.hlsl"
            #include "Packages/com.unity.render-pipelines.universal/Shaders/UnlitMetaPass.hlsl"
            ENDHLSL
        }
    }

    FallBack "Hidden/Universal Render Pipeline/FallbackError"
    CustomEditor "UnityEditor.Rendering.Universal.ShaderGUI.UnlitShader"
}

```



- 今回作るBRP用URP Unlitシェーダー（Shaderファイルの記述）
```
Shader "Custom/BRP_Unlit"
{
    Properties
    {
        _BaseColor ("Base Color", Color) = (1, 1, 1, 1)
        _BaseMap ("Base Map", 2D) = "white" {}
        _CullMode ("Render Face", Float) = 2
        _Surface ("Surface Type", Float) = 0
        _AlphaClip ("Alpha Clipping", Float) = 0
        _Cutoff ("Alpha Cutoff", Range(0,1)) = 0.5
    }

    SubShader
    {
        Tags { "RenderType"="Opaque" }
        
        Cull [_CullMode]
        ZWrite On
        Blend SrcAlpha OneMinusSrcAlpha

        Pass
        {
            CGPROGRAM
            #pragma vertex vert
            #pragma fragment frag
            #include "UnityCG.cginc"

            sampler2D _BaseMap;
            float4 _BaseColor;
            float4 _BaseMap_ST;
            float _CullMode;
            float _AlphaClip;
            float _Cutoff;
            float _Surface;

            struct appdata
            {
                float4 vertex : POSITION;
                float2 uv : TEXCOORD0;
            };

            struct v2f
            {
                float2 uv : TEXCOORD0;
                float4 vertex : SV_POSITION;
            };

            v2f vert (appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                o.uv = TRANSFORM_TEX(v.uv, _BaseMap);
                return o;
            }

            half4 frag (v2f i) : SV_Target
            {
                half4 col = tex2D(_BaseMap, i.uv) * _BaseColor;
                if (_AlphaClip > 0 && col.a < _Cutoff)
                    discard;
                return col;
            }
            ENDCG
        }
    }

    CustomEditor "CustomUnlitShaderGUI"
}
```

URPとBRPのShaderファイルを見比べると今回のBRPのシェーダーの構造は比較的に簡単になります、URPのシェーダーをコピペして改造するより、実はこれだけでURPのUnlitを実現できます。


## Unlitとは
- Unlitシェーダーを作る前にまずUnlitの概念を知らないといけないと思います、
Unlitとは一般的に照明や影の影響を受けず、テクスチャやペースカラーの色をそのまま出すシェーダーを指します。

## 構造解析

- 今回はこのURPのGUIを見て作っていきたいと思います、なぜGUIを参考にするかというと、先ほど上に共有したシェーダーの記述を見ても、全解析までにかかる時間は大変なことになるので、直接GUIの構造を参考にした方がいいと考えています

![スクリーンショット 2024-07-07 181026.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3770983/1b27f1af-25c7-689e-4f62-013cbc2f6e2d.png)

- まずはプロパティを準備する、プログラミング経験のある方は気付くかもしれませんがクラスのメンバー変数と似たような概念

```
Properties
{
    // マテリアルのベースカラーを指定する
    _BaseColor ("Base Color", Color) = (1, 1, 1, 1) 
    
    // マッピングするテクスチャ格納用
    _BaseMap ("Base Map", 2D) = "white" {} 
    
    // カリングする面、0：Both、1：Front、2：Back
    _CullMode ("Render Face", Float) = 2 
    
    // 表面タイプ、0：Opaque（不透明）、1: Transparent（透明）
    _Surface ("Surface Type", Float) = 0 
    
    // 0:Alpha clipping無効化、1:Alpha Clipping有効化
    _AlphaClip ("Alpha Clipping", Float) = 0 
    
    // Alpha Clippingの閾値を設定するためのプロパティ
    _Cutoff ("Alpha Cutoff", Range(0,1)) = 0.5 
}
```

- 次にSubShaderの記述、SubShaderの記述は一部HLSLと共通している

```
SubShader
{
    Tags { "RenderType"="Opaque" } // レンダリングタイプを設定します。

    // カリングモード、深度書き込み、およびブレンドモードを設定します。
    Cull [_CullMode] //プロパティの_CullModeをここに代入すれば、後からGUI上で設定できる
    ZWrite On
    Blend SrcAlpha OneMinusSrcAlpha

    Pass
    {
        CGPROGRAM
        #pragma vertex vert // 頂点シェーダーを指定します。
        #pragma fragment frag // フラグメントシェーダーを指定します。
        #include "UnityCG.cginc" // ShaderLabの共通ユーティリティ関数を使用するためのディレクティブをインクルードします。

        // プロパティをシェーダー内で使用するために宣言します。
        sampler2D _BaseMap;
        float4 _BaseColor;
        float4 _BaseMap_ST;
        float _CullMode;
        float _AlphaClip;
        float _Cutoff;
        float _Surface;

        // アプリケーションデータ構造体を定義します。
        struct appdata
        {
            float4 vertex : POSITION; // 頂点位置
            float2 uv : TEXCOORD0; // UV座標
        };

        // 頂点シェーダーの出力構造体を定義します。
        struct v2f
        {
            float2 uv : TEXCOORD0; // UV座標
            float4 vertex : SV_POSITION; // クリップ空間での頂点位置
        };

        // 頂点シェーダー
        v2f vert (appdata v)
        {
            v2f o;
            o.vertex = UnityObjectToClipPos(v.vertex); // 頂点位置をクリップ空間に変換します。
            o.uv = TRANSFORM_TEX(v.uv, _BaseMap); // UV座標を変換します。
            return o;
        }

        // フラグメントシェーダー
        half4 frag (v2f i) : SV_Target
        {
            // テクスチャカラーとベースカラーを掛け合わせます。
            half4 col = tex2D(_BaseMap, i.uv) * _BaseColor;
            // Alpha Clippingが有効で、ピクセルのAlpha値が閾値以下の場合、そのピクセルを描画しません。
            if (_AlphaClip > 0 && col.a < _Cutoff)
                discard;
            return col;
        }
        ENDCG
    }
}
```

## URPと操作上の差

![スクリーンショット 2024-07-07 180928 - コピー.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3770983/116c57d7-66f2-6e6c-631e-789869ee1987.png)

- Render Faceはプルダウンがなく、数字で設定すること（0：Both、1：Front、2：Back）
- Surface Typeもプルダウンがなく、数字で設定する（0：Opaque（不透明）、1: Transparent（透明））
- Alpha Clippingの有効化も数字で設定すること（0:Alpha clipping無効化、1:Alpha Clipping有効化）
- Alpha Cutoff（Alpha Clippingの閾値）を設定できること


## おわりに
新しい描画環境を使用せず、または元々URPもしくはHDRPを使用したプロジェクトをBRPまでダウングレードするのはかなりレアなケースでしょう、今回作ったものもURPのデフォルトと比べて極めて簡単な構造になっているが、BRPでURPのデフォルトシェーダーを再現できたので、いつか描画環境が制限され、もしくはURPとHDRPのプロジェクトをBRPに移植する時、考え方を変え、このような作り方も可能ってことをお伝えできればと思います。